Retrieve Ordinals collection#
This interface is used to get the list of all BTC NFT and Brc20 collections, including the unique identifier slug of each collection, the range of inscription numbers, the volume, and the floor price.
Request address#
GET https://www.okx.com/api/v5/mktplace/nft/ordinals/collections
Request param#
| Parameter | Type | Required | Description |
|---|---|---|---|
| slug | String | No | The collection‘s slug, which is the unique identifier of the collection.It means retrieve a specific collection when the value is not empty |
| cursor | String | No | For pagination. A cursor pointing to the page to retrieve. |
| limit | String | No | For pagination. The maximum number of collections to return. The default value is 100, and the max is 300. |
| isBrc20 | Boolean | No | Retrieve the list of all BTC NFT and BRC-20 collections. The default value is true, and it will return the BRC-20 list. |
Response param#
Array of objects of the Ordinals collection model
| Parameter | Type | Description |
|---|---|---|
| slug | String | The collection‘s slug, which is the unique identifier of the collection |
| totalVolume | String | Total volume of a collection, priced in BTC |
| floorPrice | String | Floor price of a collection, priced in BTC |
| inscriptionNumRange | String | Range of inscription numbers for a collection |
| volume24h | String | 24-hour trading volume of the collection, priced in BTC |
| isBrc20 | Boolean | Used to distinguish Ordinals inscription types: Brc20 or BTC NFT |
Request example#
shell
curl -X GET "https://www.okx.com/api/v5/mktplace/nft/ordinals/collections" \
-H 'OK-ACCESS-KEY: XXX' \
-H 'OK-ACCESS-TIMESTAMP: XXX' \
-H 'OK-ACCESS-PASSPHRASE: XXX' \
-H 'OK-ACCESS-SIGN: XXX' \
-d "limit=1"
Response example#
200
{
"code": 0,
"data": {
"cursor": "",
"data": [
{
"floorPrice": "0.00065",
"inscriptionNumRange": "#10423123-#44607771",
"isBrc20": false,
"slug": "bitmap-4",
"totalVolume": "3038.695704830937",
"volume24h": "31.6151456383466366"
}
]
},
"msg": ""
}