Collection Marketplace

Return a summary of collection.

post

Authorizations

Body

collectionIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/collection_statistic' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "collectionId": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "collectionId": "text",
    "name": "text",
    "desc": "text",
    "icon": "text",
    "iconContentType": "text",
    "btcValue": 1,
    "floorPrice": 1,
    "pricePercent": 1,
    "listed": 1,
    "total": 1,
    "supply": 1,
    "twitter": "text",
    "discord": "text",
    "website": "text",
    "verification": true
  }
}

Default Response

Return a summary of collection.

post

Authorizations

Body

filterobjectoptional

startnumberrequired

limitnumber · max: 21required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/collection_statistic_list' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "filter": {
      "timeType": "text",
      "name": "text",
      "collections": [
        "text"
      ]
    },
    "start": 1,
    "limit": 1
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "collectionId": "text",
        "name": "text",
        "desc": "text",
        "icon": "text",
        "iconContentType": "text",
        "btcValue": 1,
        "floorPrice": 1,
        "pricePercent": 1,
        "listed": 1,
        "total": 1,
        "supply": 1,
        "twitter": "text",
        "discord": "text",
        "website": "text",
        "verification": true
      }
    ],
    "total": 1
  }
}

Default Response

• This API is designed to query information about collections that have been listed within a specified number of days. The time must be specified, while other fields are optional.

• timeType can be filled with formats like 1d, 7d.

• The name field here is for entering the collection name

Get the collection statistics information at a certain address

post

Authorizations

Body

firstCollectionIdstringoptional

addressstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/collection_summary' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "firstCollectionId": "text",
    "address": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "collectionId": "text",
        "icon": "text",
        "iconContentType": "text",
        "name": "text",
        "total": 1
      }
    ]
  }
}

Default Response

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

post

Authorizations

Body

collectionIdstringrequired

addressstringrequired

startnumberrequired

limitnumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/collection_inscriptions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "collectionId": "text",
    "address": "text",
    "start": 1,
    "limit": 1
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "collectionId": "text",
        "collectionName": "text",
        "collectionItemName": "text",
        "collectionHighResImgUrl": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "contentType": "text",
        "listed": true
      }
    ],
    "total": 1
  }
}

Default Response

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

post

Authorizations

Body

inscriptionIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/inscription_info' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "inscriptionId": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "auctionId": "text",
    "inscriptionId": "text",
    "inscriptionNumber": 1,
    "marketType": "fixedPrice",
    "address": "text",
    "price": 1,
    "notSupport": true,
    "verification": true,
    "nftType": "text",
    "tick": "text",
    "limit": 1,
    "amount": 1,
    "unitPrice": 1,
    "collectionId": "text",
    "contentType": "text",
    "contentBody": "text",
    "collectionItemName": "text",
    "collectionHighResImgUrl": "text",
    "collectionName": "text",
    "notOnSale": true,
    "domain": "text",
    "domainHex": "text",
    "domainType": "sats",
    "utxo": {}
  }
}

Default Response

Get the basic listing information of the specified inscription list

post

Authorizations

Body

addressstringoptional

inscriptionIdsstring[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/inscription_info_list' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "address": "text",
    "inscriptionIds": [
      "text"
    ]
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "address": "text",
        "price": 1,
        "nftType": "text",
        "status": "text"
      }
    ]
  }
}

Default Response

Retrieve the list information of the market.

post

Authorizations

Body

filterobjectrequired

sortobjectrequired

startnumberrequired

The data is looked up from start

limitnumber · max: 100required

Limit the amount of data

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/list' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "filter": {
      "nftType": "brc20",
      "address": "text",
      "tick": "text",
      "minPrice": 1,
      "maxPrice": 1,
      "nftConfirm": true,
      "isEnd": true,
      "domainType": "sats",
      "domainMinLength": 1,
      "domainMaxLength": 1,
      "domainCategory": "text",
      "domainFuzzy": "text",
      "collectionId": "text",
      "collectionFuzzy": "text",
      "all": true
    },
    "sort": {
      "unitPrice": 1,
      "onSaleTime": 1,
      "initPrice": 1,
      "inscriptionNumber": 1
    },
    "start": 1,
    "limit": 1
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "address": "text",
        "price": 1,
        "notSupport": true,
        "verification": true,
        "nftType": "text",
        "tick": "text",
        "limit": 1,
        "amount": 1,
        "unitPrice": 1,
        "collectionId": "text",
        "contentType": "text",
        "contentBody": "text",
        "collectionItemName": "text",
        "collectionHighResImgUrl": "text",
        "collectionName": "text",
        "notOnSale": true,
        "domain": "text",
        "domainHex": "text",
        "domainType": "sats"
      }
    ],
    "total": 1,
    "timestamp": 1
  }
}

Default Response

Get information on listings, delistings, and sales.

post

Authorizations

Body

filterobjectrequired

startnumberrequired

