Sign in

v1

latestOpenAPI 3.0.32026-07-2639188178.2 KB
nfts

Get list of NFTs

This endpoint returns list of NFTs by using different parameters.

It returns NFTs of both types - ERC721 and ERC1155.

This endpoint supports testnets. To get data for testnets use X-Env header.

NOTE: Consider all IDs as abstract strings, without making any assumptions about their format or relying on such assumptions. There is a non-zero probability that IDs may change in the future, and this should not result in any breaking changes.

get/v1/nfts/

Query parameters

filter[references]string
Example:ethereum:0x932261f9fc8da46c4a22e31b45c4de60623848bf:93673,polygon:0x3d8c06e65ebf06a9d40f313a35353be06bd46038:104901

Keep only NFTs matching specified references.

Reference format is chain_id:contract_address:token_id.

References should be separated by comma ,.

chain_id- ID of the chain where NFT exists, can be found in /chains endpoint.

contract_address address of the deployed contract which NFT belongs to.

token_id id of the NFT withing specified contract_address.

NOTE: parameter currently is mandatory and can not be omitted.

currency'eth' | 'btc' | 'usd' | 'eur' | 'krw' | 'rub' | 'gbp' | 'aud' | 'cad' | 'inr' | 'jpy' | 'nzd' | 'try' | 'zar' | 'cny' | 'chf'

Denominated currency value of returned prices

includestring[]

Array of related resources to be included to the response (comma-separated list). This parameter corresponds to the JSON API schema.

[
  "nft_collections"
]

Headers

X-Env'testnet'

Custom header that allows you to get data for testnets.

Response

Response for requested list of NFTs

Example response

{
  "links": {
    "self": "https://api.zerion.io/v1/nfts/?currency=usd&filter%5Breferences%5D=ethereum%3A0x909899c5dbb5002610dd8543b6f638be56e3b17e%3A57896044618658097711785492504343953928676686534345912800509039648547174119787%2Cpolygon%3A0x3a422450db73c450310e6e24191d4221a5be81b1%3A30&include=nft_collections"
  },
  "data": [
    {
      "type": "nfts",
      "attributes": {
        "contract_address": "0x74ee68a33f6c9f113e22b3b77418b75f85d07d22",
        "token_id": "10",
        "interface": "erc1155",
        "metadata": {
          "content": {
            "preview": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "detail": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "audio": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            },
            "video": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            }
          },
          "attributes": [
            {
              "key": "Rarity",
              "value": "common"
            }
          ]
        },
        "market_data": {
          "last_sale": {
            "price": 31,
            "quantity": {
              "int": "12345678",
              "decimals": 5,
              "float": 123.45678,
              "numeric": "123.45678"
            }
          }
        },
        "external_links": [
          {
            "type": "website",
            "name": "Website",
            "url": "https://www.indexcoop.com"
          }
        ]
      },
      "relationships": {
        "chain": {
          "links": {
            "related": "https://api.zerion.io/v1/chains/polygon"
          },
          "data": {
            "type": "chains",
            "id": "polygon"
          }
        },
        "nft_collection": {
          "data": {
            "type": "nft_collections",
            "id": 14
          }
        }
      }
    }
  ],
  "included": [
    {
      "type": "nft_collections",
      "id": 14,
      "attributes": {
        "metadata": {
          "content": {
            "icon": {
              "url": "https://token-icons.s3.amazonaws.com/0x0391d2021f89dc339f60fff84546ea23e337750f.png"
            },
            "banner": {
              "url": "https://token-icons.s3.amazonaws.com/0x1494ca1f11d487c2bbe4543e90080aeba4ba3c2b.png",
              "content_type": "image/png"
            }
          }
        },
        "implementations": [
          {
            "chain_id": "ethereum",
            "address": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d"
          }
        ]
      }
    }
  ]
}