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

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

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.

To filter the results by collection name, use:

• parameter: collection_name
• value: e.g. Bored Ape Yacht Club

To filter the results by contract address, use:

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

To filter the results by token type, use:

• parameter: token_type
• value: ERC721 / ERC1155 / ERC20 / CRYPTOPUNKS

Notes:

• You can combine these parameters to further filter the results.
• You can filter by multiple collection names, contract addresses, or token types. Just add multiple collection_name / contract_address / token_type parameters with different values.
• The collection_name filter is case sensitive. If you are not sure about the exact spelling of a collection name, use the following endpoint to find it: GET NFT Collections Search by Name

To get only verified collections, use the following parameter:

• parameter: verified
• value: true
  (see the verified section of the response)

To sort the results, use

• parameter: sort_by
• value: name

To set the sort order, use

• parameter: order
• value: asc / desc

To set the maximum number of collections 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 All NFT Collections.

For more examples and details, visit: NFT Tutorials: Collections

Get All Collections

For a list of all collections in the Ethereum Mainnet network, use the following query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/collections

Get Collections Filtered by Collection Name

For a list of Ethereum Mainnet collections filtered by given collection names, use the following query:

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

Get Collections Filtered by Contract Address

For a list of Ethereum Mainnet collections filtered by given contract addresses, use the following query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/collections?contract_address=0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D&contract_address=0xb47e3cd837dDF8e4c57F05d70Ab865de6e193BBB

Get Collections Filtered by Token Type

For a list of Ethereum Mainnet collections filtered by given token types (ERC-721 and ERC-1155), use the following query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/collections?token_type=ERC721&token_type=ERC1155

Get Collections Sorted by Name

For a list of Ethereum Mainnet collections sorted by name in descending order, use the following query:

https://svc.blockdaemon.com/nft/v1/ethereum/mainnet/collections?sort_by=name&order=desc

Example Response

The following is a typical response from GET All NFT Collections:

{
    "data": [
        {
            "id": "4203aedd-7964-5fe1-b932-eb8c4fda7822",
            "name": "Bored Ape Yacht Club",
            "logo": "collection/4203aedd-7964-5fe1-b932-eb8c4fda7822/logo.png",
            "contracts": [
                "0xBC4CA0EdA7647A8aB7C2061c2E118A18a936f13D"
            ],
            "verified": true
        },
        {...more collections...}
    ],
    "meta": {
        "paging": {
            "next_page_token": ""
        }
    }
}

Notes:

• One collection can include multiple contracts, so the contracts field returns an array.
• The logo field returns media paths for the top popular collections. Use the following endpoint to retrieve media: GET NFT Media