This API provides endpoints for Alkanes marketplace services, including market statistics, listing search, activity history, and order preparation/submission for Alkanes assets.
👉 View Swagger UI
Method: POST
Path: /v3/market/alkanes/auction/alkanes_types
Swagger Link: View in Swagger UI
Returns paginated market metrics for Alkanes tickers, including current price, price change, BTC and asset volume, market cap, holder count, transaction count, warning flag, and the BTC price used for valuation.
Content-Type: application/json
timeType (object): Optional: day1, day7, day30; enum: day1, day7, day30start (number):limit (number):Default Response
code (number): requiredmsg (string): requireddata (object):
BTCPrice (number): requiredlist (array):
tick (string): requiredcurPrice (number): requiredchangePrice (number): requiredbtcVolume (number): requiredamountVolume (number): requiredcap (string): requiredholders (integer):transactions (integer):warning (boolean):Method: POST
Path: /v3/market/alkanes/auction/alkanes_types_specified
Swagger Link: View in Swagger UI
Returns ticker-level marketplace metrics such as symbol, current price, price change, BTC and asset volume, cap in BTC and USD, deploy time, holder count, inscription number, transaction count, and warning flag.
Content-Type: application/json
timeType (string): enum: day1, day7, day30tick (string):Default Response
code (number): requiredmsg (string): requireddata (object):
tick (string):symbol (string):curPrice (number):changePrice (number):btcVolume (number):amountVolume (number):cap (string):capUSD (string):deployTime (integer):holders (integer):number (integer):transactions (integer):warning (boolean):Method: POST
Path: /v3/market/alkanes/auction/list
Swagger Link: View in Swagger UI
Returns paginated listing records with auction id, inscription id and number, seller address, price, ticker, amount, unit price, market type, and latest listing timestamp context.
Content-Type: application/json (required)
filter (object):
nftType (string): required; enum: alkanesaddress (string):tick (string):minPrice (number):maxPrice (number):nftConfirm (boolean):isEnd (boolean): Whether order endsall (boolean): Ignore start and limit and return all collection datasort (object):
unitPrice (number): enum: 1, -1onSaleTime (number): enum: 1, -1initPrice (number): enum: 1, -1inscriptionNumber (number): enum: 1, -1start (number): required; The data is looked up from startlimit (number): required; Limit the amount of dataDefault Response
code (number): requiredmsg (string): requireddata (object):
list (array):
auctionId (string):inscriptionId (string): requiredinscriptionNumber (number):marketType (string):address (string):price (number):nftType (string):tick (string): Brc20 fieldlimit (number): Brc20 fieldamount (number): Brc20 fieldunitPrice (number): Brc20 fieldtotal (number): requiredtimestamp (number):Method: POST
Path: /v3/market/alkanes/auction/actions
Swagger Link: View in Swagger UI
Returns paginated marketplace activity records, including auction id, inscription id and number, event type, price, from/to addresses, timestamp, confirmation count, newest-event marker, and asset-specific metadata.
Content-Type: application/json (required)
filter (object):
nftType (string): enum: alkanesaddress (string):inscriptionId (string):event (string): Event type: Cancel, Listed, Sold, Updated; enum: Cancel, Claim, Listed, Sold, Updatedtick (string):start (number): requiredlimit (number): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):
list (array):
auctionId (string): requiredinscriptionId (string): requiredinscriptionNumber (number): requiredevent (string): required; enum: Listed, Sold, Cancel, Claim, Updatedprice (number): requiredfrom (string): requiredto (string): requiredtimestamp (number): requirednftConfirmNum (number):nftType (string): enum: brc20, domain, collectionendMsg (string): An error message generated by the ordernewest (boolean): The update order generates multiple eventsname (string): Brc20 filedunitPrice (number): Brc20 filedamount (number): Brc20 fileddomain (string): Domain fileddomainType (string): Domain filed; enum: sats, unisat, btc, xbt, ord, gm, bitmap, x, nulldomainCategorys (array): Domain filedcollectionId (string): Collection filedcollectionItemName (string): Collection filedcontentType (string): Collection filedcontentBody (string): Collection filedattributes (array): Collection filed
trait_type (string):value (string):total (number): requiredMethod: POST
Path: /v3/market/alkanes/auction/create_put_on
Swagger Link: View in Swagger UI
Builds a fixed-price listing draft for an Alkanes UTXO and returns an auction id, PSBT, and wallet sign indexes. Review the asset UTXO, total price, unit price, public key, and receiving address before use.
Content-Type: application/json (required)
nftType (string):txid (string): required; The txid of the alkanes utxo txidindex (string): required; The txid of the alkanes utxo indexinitPrice (string): required; Set the initial total priceunitPrice (string): required; Unit Price (for tick)pubkey (string): required; User public keymarketType (string): required; enum: fixedPrice; example: "fixedPrice"btcAddress (string): (Optional) Only for multi-address wallet, such as Xverse, hiro. Specifies the BTC receive addressDefault Response
code (number): requiredmsg (string): requireddata (object):
auctionId (string): requiredpsbt (string): requiredsignIndexes (array): Specifies the signature location used by the xverse walletMethod: POST
Path: /v3/market/alkanes/auction/confirm_put_on
Swagger Link: View in Swagger UI
Confirms the signed listing PSBT for an auction id and activates the marketplace listing. The response is empty on success, so callers should verify state through listing or activity queries after confirmation.
Content-Type: application/json (required)
auctionId (string): requiredpsbt (string): requiredfromBase64 (boolean): Is Base64 format, the default is hex formatDefault Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v3/market/alkanes/auction/create_bid_prepare
Swagger Link: View in Swagger UI
Calculates purchase preparation data for an auction id and bid price, including service fee, real fee, fee rate, estimated transaction size, inscription satoshi value, network fee rate, available balance, and total balance.
Content-Type: application/json (required)
auctionId (string): requiredbidPrice (number): requiredaddress (string): required; Bidder addresspubkey (string): required; Bidder pubkeyDefault Response
code (number): requiredmsg (string): requireddata (object):
serverFee (number): Expected service fee.serverReal (number): Real service fee.serverFeeRate (number): Real service fee rate.txSize (number): Estimated transaction sizenftValue (number): Satoshis carried by the inscriptionfeeRate (number): Network fee rateavailableBalance (number): Available confirmed balance for the userallBalance (number): Available total balance for the userMethod: POST
Path: /v3/market/alkanes/auction/create_bid
Swagger Link: View in Swagger UI
Builds a purchase order for a listing and returns bid id, bid PSBT, optional auction-mode PSBT fields, platform fee, network fee, fee rate, inscription value, and wallet sign indexes.
Content-Type: application/json (required)
auctionId (string): requiredbidPrice (number): requiredaddress (string): required; Bidder addresspubkey (string): required; Bidder pubkeyfeeRate (number): The user sets the ratenftAddress (string): (Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving addressutxos (array): Custom utxo
txid (string):index (number):Default Response
code (number): requiredmsg (string): requireddata (object):
bidId (string): requiredpsbtBid (string): required; Bid psbtpsbtBid2 (string): Auction mode is used, and the current empty string can be passedpsbtSettle (string): Auction mode is used, and the current empty string can be passedserverFee (number): required; The service fee charged by the platformnetworkFee (number): required; BTC network total feefeeRate (number): required; BTC network fee ratenftValue (number): requiredbidSignIndexes (array): Specifies the bid signature location used by the xverse walletMethod: POST
Path: /v3/market/alkanes/auction/confirm_bid
Swagger Link: View in Swagger UI
Confirms the signed bid PSBT for an auction and bid id, then returns the settlement transaction id when the purchase is accepted.
Content-Type: application/json (required)
auctionId (string): requiredbidId (string): requiredpsbtBid (string): requiredpsbtBid2 (string): Auction mode is used, and the current empty string can be passedpsbtSettle (string): Auction mode is used, and the current empty string can be passedfromBase64 (boolean): Is Base64 format, the default is hex formatDefault Response
code (number): requiredmsg (string): requireddata (object):
txid (string): required; Transaction txidMethod: POST
Path: /v3/market/alkanes/auction/create_put_off
Swagger Link: View in Swagger UI
Builds a delisting transaction for an auction id and returns PSBT, estimated transaction size, BTC sign indexes, and asset sign indexes. Optional inputs support custom UTXOs, RBF, off-chain cancellation, and multi-address wallets.
Content-Type: application/json (required)
auctionId (string): requirednftAddress (string): (Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address.btcPubkey (string): (Optional) Only for multi-address wallet, such as Xverse, hiro. The public key used in the inscription of the order.utxos (array): Custom utxo
txid (string):index (number):rbf (boolean):offChain (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):
psbt (string): requiredtxSize (number):btcSignIndexes (array): Specifies the btc signature location used by the xverse walletnftSignIndexes (array): Specifies the nft signature location used by the xverse walletMethod: POST
Path: /v3/market/alkanes/auction/confirm_put_off
Swagger Link: View in Swagger UI
Confirms the signed delisting PSBT for an auction id and returns the cancellation transaction id when removal is completed or accepted.
Content-Type: application/json (required)
auctionId (string): requiredpsbt (string): requiredfromBase64 (boolean): Is Base64 format, the default is hex formatoffChain (boolean):Default Response
code (number): requiredmsg (string): requireddata (object):
txid (string): requiredMethod: POST
Path: /v3/market/alkanes/auction/create_modify_price
Swagger Link: View in Swagger UI
Builds a PSBT to change an existing listing’s total and unit price, returning the signing payload and sign indexes for the specified auction id.
Content-Type: application/json (required)
auctionId (string): requiredinitPrice (string): requiredunitPrice (string): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):
psbt (string): requiredsignIndexes (array): Specifies the signature location used by the xverse walletMethod: POST
Path: /v3/market/alkanes/auction/confirm_modify_price
Swagger Link: View in Swagger UI
Confirms the signed price-update PSBT for an auction id and updates the active listing price. The response is empty on success, so use listing or activity queries to verify the new price.
Content-Type: application/json (required)
auctionId (string): requiredpsbt (string): requiredfromBase64 (boolean): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v3/market/alkanes/auction/create_batch_put_on
Swagger Link: View in Swagger UI
Builds a batch listing draft for multiple Alkanes UTXOs and returns batch auction id, PSBT, and sign indexes. Verify every UTXO, shared unit price, public key, and receiving address before signing.
Content-Type: application/json (required)
unitPrice (string): required; Unit Price (for tick)pubkey (string): required; User public keynftType (string):btcAddress (string): (Optional) Only for multi-address wallet, such as Xverse, hiro. Specifies the BTC receive addressutxos (array): Custom utxo
txid (string):index (number):Default Response
code (number): requiredmsg (string): requireddata (object):
batchAuctionId (string):psbt (string): requiredsignIndexes (array): Specifies the signature location used by the xverse walletMethod: POST
Path: /v3/market/alkanes/auction/confirm_batch_put_on
Swagger Link: View in Swagger UI
Confirms a signed batch listing PSBT and activates all listings in the batch. The response is empty on success, so verify the published listings through list or activity endpoints.
Content-Type: application/json (required)
batchAuctionId (string): requiredpsbt (string): requiredfromBase64 (boolean): Is Base64 format, the default is hex formatDefault Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v3/market/alkanes/auction/create_batch_bid_prepare
Swagger Link: View in Swagger UI
Calculates batch purchase preparation data for auction ids, including service fee, real fee, fee rate, estimated transaction size, network fee rate, available balance, valid auction ids, and invalid auction ids.
Content-Type: application/json (required)
auctionIds (array):address (string): required; Bidder addresspubkey (string): required; Bidder pubkeyDefault Response
code (number): requiredmsg (string): requireddata (object):
serverFee (number): Expected service fee.serverReal (number): Real service fee.serverFeeRate (number): Real service fee rate.txSize (number): Estimated transaction sizefeeRate (number): Network fee rateavailableBalance (number): Available confirmed balance for the uservalidAuctionIds (array):invalidAuctionIds (array):Method: POST
Path: /v3/market/alkanes/auction/create_batch_bid
Swagger Link: View in Swagger UI
Builds batch purchase orders for multiple auction ids and bid prices, returning bid id, bid PSBT, platform fee, network fee, fee rate, and wallet sign indexes.
Content-Type: application/json (required)
auctionIds (array):bidPrices (array):address (string): required; Bidder addresspubkey (string): required; Bidder pubkeyfeeRate (number): The user sets the ratenftAddress (string): (Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving addressDefault Response
code (number): requiredmsg (string): requireddata (object):
bidId (string): requiredpsbtBid (string): required; Bid psbtserverFee (number): required; The service fee charged by the platformnetworkFee (number): required; BTC network total feefeeRate (number): required; BTC network fee ratebidSignIndexes (array): Specifies the bid signature location used by the xverse walletMethod: POST
Path: /v3/market/alkanes/auction/confirm_batch_bid
Swagger Link: View in Swagger UI
Confirms the signed batch bid PSBT and returns the settlement transaction id when the batch purchase is accepted.
Content-Type: application/json (required)
bidId (string): requiredpsbtBid (string): requiredfromBase64 (boolean): Is Base64 format, the default is hex formatDefault Response
code (number): requiredmsg (string): requireddata (object):
txid (string): required; Transaction txid