Search NFTs

Get NFTs that match a given metadata search query.

Search NFTs

get

Get NFTs that match a given metadata search query.

Query parameters

from_blockintegerOptional

The minimum block number from which to start the search

Default: 0

to_blockintegerOptional

The maximum block number from which to end the search

Default: 0

chainall ofRequired

The chain to query

string · enumOptional

An enumeration.

Possible values:

formatall ofOptional

The format of the token ID

Default: decimal

string · enumOptional

An enumeration.

Possible values:

qstring · min: 3 · max: 256Required

The search string

filterall ofOptional

What fields the search should match on. To look into the entire metadata set the value to "global". To have a better response time you can look into a specific field like name

Default: name

string · enumOptional

An enumeration.

Possible values:

addressesstring[]Optional

The addresses to get metadata for

Default: []

Responses

200

Successful Response

application/json

404

ErrorMessage

application/json

422

HTTPValidationError

application/json

get

HTTPcURLJavaScriptPython

GET /api/nfts/search?chain=eth&q=text HTTP/1.1
Host: 
Accept: */*

{
  "status": "SYNCING",
  "total": 1,
  "page": 1,
  "page_size": 1,
  "cursor": "text",
  "result": [
    {
      "token_address": "text",
      "name": "text",
      "symbol": "text",
      "contract_type": "text",
      "token_id": "text",
      "amount": "text",
      "token_hash": "text",
      "owner_of": "text",
      "block_number_minted": "text",
      "block_number": "text",
      "token_uri": "text",
      "last_token_uri_sync": "text",
      "last_metadata_sync": "text",
      "minter_address": "text",
      "metadata": {
        "name": "text",
        "description": "text",
        "image": "text",
        "external_url": "text",
        "animation_url": "text",
        "attributes": [
          {
            "trait_type": "text",
            "display_type": "text",
            "max_value": 1,
            "trait_count": 1,
            "order": 1,
            "value": "text"
          }
        ]
      }
    }
  ]
}