Get Listings

Please note that access to this API requires the API key to have market permissions enabled.

Retrieve the list information of the market.

POSThttps://open-api.unisat.io/v3/market/{type}/auction/list

Path parameters

type*enum

brc20collectiondomain

Body

application/json

filter*object

sort*object

start*number

The data is looked up from start

limit*number

Limit the amount of data

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://open-api.unisat.io/v3/market/{type}/auction/list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {
        "nftType": "brc20"
      },
      "sort": {},
      "start": 0,
      "limit": 0
    }),
});
const data = await response.json();

Response

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

The enumerated values for the type int path are brc20, domain, collection.