BRC-20 marketplace APIs for address binding, market discovery, listing inspection, activity history, and PSBT-based listing, purchase, delisting, and price update workflows.
👉 View Swagger UI
| Route | Summary |
|---|---|
POST /v3/market/brc20/auction/bind_info |
Get marketplace payment and inscription addresses for an account |
POST /v3/market/brc20/auction/brc20_kline |
Get BRC-20 marketplace price candles |
POST /v3/market/brc20/auction/brc20_types |
Rank BRC-20 tickers by marketplace metrics |
POST /v3/market/brc20/auction/brc20_types_specified |
Get marketplace metrics for selected BRC-20 tickers |
POST /v3/market/brc20/auction/bind |
Bind marketplace payment and inscription addresses |
POST /v3/market/brc20/auction/list |
Search BRC-20 token listings for sale |
POST /v3/market/brc20/auction/inscription_info |
Get BRC-20 listing detail by inscription |
POST /v3/market/brc20/auction/inscription_info_list |
Get BRC-20 listing details for multiple inscriptions |
POST /v3/market/brc20/auction/actions |
List BRC-20 marketplace listing and sale events |
POST /v3/market/brc20/auction/create_put_on |
Create a BRC-20 fixed-price listing PSBT |
POST /v3/market/brc20/auction/confirm_put_on |
Publish a signed BRC-20 listing |
POST /v3/market/brc20/auction/create_bid_prepare |
Estimate fees and balance for a BRC-20 purchase |
POST /v3/market/brc20/auction/create_bid |
Create a BRC-20 purchase PSBT |
POST /v3/market/brc20/auction/confirm_bid |
Submit a signed BRC-20 purchase |
POST /v3/market/brc20/auction/create_put_off |
Create a BRC-20 delisting PSBT |
POST /v3/market/brc20/auction/confirm_put_off |
Remove a signed BRC-20 listing |
POST /v3/market/brc20/auction/create_modify_price |
Create a BRC-20 listing price-update PSBT |
POST /v3/market/brc20/auction/confirm_modify_price |
Apply a signed BRC-20 listing price update |
Method: POST
Path: /v3/market/brc20/auction/bind_info
Swagger Link: View in Swagger UI
Returns the BTC payment address and NFT/inscription receiving address currently bound for BRC-20 marketplace trading. Use it before listing or buying to confirm which wallet addresses the marketplace will use.
Content-Type: application/json (required)
address (string): requiredDefault Response
btcAddress (string): requirednftAddress (string): requiredMethod: POST
Path: /v3/market/brc20/auction/brc20_kline
Swagger Link: View in Swagger UI
Returns time-series price points for a ticker over the requested time range and granularity. Use it to draw marketplace price charts or analyze short-term trading trends.
Content-Type: application/json (required)
tick (string): requiredtimeStart (number): required; Start time rangetimeEnd (number): required; End time rangetimeStep (number): required; Time granularity, such as milliseconds for a 5-minute intervalDefault Response
code (number): requiredmsg (string): requireddata (array):
price (number):timestamp (number):Method: POST
Path: /v3/market/brc20/auction/brc20_types
Swagger Link: View in Swagger UI
Returns paginated market statistics for BRC-20 tickers, including current price, price change, BTC volume, token volume, market cap, and featured deploy entries. Supports ticker length, time window, explicit ticker list, and pagination filters.
Content-Type: application/json
tickLen (number): enum: 4, 5; example: 4timeType (string): Optional: day1, day7, day30; enum: day1, day7, day30ticks (array): Specify a list of ticksstart (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): requireddeploy (array): The first three deployments of tick
tick (string): requiredcurPrice (number): requiredchangePrice (number): requiredbtcVolume (number): requiredamountVolume (number): requiredcap (string): requiredcap (array): The top three tick by market capitalization
tick (string): requiredcurPrice (number): requiredchangePrice (number): requiredbtcVolume (number): requiredamountVolume (number): requiredcap (string): requiredMethod: POST
Path: /v3/market/brc20/auction/brc20_types_specified
Swagger Link: View in Swagger UI
Returns market statistics for specific BRC-20 tickers, such as price, price change, volume, market cap, and related ticker metadata. Use it when the client already knows which tickers to compare or display.
Content-Type: application/json
timeType (string): enum: day1, day7, day30tick (string):Default Response
code (number): requiredmsg (string): requireddata (object):
tick (string):curPrice (number):changePrice (number):btcVolume (number):amountVolume (number):Method: POST
Path: /v3/market/brc20/auction/bind
Swagger Link: View in Swagger UI
Records the BTC payment address and NFT/inscription receiving address pair used by BRC-20 marketplace workflows. Confirm both addresses carefully because later listing and purchase flows may rely on this binding.
Content-Type: application/json (required)
btcAddress (string): requirednftAddress (string): requiredsign (string): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):Method: POST
Path: /v3/market/brc20/auction/list
Swagger Link: View in Swagger UI
Returns paginated marketplace listings with auction id, inscription id, seller address, ticker, token amount, total price, unit price, market type, and latest listing context. Use it to power order books, ticker detail pages, and buy-flow listing selection.
Content-Type: application/json (required)
filter (object):
nftType (string): required; enum: brc20address (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/brc20/auction/inscription_info
Swagger Link: View in Swagger UI
Returns marketplace and asset metadata for one inscription, including whether it is listed, its auction context when available, ticker amount, price fields, owner or seller information, and inscription identifiers.
Content-Type: application/json (required)
inscriptionId (string): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):
auctionId (string):inscriptionId (string): requiredinscriptionNumber (number):marketType (string): example: "fixedPrice"address (string):price (number):notSupport (boolean): Domain name content support on saleverification (boolean): Whether the collection is validatednftType (string):tick (string): Brc20 fieldlimit (number): Brc20 fieldamount (number): Brc20 fieldunitPrice (number): Brc20 fieldcollectionId (string): Collection fieldcontentType (string): Collection fieldcontentBody (string): Collection fieldcollectionItemName (string): Collection fieldcollectionHighResImgUrl (string): Collection fieldcollectionName (string): Collection fieldnotOnSale (boolean): Collection fielddomain (string): Domain fielddomainHex (string): Domain fielddomainType (string): Domain field; enum: sats, unisat, btc, xbt, ord, gm, bitmap, x, nullutxo (object): The UTXO where the inscription is locatedMethod: POST
Path: /v3/market/brc20/auction/inscription_info_list
Swagger Link: View in Swagger UI
Returns listing and asset metadata for a batch of inscription ids. Use it to hydrate search results, wallet views, or candidate listings without calling the single-inscription endpoint repeatedly.
Content-Type: application/json (required)
address (string):inscriptionIds (array):Default Response
code (number): requiredmsg (string): requireddata (object):
list (array):
auctionId (string):inscriptionId (string): requiredinscriptionNumber (number):marketType (string):address (string):price (number):nftType (string):status (string):Method: POST
Path: /v3/market/brc20/auction/actions
Swagger Link: View in Swagger UI
Returns paginated activity records for BRC-20 marketplace events such as listing, delisting, sale, claim, and price update. Records include auction id, inscription id, event type, price, addresses, timestamp, confirmation count, and ticker-specific metadata.
Content-Type: application/json (required)
filter (object):
nftType (string): enum: brc20address (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/brc20/auction/create_put_on
Swagger Link: View in Swagger UI
Builds the seller-side listing draft for a transferable BRC-20 inscription and returns the auction id, PSBT, and signing indexes. Review the inscription id, ticker amount, total price, unit price, market type, public key, and payout address before signing.
Content-Type: application/json (required)
nftType (string):inscriptionId (string): requiredinitPrice (string): required; Set the initial total priceunitPrice (string): required; Unit Price (for tick)pubkey (string): required; User public keymarketType (string): required; enum: auction, 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/brc20/auction/confirm_put_on
Swagger Link: View in Swagger UI
Submits the seller-signed listing PSBT for an auction id and activates the marketplace order. Success means the token amount can become visible for purchase, so verify the signed PSBT, price, ticker amount, seller address, and market type before calling.
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/brc20/auction/create_bid_prepare
Swagger Link: View in Swagger UI
Calculates purchase preparation data for an auction id and bid price, including service fee, network fee, fee rate, estimated transaction size, inscription satoshi value, available balance, and total balance. Use it to decide whether a buy order can be created safely.
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/brc20/auction/create_bid
Swagger Link: View in Swagger UI
Builds the buyer-side order for a listed BRC-20 inscription and returns bid id, purchase PSBT, signing indexes, platform fee, network fee, fee rate, and inscription value. Confirm the auction id, bid price, buyer address, ticker amount, and total fees before signing.
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/brc20/auction/confirm_bid
Swagger Link: View in Swagger UI
Confirms the signed purchase PSBT for an auction id and bid id, then returns the settlement transaction id when accepted. This can complete the transfer, so verify the PSBT, final price, ticker amount, buyer and seller addresses, and fee values before submitting.
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/brc20/auction/create_put_off
Swagger Link: View in Swagger UI
Builds the seller-side cancellation transaction for an active BRC-20 listing and returns the signing material needed to remove it. Review the auction id, owner addresses, listed ticker amount, fee settings, and returned signing payload before signing.
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/brc20/auction/confirm_put_off
Swagger Link: View in Swagger UI
Submits the signed delisting payload for an auction id and removes the listing when accepted. Verify the PSBT or signature payload, owner address, ticker amount, and target listing before submitting.
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/brc20/auction/create_modify_price
Swagger Link: View in Swagger UI
Builds signing material to change the total and unit price of an existing BRC-20 listing. Review the auction id, current ticker amount, current price, new price, seller address, and returned PSBT or sign indexes before signing.
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/brc20/auction/confirm_modify_price
Swagger Link: View in Swagger UI
Submits the signed price-update payload for an auction id and updates the active listing price when accepted. Verify the signed PSBT, ticker amount, seller address, and final total and unit prices before submitting.
Content-Type: application/json (required)
auctionId (string): requiredpsbt (string): requiredfromBase64 (boolean): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):