Blockdaemon Documentation
GET NFT Collection
GET NFT Collection
Ubiquity NFT URL
Path Parameters
Query Parameters
Example Queries
Example Response
GET NFT Collection
https://{ubiquity_nft_url}/{protocol}/{network}/collection/{id}
Returns detailed information about an NFT collection. There are two ways to get it:
- by a given unique collection ID (path parameter)
- by a given contract address (query parameter)
Developer documentation: GET NFT Collection
Learn how to authorize your request: Authentication Guide
Note: Blockdaemon collects NFT information and data from various third-party sources (“NFT Content”). We do not create, own, or control NFT Content and we do not routinely monitor NFT Content for violations of these Terms. You acknowledge that Blockdaemon has no responsibility or liability related to NFT Content and agree that you must evaluate, and decide for yourself if you wish to use any NFT Content.
Ubiquity URL
To run a query, add your Ubiquity NFT URL. For most users this will be:
svc.blockdaemon.com/nft/v1
An example of this is shown below:
https://svc.blockdaemon.com/nft/v1/{protocol}/{network}/collection/{id}
Note: If you created your Ubiquity API Key before September 2022, add the legacy Ubiquity NFT URL:
ubiquity.api.blockdaemon.com/nft/v1
An example of this is shown below:
https://ubiquity.api.blockdaemon.com/nft/v1/{protocol}/{network}/collection/{id}
Path Parameters
You should specify a protocol and a network as path parameters, e.g.:
ethereum/mainnet
You can also specify a unique collection ID as the last path parameter, e.g.:
4203aedd-7964-5fe1-b932-eb8c4fda7822
Notes:
- Collection IDs are returned by GET All NFT Collections in the
id
field. - This parameter is required unless you get a collection by contract address (query parameter).
Query Parameters
Required Parameters
To get a collection by contract address, use the following parameter:
- parameter:
contract_address
- value: e.g.
0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D
Note: This parameter is required unless you get a collection by unique ID (path parameter).
Example Queries
The queries in this section provide useful examples for GET NFT Collection.
For more details, visit:
Get a Collection by Unique ID
To get a collection in the Ethereum Mainnet network by unique collection ID, use the following query:
https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/collection/4203aedd-7964-5fe1-b932-eb8c4fda7822
Get a Collection by Contract Address
To get a collection in the Ethereum Mainnet network by contract address, use the following query:
https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/collection?contract_address=0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D
Example Response
The following is a typical response from GET NFT Collection:
{
"collection": {
"id": "4203aedd-7964-5fe1-b932-eb8c4fda7822",
"name": "Bored Ape Yacht Club",
"description": "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.",
"logo": "media/collection/4203aedd-7964-5fe1-b932-eb8c4fda7822/logo.png",
"banner": "",
"verified": true,
"contracts": [
{
"address": "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
"name": "BoredApeYachtClub",
"symbol": "BAYC",
"description": "",
"image_url": "",
"type": "ERC721"
}
],
"meta": {
"discord_url": "https://discord.gg/3P5K3dzgdB",
"external_url": "http://www.boredapeyachtclub.com/",
"twitter_username": "BoredApeYC"
},
"sub_collection": []
}
}
Notes:
- One collection can include multiple contracts, so the
contracts
field returns an array. - Some collections, e.g. Art Blocks, contain subcollections. See the
sub_collection
section. For each subcollection itsid
andname
are returned. - If a collection is part of another collection, the
parent_id
field returns the ID of its parent. - For the top popular collections, media paths and metadata are returned:
logo
andbanner
: media associated with a collectioncontracts
.image_url
: media associated with a contractmeta
: metadata
- Use the following endpoint to retrieve media: GET NFT Media