Skip To Content

Blockdaemon Documentation

GET NFT Assets

GET NFT Assets
Ubiquity NFT URL
Path Parameters
Query Parameters
Example Queries
Example Response


GET NFT Assets

https://{ubiquity_nft_url}/{protocol}/{network}/assets

Returns NFT assets by a given collection, contract, or wallet (see required parameters).

The response is paginated — use a query parameter to get the next page. To display wallets (NFT owners), add the following query parameter: show_wallets=true

Developer documentation: GET NFT Assets
Learn how to authorize your request: Authentication Guide

Notes:

  • 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.
  • To get more information about a particular asset, use GET NFT Asset.

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}/assets

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}/assets

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 collection ID, use:

  • parameter: collection_id
  • value: e.g. 4203aedd-7964-5fe1-b932-eb8c4fda7822

Collection IDs are returned by GET All NFT Collections in the id field.

3. To get assets by contract address, use:

  • parameter: contract_address
  • value: e.g. 0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D

4. 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 the attributes section of the response returned by GET NFT Asset )

Note: You can filter by multiple attributes: just add multiple attributes parameters with different values. This filter is case insensitive.

To show or hide wallets, use:

  • parameter: show_wallets
  • value: true / false (default)

To show or hide burned tokens, use:

  • parameter: include_burned
  • value: true / false (default)

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 100

To get the next page, use

  • parameter: page_token
  • value: returned in the next_page_token field

Example Queries

The queries in this section provide useful examples for GET NFT Assets.

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 query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/assets?collection_name=Bored Ape Yacht Club

Get Assets by Collection ID

To get a list of Ethereum Mainnet assets by a given collection ID, use the following query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/assets?collection_id=4203aedd-7964-5fe1-b932-eb8c4fda7822

To get a list of Ethereum Mainnet assets by a given collection name and include wallets, use the following query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/assets?collection_name=Bored Ape Yacht Club&show_wallets=true

Get Assets by Contract Address

To get a list of Ethereum Mainnet assets by a given contract address, use the following query:

https://svc.blockdaemon.com/nft/v1/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 query:

https://svc.blockdaemon.com/nft/v1/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 query:

https://svc.blockdaemon.com/nft/v1/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 query:

https://svc.blockdaemon.com/nft/v1/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 query:

https://svc.blockdaemon.com/nft/v1/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 query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/assets?collection_name=Bored Ape Yacht Club&attributes=Background:Purple&attributes=Fur:Gray

This query finds all NFTs with purple background and gray fur. Its response does not contain attributes, but you can query an asset with GET NFT Asset and see the specified attributes in the attributes section of the response:

"attributes": [
    {
        "trait_type": "Background",
        "value": "Purple"
    }
    {
        "trait_type": "Fur",
        "value": "Gray"
    },
    {...more attributes...}
]

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 query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/assets?contract_address=0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D&sort_by=token_id&order=asc

Example Response

The following is a typical response from GET NFT Assets:

{
    "data": [
        {
            "id": "5e1f4454-34ff-5118-9987-96b481625128",
            "token_id": "9999",
            "image_url": "token/0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D/5e1f4454-34ff-5118-9987-96b481625128.png",
            "name": "#9999",
            "contract_address": "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D",
            "wallets": [],
            "burned": false
        },
        {...more assets...}
    ],
    "meta": {
        "paging": {
            "next_page_token": "eyJ0b2tlbl9pZCI6OTgyOCwidWlkIjoiNjMzOWIzMWYtNjg1Yi01ZDA1LWIyNmYtNDliNTc2M2E0ZDUzIn0="
        }
    }
}

Notes:

  • To find the NFT owner’s address, see the wallets field. ERC-1155 tokens can be owned by multiple wallets, so this field returns an array. Wallets are displayed only if you use the following query parameter: show_wallets=true.
  • The image_url field returns media paths for the top popular collections. Use the following endpoint to retrieve media: GET NFT Media

We don't support Internet Explorer

Please use Chrome, Safari, Firefox, or Edge to view this site.