This API provides endpoints for Ordinals domain marketplace services, including domain type statistics, domain listing search, inscription details, activity history, and marketplace order workflows.
👉 View Swagger UI
Method: POST
Path: /v3/market/domain/auction/domain_types
Swagger Link: View in Swagger UI
Query read-only Ordinals domain marketplace statistics grouped by domain type. This query-style POST only reads market data; readonly true and requires confirmation false.
Default Response
code (number): requiredmsg (string): requireddata (object):
list (array):
btcVolume (number):btcVolumePercent (number):amountVolume (number):curPrice (integer):domainType (string):Method: POST
Path: /v3/market/domain/auction/domain_statistic
Swagger Link: View in Swagger UI
Query read-only marketplace statistics for categories under a specified Ordinals domain type. This query-style POST only reads market data; readonly true and requires confirmation false.
Content-Type: application/json (required)
domainType (string): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):
list (array):
demo (string):domainCategory (string):total (integer):Method: POST
Path: /v3/market/domain/auction/inscription_info
Swagger Link: View in Swagger UI
Query read-only marketplace inscription detail for one inscription, including listing and asset metadata. This query-style POST only reads marketplace data; readonly true and requires confirmation false.
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/domain/auction/inscription_info_list
Swagger Link: View in Swagger UI
Query read-only marketplace listing details for multiple inscriptions. This query-style POST only reads marketplace data; readonly true and requires confirmation false.
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/domain/auction/list
Swagger Link: View in Swagger UI
Query read-only Ordinals domain marketplace listings with filters, sorting, and pagination. This query-style POST only reads marketplace data; readonly true and requires confirmation false.
Content-Type: application/json (required)
filter (object):
nftType (string): required; enum: domainaddress (string):tick (string):minPrice (number):maxPrice (number):nftConfirm (boolean):isEnd (boolean): Whether order endsdomainType (string): enum: sats, unisat, btc, xbt, ord, gm, bitmap, xdomainMinLength (number):domainMaxLength (integer):domainCategory (string):domainFuzzy (string): Fuzzy domain name searchcollectionId (string):collectionFuzzy (string): Fuzzy collection name searchall (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):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, nulltotal (number): requiredtimestamp (number):Method: POST
Path: /v3/market/domain/auction/actions
Swagger Link: View in Swagger UI
Query read-only Ordinals domain marketplace activity history such as listings, delistings, sales, claims, and updates. This query-style POST only reads marketplace data; readonly true and requires confirmation false.
Content-Type: application/json (required)
filter (object):
nftType (string): enum: domainaddress (string):inscriptionId (string):event (string): Event type: Cancel, Listed, Sold, Updated; enum: Cancel, Claim, Listed, Sold, Updatedtick (string):domainType (string):collectionId (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/domain/auction/create_put_on
Swagger Link: View in Swagger UI
Creates an Ordinals domain listing draft and returns auctionId, PSBT, and signing indexes for the seller. Review inscriptionId, domain name/type/category, initPrice, unitPrice, marketType, and receiving address before signing or confirming the listing.
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/domain/auction/confirm_put_on
Swagger Link: View in Swagger UI
Confirms the seller-signed listing PSBT and activates the Ordinals domain marketplace listing. Verify auctionId, PSBT encoding, domain name, listing price, seller address, and market type before submitting.
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/domain/auction/create_bid_prepare
Swagger Link: View in Swagger UI
Returns pre-purchase fee estimates, available balances, network fee rate, transaction size, and inscription value for an Ordinals domain listing. This is a quote/material preparation step only; before any later purchase submission, verify auctionId, bidPrice, buyer address, feeRate, and domain name.
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/domain/auction/create_bid
Swagger Link: View in Swagger UI
Creates an Ordinals domain purchase order and returns bidId, PSBT data, signing indexes, server/network fees, feeRate, and inscription value. Confirm auctionId, bidPrice, buyer address, domain name/type, and fee totals before requesting signatures.
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/domain/auction/confirm_bid
Swagger Link: View in Swagger UI
Submits the signed domain purchase PSBT and returns the settlement transaction id when accepted. Before calling, verify auctionId, bidId, PSBT content, final price, domain name, buyer/seller addresses, and fee values because this can settle the purchase.
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/domain/auction/create_put_off
Swagger Link: View in Swagger UI
Creates delisting signing material for an active Ordinals domain marketplace order, including PSBT/signing data when needed. Confirm auctionId, owner addresses, and domain name before signing because the next confirmation removes the listing.
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/domain/auction/confirm_put_off
Swagger Link: View in Swagger UI
Confirms signed delisting data and removes the Ordinals domain listing from the marketplace. Verify auctionId, PSBT/signature payload, owner address, and target domain name 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/domain/auction/create_modify_price
Swagger Link: View in Swagger UI
Creates signing material to update an existing Ordinals domain listing price. Verify auctionId, domain name, old and new prices, seller address, and returned PSBT/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/domain/auction/confirm_modify_price
Swagger Link: View in Swagger UI
Confirms signed price-update data and changes the active Ordinals domain listing price. Verify auctionId, signed PSBT, domain name, seller address, and final price before submitting.
Content-Type: application/json (required)
auctionId (string): requiredpsbt (string): requiredfromBase64 (boolean): requiredDefault Response
code (number): requiredmsg (string): requireddata (object):