unisat-dev-docs

Ordinals Collection Marketplace API

This API provides endpoints for Ordinals collection marketplace services, including collection statistics, listing search, address collection summaries, inscription listing details, order preparation, and order submission.

👉 View Swagger UI


📑 Table of Contents

Route Summary
POST /v3/market/collection/auction/collection_statistic Get collection market statistics
POST /v3/market/collection/auction/collection_statistic_list List collection market statistics
POST /v3/market/collection/auction/collection_summary Get address collection summary
POST /v3/market/collection/auction/collection_inscriptions List address collection inscriptions
POST /v3/market/collection/auction/inscription_info Get marketplace inscription detail
POST /v3/market/collection/auction/inscription_info_list Get marketplace inscription details in batch
POST /v3/market/collection/auction/list Search Ordinals collection marketplace listings
POST /v3/market/collection/auction/actions List Ordinals collection marketplace activity history
POST /v3/market/collection/auction/create_put_on Create collection listing PSBT draft
POST /v3/market/collection/auction/confirm_put_on Publish signed collection listing
POST /v3/market/collection/auction/create_bid_prepare Estimate collection purchase fees and balance
POST /v3/market/collection/auction/create_bid Create collection purchase PSBT order
POST /v3/market/collection/auction/confirm_bid Submit signed collection purchase order
POST /v3/market/collection/auction/create_put_off Create collection delisting PSBT draft
POST /v3/market/collection/auction/confirm_put_off Remove signed collection listing
POST /v3/market/collection/auction/create_modify_price Create collection price-update PSBT draft
POST /v3/market/collection/auction/confirm_modify_price Apply signed collection listing price update

Marketplace-Collections

Get collection market statistics

Method: POST
Path: /v3/market/collection/auction/collection_statistic
Swagger Link: View in Swagger UI

Description

Query read-only marketplace statistics for a specific Ordinals collection, including floor price, listed count, and volume. This query-style POST only reads market data; readonly true and requires confirmation false.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


List collection market statistics

Method: POST
Path: /v3/market/collection/auction/collection_statistic_list
Swagger Link: View in Swagger UI

Description

Query read-only marketplace statistics for Ordinals collections with filters and pagination. This query-style POST only reads market data; readonly true and requires confirmation false.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Get address collection summary

Method: POST
Path: /v3/market/collection/auction/collection_summary
Swagger Link: View in Swagger UI

Description

Query read-only Ordinals collection holdings summary for an address. This query-style POST only reads address and collection data; readonly true and requires confirmation false.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


List address collection inscriptions

Method: POST
Path: /v3/market/collection/auction/collection_inscriptions
Swagger Link: View in Swagger UI

Description

Query read-only inscription details for a collection held by an address. This query-style POST only reads collection data; readonly true and requires confirmation false.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Get marketplace inscription detail

Method: POST
Path: /v3/market/collection/auction/inscription_info
Swagger Link: View in Swagger UI

Description

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.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Get marketplace inscription details in batch

Method: POST
Path: /v3/market/collection/auction/inscription_info_list
Swagger Link: View in Swagger UI

Description

Query read-only marketplace listing details for multiple inscriptions. This query-style POST only reads marketplace data; readonly true and requires confirmation false.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Search Ordinals collection marketplace listings

Method: POST
Path: /v3/market/collection/auction/list
Swagger Link: View in Swagger UI

Description

Query read-only Ordinals collection marketplace listings with filters, sorting, and pagination. This query-style POST only reads marketplace data; readonly true and requires confirmation false.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


List Ordinals collection marketplace activity history

Method: POST
Path: /v3/market/collection/auction/actions
Swagger Link: View in Swagger UI

Description

Query read-only Ordinals collection 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.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create collection listing PSBT draft

Method: POST
Path: /v3/market/collection/auction/create_put_on
Swagger Link: View in Swagger UI

Description

Creates an Ordinals collection listing draft and returns auctionId, PSBT, and signing indexes for the seller. Review inscriptionId, collectionId, item metadata, initPrice, unitPrice, marketType, and receiving address before signing or confirming the listing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Publish signed collection listing

Method: POST
Path: /v3/market/collection/auction/confirm_put_on
Swagger Link: View in Swagger UI

Description

Confirms the seller-signed listing PSBT and activates the Ordinals collection marketplace listing. Verify auctionId, PSBT encoding, inscriptionId, collection item, listing price, seller address, and market type before submitting.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Estimate collection purchase fees and balance

Method: POST
Path: /v3/market/collection/auction/create_bid_prepare
Swagger Link: View in Swagger UI

Description

Returns pre-purchase fee estimates, available balances, network fee rate, transaction size, and inscription value for an Ordinals collection listing. This is a quote/material preparation step only; before any later purchase submission, verify auctionId, bidPrice, buyer address, feeRate, and inscription details.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create collection purchase PSBT order

Method: POST
Path: /v3/market/collection/auction/create_bid
Swagger Link: View in Swagger UI

Description

Creates an Ordinals collection purchase order and returns bidId, PSBT data, signing indexes, server/network fees, feeRate, and inscription value. Confirm auctionId, bidPrice, buyer address, inscriptionId, collection item, and fee totals before requesting signatures.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Submit signed collection purchase order

Method: POST
Path: /v3/market/collection/auction/confirm_bid
Swagger Link: View in Swagger UI

Description

Submits the signed collection purchase PSBT and returns the settlement transaction id when accepted. Before calling, verify auctionId, bidId, PSBT content, final price, inscriptionId, buyer/seller addresses, and fee values because this can settle the purchase.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create collection delisting PSBT draft

Method: POST
Path: /v3/market/collection/auction/create_put_off
Swagger Link: View in Swagger UI

Description

Creates delisting signing material for an active Ordinals collection marketplace order, including PSBT/signing data when needed. Confirm auctionId, owner addresses, inscriptionId, and collection item before signing because the next confirmation removes the listing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Remove signed collection listing

Method: POST
Path: /v3/market/collection/auction/confirm_put_off
Swagger Link: View in Swagger UI

Description

Confirms signed delisting data and removes the Ordinals collection listing from the marketplace. Verify auctionId, PSBT/signature payload, owner address, inscriptionId, and collection item before submitting.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Create collection price-update PSBT draft

Method: POST
Path: /v3/market/collection/auction/create_modify_price
Swagger Link: View in Swagger UI

Description

Creates signing material to update an existing Ordinals collection listing price. Verify auctionId, inscriptionId, collection item, old and new prices, seller address, and returned PSBT/sign indexes before signing.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response


Apply signed collection listing price update

Method: POST
Path: /v3/market/collection/auction/confirm_modify_price
Swagger Link: View in Swagger UI

Description

Confirms signed price-update data and changes the active Ordinals collection listing price. Verify auctionId, signed PSBT, inscriptionId, seller address, and final price before submitting.

Request Body

Content-Type: application/json (required)

Response (200)

Default Response