unisat-dev-docs

Ordinals Collection MarketPlace API

This API provides endpoints for ordinals collection marketplace services

📑 Table of Contents

Route	Summary
POST /v3/market/collection/auction/collection_statistic	Return a summary of collection.
POST /v3/market/collection/auction/collection_statistic_list	Return a summary of collection.
POST /v3/market/collection/auction/collection_summary	Get the collection statistics information at a certain address
POST /v3/market/collection/auction/collection_inscriptions	Get the list details of a certain collection at a certain address
POST /v3/market/collection/auction/inscription_info	Retrieve inscription information, including brc20, names, collection. It is necessary to first determine the inscription type before calling the relevant services.
POST /v3/market/collection/auction/inscription_info_list	Get the basic listing information of the specified inscription list
POST /v3/market/collection/auction/list	Retrieve the list information of the market.
POST /v3/market/collection/auction/actions	Get information on listings, delistings, and sales.
POST /v3/market/collection/auction/create_put_on	Create listing order.
POST /v3/market/collection/auction/confirm_put_on	Confirm listing order.
POST /v3/market/collection/auction/create_bid_prepare	Return params before creating purchase order.
POST /v3/market/collection/auction/create_bid	Create purchase order.
POST /v3/market/collection/auction/confirm_bid	Confirm purchase order.
POST /v3/market/collection/auction/create_put_off	Create delisting order.
POST /v3/market/collection/auction/confirm_put_off	Confirm delisting order.
POST /v3/market/collection/auction/create_modify_price	Create the order for price adjustment.
POST /v3/market/collection/auction/confirm_modify_price	Confirm the order for price adjustment.

MarketPlace-Collection

Return a summary of collection.

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

Response (200)

code (number):
msg (string):
data (object):
- collectionId (string):
- name (string): Collection name
- desc (string): Collection desc
- icon (string): Collection icon
- iconContentType (string): Collection icon content type
- btcValue (number): Total transaction volume
- floorPrice (number):
- pricePercent (number):
- listed (number): The quantity listed for sale
- total (number): The quantity of items already produced
- supply (number):
- twitter (string):
- discord (string):
- website (string):
- verification (boolean): Officially certified

Return a summary of collection.

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

Response (200)

code (number):
msg (string):
data (object):
- list (array):
  - collectionId (string):
  - name (string): Collection name
  - desc (string): Collection desc
  - icon (string): Collection icon
  - iconContentType (string): Collection icon content type
  - btcValue (number): Total transaction volume
  - floorPrice (number):
  - pricePercent (number):
  - listed (number): The quantity listed for sale
  - total (number): The quantity of items already produced
  - supply (number):
  - twitter (string):
  - discord (string):
  - website (string):
  - verification (boolean): Officially certified
- total (number):

Get the collection statistics information at a certain address

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

Response (200)

code (number):
msg (string):
data (object):
- list (array):
  - collectionId (string):
  - icon (string):
  - iconContentType (string):
  - name (string):
  - total (number):

Get the list details of a certain collection at a certain address

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

Response (200)

code (number):
msg (string):
data (object):
- list (array):
  - collectionId (string):
  - collectionName (string):
  - collectionItemName (string):
  - collectionHighResImgUrl (string):
  - inscriptionId (string):
  - inscriptionNumber (number):
  - contentType (string):
  - listed (boolean):
- total (number):

Retrieve inscription information, including brc20, names, collection. It is necessary to first determine the inscription type before calling the relevant services.

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

Response (200)

code (number):
msg (string):
data (object):
- auctionId (string):
- inscriptionId (string):
- inscriptionNumber (number):
- marketType (string): (example: fixedPrice)
- address (string):
- price (number):
- notSupport (boolean): Domain name content support on sale
- verification (boolean): Whether the collection is validated
- nftType (string):
- tick (string): Brc20 field
- limit (number): Brc20 field
- amount (number): Brc20 field
- unitPrice (number): Brc20 field
- collectionId (string): Collection field
- contentType (string): Collection field
- contentBody (string): Collection field
- collectionItemName (string): Collection field
- collectionHighResImgUrl (string): Collection field
- collectionName (string): Collection field
- notOnSale (boolean): Collection field
- domain (string): Domain field
- domainHex (string): Domain field
- domainType (string): Domain field
- utxo (object):

