Blockdaemon Documentation
GET NFT Assets
GET NFT Assets (V1)
Path Parameters
Query Parameters
Example Queries
Example Response
GET NFT Assets (V1)
https://ubiquity.api.blockdaemon.com/v1/nft/{protocol}/{network}/assets
Returns NFT assets by a given collection, contract, or wallet (see required parameters).
Developer documentation: GET NFT Assets (V1)
Notes:
- To authorize your request, you need to get a Ubiquity API key and use it as a bearer token.
- 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.
Path Parameters
You should specify a protocol and a network as path parameters, e.g.:
ethereum/mainnet
Query Parameters
NFT API supports advanced querying options, making it easy to pinpoint the exact information you need. Use query parameters to filter, sort, and paginate the results.
Required Parameters
It is required to specify at least one of the three parameters listed below.
1. To get assets by collection name, use:
- parameter:
collection_name
- value: e.g.
Bored Ape Yacht Club
2. To get assets by contract address, use:
- parameter:
contract_address
- value: e.g.
0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D
3. To get assets by wallet address, use:
- parameter:
wallet_address
- value: e.g.
0x5682035b6b1D04924C7661b09A974fF0695De6bE
Note: You can combine these parameters with each other to further filter the results.
Additional Parameters
To filter your results by token ID, use the following parameter:
- parameter:
token_id
- value: e.g.
9999
Note: The query must include contract_address
.
To filter the results by token type, use:
- parameter:
token_type
- value:
ERC721
/ERC1155
/ERC20
/CRYPTOPUNKS
Note: You can filter by multiple token types, just add multiple token_type
parameters with different values.
To filter the results by attribute, use:
- parameter:
attributes
- value: a
key:value
pair, e.g.Background:Purple
(see thetraits
section of the response)
Note: You can filter by multiple attributes: just add multiple attributes
parameters with different values.
To sort the results, use
- parameter:
sort_by
- value:
name
/mint_date
/token_id
(default)
To set the sort order, use
- parameter:
order
- value:
asc
/desc
To set the maximum number of assets returned on one page, use
- parameter:
page_size
- value: 50 by default, up to 50
To get the next page, use
- parameter:
page_token
- value: returned in the
next_page_token
field
Example Queries
The following queries provide useful examples for GET NFT Assets (V1).
For more examples and details, visit NFT Tutorials: Assets.
Get Assets by Collection Name
To get a list of Ethereum Mainnet assets by a given collection name, use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?collection_name=Bored Ape Yacht Club
Get Assets by Contract Address
To get a list of Ethereum Mainnet assets by a given contract address, use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?contract_address=0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D
Get Assets by Wallet Address
To get a list of Ethereum Mainnet assets by a given wallet address, use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?wallet_address=0x5682035b6b1D04924C7661b09A974fF0695De6bE
Get Filtered Assets
To get a list of Ethereum Mainnet assets by a given contract address, filtered by a given wallet, use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?contract_address=0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D&wallet_address=0x46Fd6B647Dc8C82aD8f6cf0CC6b22ACad3f6e39d
To get a list of Ethereum Mainnet assets by a given contract address, filtered by a given token ID, use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?contract_address=0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D&token_id=9999
To get a list of Ethereum Mainnet assets by a given wallet address, filtered by a given token type (ERC-1155), use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?wallet_address=0x5682035b6b1D04924C7661b09A974fF0695De6bE&token_type=ERC1155
To get a list of Ethereum Mainnet assets by a given contract address, filtered by given attributes, use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?collection_name=Bored Ape Yacht Club&attributes=Background:Purple&attributes=Fur:Gray
You can find the specified attributes in the traits
section of the response. For example, the query above finds all NFTs with purple background and gray fur:
"traits": [
{
"type": "Background",
"value": "Purple"
}
{
"type": "Fur",
"value": "Gray"
},
{ ...more properties... }
]
Get Filtered and Sorted Assets
To get a list of Ethereum Mainnet assets by a given contract address, sorted by token ID in ascending order, use the following:
https://ubiquity.api.blockdaemon.com/v1/nft/ethereum/mainnet/assets?contract_address=0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D&sort_by=token_id&order=asc
Example Response
The following is a typical response from GET NFT Assets (V1):
{
"data": [
{
"token_id": "9999",
"image_url": "https://ubiquity.storage.blockdaemon.com/token/0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D/5e1f4454-34ff-5118-9987-96b481625128",
"name": "#9999",
"contract": {
"address": "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
"name": "BoredApeYachtClub",
"symbol": "BAYC",
"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.",
"image_url": "https://ubiquity.storage.blockdaemon.com/contract/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d/logo.png",
"type": "ERC721"
},
"wallets": [
{
"address": "0x46Fd6B647Dc8C82aD8f6cf0CC6b22ACad3f6e39d"
}
],
"attributes": [
{
"trait_type": "Hat",
"value": "Army Hat"
},
{
"trait_type": "Background",
"value": "Purple"
},
{
"trait_type": "Mouth",
"value": "Bored Unshaven"
},
{
"trait_type": "Earring",
"value": "Gold Hoop"
},
{
"trait_type": "Fur",
"value": "Gray"
},
{
"trait_type": "Eyes",
"value": "Scumbag"
}
],
"mint_date": "1619858117"
},
{...more assets...}
],
"meta": {
"paging": {
"next_page_token": "eyJ0b2tlbl9pZCI6OTg5OX0="
}
}
}
Notes:
- We currently support the ERC-721 and ERC-1155 NFT standards. You can check the standard in the
data
.type
field. - To find the NFT owner’s address, see the
data
.wallets
field. ERC-1155 tokens can be owned by multiple wallets, so it returns an array. - For assets from the top 100 popular collections, this endpoint additionally returns image URLs:
data
.image_url
: the image associated with an assetdata
.contract
.image_url
: the image associated with a contract
All images are stored by Blockdaemon, which allows you to quickly access them. The popularity of a collection is calculated from its total volume.