limitnumber · max: 100required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/actions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "filter": {
      "nftType": "brc20",
      "address": "text",
      "inscriptionId": "text",
      "event": "Cancel",
      "tick": "text",
      "domainType": "text",
      "collectionId": "text"
    },
    "start": 1,
    "limit": 1
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "event": "Listed",
        "price": 1,
        "from": "text",
        "to": "text",
        "timestamp": 1,
        "nftConfirmNum": 1,
        "nftType": "brc20",
        "endMsg": "text",
        "newest": true,
        "name": "text",
        "unitPrice": 1,
        "amount": 1,
        "domain": "text",
        "domainType": "sats",
        "domainCategorys": [
          "Keyboard"
        ],
        "collectionId": "text",
        "collectionItemName": "text",
        "contentType": "text",
        "contentBody": "text",
        "attributes": [
          {
            "trait_type": "text",
            "value": "text"
          }
        ]
      }
    ],
    "total": 1
  }
}

Default Response

Create listing order.

post

Authorizations

Body

nftTypestringoptional

inscriptionIdstringrequired

initPricestringrequired

Set the initial total price

unitPricestringrequired

Unit Price (for tick)

pubkeystringrequired

User public key

marketTypestring · enumrequired

Example: fixedPrice

Options: auction, fixedPrice

btcAddressstringoptional

(Optional) Only for multi-address wallet, such as Xverse, hiro. Specifies the BTC receive address

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/create_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "nftType": "text",
    "inscriptionId": "text",
    "initPrice": "text",
    "unitPrice": "text",
    "pubkey": "text",
    "marketType": "fixedPrice",
    "btcAddress": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "auctionId": "text",
    "psbt": "text",
    "signIndexes": [
      1
    ]
  }
}

Default Response

Confirm listing order.

post

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanoptional

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/confirm_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "psbt": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response

Return params before creating purchase order.

post

Authorizations

Body

auctionIdstringrequired

bidPricenumberrequired

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/create_bid_prepare' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "bidPrice": 1,
    "address": "text",
    "pubkey": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "serverFee": 1,
    "serverReal": 1,
    "serverFeeRate": 1,
    "txSize": 1,
    "nftValue": 1,
    "feeRate": 1,
    "availableBalance": 1,
    "allBalance": 1
  }
}

Default Response

Create purchase order.

post

Authorizations

Body

auctionIdstringrequired

bidPricenumberrequired

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

feeRatenumberoptional

The user sets the rate

nftAddressstringoptional

(Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address

utxosobject[]optional

Custom utxo

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/create_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "bidPrice": 1,
    "address": "text",
    "pubkey": "text",
    "feeRate": 1,
    "nftAddress": "text",
    "utxos": [
      {
        "txid": "text",
        "index": 1
      }
    ]
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "bidId": "text",
    "psbtBid": "text",
    "psbtBid2": "text",
    "psbtSettle": "text",
    "serverFee": 1,
    "networkFee": 1,
    "feeRate": 1,
    "nftValue": 1,
    "bidSignIndexes": [
      1
    ]
  }
}

Default Response

Confirm purchase order.

post

Authorizations

Body

auctionIdstringrequired

bidIdstringrequired

psbtBidstringrequired

psbtBid2stringoptional

Auction mode is used, and the current empty string can be passed

psbtSettlestringoptional

Auction mode is used, and the current empty string can be passed

fromBase64booleanoptional

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/confirm_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "bidId": "text",
    "psbtBid": "text",
    "psbtBid2": "text",
    "psbtSettle": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "txid": "text"
  }
}

Default Response

Create delisting order.

post

Authorizations

Body

auctionIdstringrequired

nftAddressstringoptional

(Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address.

btcPubkeystringoptional

(Optional) Only for multi-address wallet, such as Xverse, hiro. The public key used in the inscription of the order.

utxosobject[]optional

Custom utxo

rbfbooleanoptional

offChainbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/create_put_off' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "nftAddress": "text",
    "btcPubkey": "text",
    "utxos": [
      {
        "txid": "text",
        "index": 1
      }
    ],
    "rbf": true,
    "offChain": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "psbt": "text",
    "txSize": 1,
    "btcSignIndexes": [
      1
    ],
    "nftSignIndexes": [
      1
    ]
  }
}

Default Response

Confirm delisting order.

post

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanoptional

Is Base64 format, the default is hex format

offChainbooleanoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/confirm_put_off' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "psbt": "text",
    "fromBase64": true,
    "offChain": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "txid": "text"
  }
}

Default Response

Create the order for price adjustment.

post

Authorizations

Body

auctionIdstringrequired

initPricestringrequired

unitPricestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/create_modify_price' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "initPrice": "text",
    "unitPrice": "text"
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "psbt": "text",
    "signIndexes": [
      1
    ]
  }
}

Default Response

Confirm the order for price adjustment.

post

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/collection/auction/confirm_modify_price' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "auctionId": "text",
    "psbt": "text",
    "fromBase64": true
  }'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response