Retrieve collection list#
This interface provides a list of all the collections supported and vetted by OKX.
To get the collection list of the specified chain, set the chain field in the request parameter.
Request address#
GET https://web3.okx.com/api/v5/mktplace/nft/collection/list
Request param#
| Parameter | Type | Required | Description |
|---|---|---|---|
| chain | String | No | Chain name refer to Supported blockchains for details |
| 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 2, and the max is 300 |
Response param#
Array of objects of the collection model
| Parameter | Type | Description |
|---|---|---|
| name | String | Collection name |
| des | String | Collection description |
| image | String | Collection logo URL |
| backgroundImage | String | Collection background image URL |
| slug | String | Collection slug, which is the unique identifier of the collection |
| certificateFlag | Boolean | Collection certification flag |
| officialWebsite | String | Collection official website |
| instagramUrl | String | The Instagram URL of the collection |
| discordUrl | String | The Discord URL of the collection |
| mediumUrl | String | The Medium URL of the collection |
| twitterUrl | String | The Twitter URL of the collection |
| categoryList | Array | The category list of the collection |
| assetContracts | Array | An array of the asset contract model that are associated with this collection, including contract address, protocol standard, owner address, whether the ERC-2981 protocol is supported, etc. |
| stats | Object | A dictionary containing some statistics related to this collection, including trade volume and floor prices, an object of the collection stats model |
Request example#
shell
curl -X GET "https://web3.okx.com/api/v5/mktplace/nft/collection/list" \
-H 'OK-ACCESS-KEY: XXX' \
-H 'OK-ACCESS-TIMESTAMP: XXX' \
-H 'OK-ACCESS-PASSPHRASE: XXX' \
-H 'OK-ACCESS-SIGN: XXX' \
-d "chain=eth" \
-d "limit=1"
Response example#
200
{
"code": 0,
"data": [
{
"animationUrl": "",
"assetContract": {
"chain": "Ethereum",
"contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
"erc2981": false,
"ownerAddress": "0xaba7161a7fb69c88e16ed9f455ce62b791ee4d03",
"tokenStandard": "erc721"
},
"attributes": "[{\"trait_type\":\"Background\",\"value\":\"Gray\"},{\"trait_type\":\"Fur\",\"value\":\"Dark Brown\"},{\"trait_type\":\"Hat\",\"value\":\"Laurel Wreath\"},{\"trait_type\":\"Mouth\",\"value\":\"Bored Unshaven Cigarette\"},{\"trait_type\":\"Clothes\",\"value\":\"Smoking Jacket\"},{\"trait_type\":\"Eyes\",\"value\":\"Bloodshot\"}]",
"collection": {
"assetContracts": [
{
"chain": "Ethereum",
"contractAddress": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
"erc2981": false,
"ownerAddress": "0xaba7161a7fb69c88e16ed9f455ce62b791ee4d03",
"tokenStandard": "erc721"
}
],
"backgroundImage": "https://static.coinall.ltd/cdn/nft/files/collection/205-background.png",
"categoryList": [
"Collectibles"
],
"certificateFlag": true,
"des": "The Bored Ape Yacht Club is a collection of 10,000 unique Bored Ape NFTs— unique digital collectibles living on the Ethereum blockchain. Your Bored Ape doubles as your Yacht Club membership card, and grants access to members-only benefits, the first of which is access to THE BATHROOM, a collaborative graffiti board. Future areas and perks can be unlocked by the community through roadmap activation. Visit www.BoredApeYachtClub.com for more details.",
"discordUrl": "https://discord.gg/3P5K3dzgdB",
"image": "https://static.coinall.ltd/cdn/nft/d962ef0d-1cc1-4333-b19f-fc19c7322335.jpg",
"instagramUrl": "",
"mediumUrl": "",
"name": "Bored Ape Yacht Club",
"officialWebsite": "http://www.boredapeyachtclub.com/",
"slug": "bored-ape-yacht-club",
"stats": {
"floorPrice": "105752.05",
"latestPrice": "102662.45",
"ownerCount": "5666",
"totalCount": "10000",
"totalVolume": "2239291136.375853"
},
"twitterUrl": "https://twitter.com/BoredApeYC"
},
"image": "https://static.coinall.ltd/cdn/nft/files/8e8fd651-40cd-46e0-8e81-9d670f61e25b.webp",
"imagePreviewUrl": "https://static.coinall.ltd/cdn/nft/files/8e8fd651-40cd-46e0-8e81-9d670f61e25b.webp/type=list",
"imageThumbnailUrl": "https://static.coinall.ltd/cdn/nft/files/8e8fd651-40cd-46e0-8e81-9d670f61e25b.webp/type=detail",
"name": "Bored Ape Yacht Club #11",
"tokenId": "11",
"tokenUri": "ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/11"
}
],
"msg": ""
}