Get the basic listing information of the specified inscription list

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

Response (200)

code (number):
msg (string):
data (object):
- list (array):
  - auctionId (string):
  - inscriptionId (string):
  - inscriptionNumber (number):
  - marketType (string):
  - address (string):
  - price (number):
  - nftType (string):
  - status (string):

Retrieve the list information of the market.

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

Response (200)

code (number):
msg (string):
data (object):
- list (array):
  - auctionId (string):
  - inscriptionId (string):
  - inscriptionNumber (number):
  - marketType (string):
  - address (string):
  - price (number):
  - notSupport (boolean): Domain name content support on sale
  - verification (boolean): Whether the collection is validated
  - nftType (string):
  - tick (string): Brc20 field
  - limit (number): Brc20 field
  - amount (number): Brc20 field
  - unitPrice (number): Brc20 field
  - collectionId (string): Collection field
  - contentType (string): Collection field
  - contentBody (string): Collection field
  - collectionItemName (string): Collection field
  - collectionHighResImgUrl (string): Collection field
  - collectionName (string): Collection field
  - notOnSale (boolean): Collection field
  - domain (string): Domain field
  - domainHex (string): Domain field
  - domainType (string): Domain field
- total (number):
- timestamp (number):

Get information on listings, delistings, and sales.

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

Response (200)

code (number):
msg (string):
data (object):
- list (array):
  - auctionId (string):
  - inscriptionId (string):
  - inscriptionNumber (number):
  - event (string):
  - price (number):
  - from (string):
  - to (string):
  - timestamp (number):
  - nftConfirmNum (number):
  - nftType (string):
  - endMsg (string): An error message generated by the order
  - newest (boolean): The update order generates multiple events
  - name (string): Brc20 filed
  - unitPrice (number): Brc20 filed
  - amount (number): Brc20 filed
  - domain (string): Domain filed
  - domainType (string): Domain filed
  - domainCategorys (array):
  - collectionId (string): Collection filed
  - collectionItemName (string): Collection filed
  - contentType (string): Collection filed
  - contentBody (string): Collection filed
  - attributes (array):
    - trait_type (string):
    - value (string):
- total (number):

Create listing order.

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

Response (200)

code (number):
msg (string):
data (object):
- auctionId (string):
- psbt (string):
- signIndexes (array):

Confirm listing order.

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

Response (200)

code (number):
msg (string):
data (object):

Return params before creating purchase order.

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

Response (200)

code (number):
msg (string):
data (object):
- serverFee (number): Expected service fee.
- serverReal (number): Real service fee.
- serverFeeRate (number): Real service fee rate.
- txSize (number): Estimated transaction size
- nftValue (number): Satoshis carried by the inscription
- feeRate (number): Network fee rate
- availableBalance (number): Available confirmed balance for the user
- allBalance (number): Available total balance for the user

Create purchase order.

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

Response (200)

code (number):
msg (string):
data (object):
- bidId (string):
- psbtBid (string): Bid psbt
- psbtBid2 (string): Auction mode is used, and the current empty string can be passed
- psbtSettle (string): Auction mode is used, and the current empty string can be passed
- serverFee (number): The service fee charged by the platform
- networkFee (number): BTC network total fee
- feeRate (number): BTC network fee rate
- nftValue (number):
- bidSignIndexes (array):

Confirm purchase order.

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

Response (200)

code (number):
msg (string):
data (object):
- txid (string): Transaction txid

Create delisting order.

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

Response (200)

code (number):
msg (string):
data (object):
- psbt (string):
- txSize (number):
- btcSignIndexes (array):
- nftSignIndexes (array):

Confirm delisting order.

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

Response (200)

code (number):
msg (string):
data (object):
- txid (string):

Create the order for price adjustment.

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

Response (200)

code (number):
msg (string):
data (object):
- psbt (string):
- signIndexes (array):

Confirm the order for price adjustment.

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

Response (200)

code (number):
msg (string):
data (object):