Skip to main content

GET nfts

/v1/nfts​

Get the volume of transactions that happened in a given collection.

Limit

/v1/nfts?limit={maxNumber}

Get only the amount of nfts you need by informing the amount through the query limit parameter.

Range: 0 → 350

The default value of limit is 50, if you don't specify a value, this value be adopted.

Offset

/v1/nfts?offset={numToAvoid}

Offset ignores the desired amount of nfts starting from 1 to offset. That is, if you want to skip the first 100 nfts, the offset will be set to offset 100.

The default value of offset is 0, if you don't specify a value, 0 will be adopted.

Queries

You can filter transactions to get more specific results.

1. Owner address​

/v1/nfts?owner_address={0xaddress}

It only returns NFT referring to a specific wallet.

2. NFT ID​

/v1/nfts?id={id}

It only return the NFT by id.

3. Collection name​

/v1/nfts?collection_name={name}

Filter NFTs by the collection name.

4. Collection display name​

/v1/nfts?collection_display_name={value}

Filter NFTs by the collection display name.

5. Index​

/v1/nfts?index={value}

Filter NFTs by index. Multiple indices are allowed

6. Trait​

/v1/nfts?trait={value}

Filter NFTs by its traits. Multiple traits are allowed.

Order

1. Order by​

/v1/nfts?oder_by={order}

Possible values:

  • id
  • index
  • nft_name
  • collection_name
  • collection_display_name
  • blockchain
  • last_price
  • ranking
  • rarity_score
  • meta_score
  • adjusted_ranking
  • adjusted_score
  • adjusted_rarity_score
  • adjusted_meta_score

2. Order direction​

/v1/nfts?order_direction={order}

Define the ordering direction of the response with the list of collections.

Possible values:

  1. asc → represents an order that starts at the lowest value and ends at the highest reference value
  2. desc → represents an order that starts at the highest value and ends at the lowest reference value

The default value of order_direction is asc , if you don't specify a value, this value will be adopted.

Note: Values are case-insensitive

Interval

Specify a time interval and receive the total amount of transactions in the interval you entered, which can be in hours, days or months. Only one interval is allowed.

1. Hours​

/v1/nfts?interval_hours={number}

2. Days​

/v1/nfts?interval_days={number}

3. Months​

/v1/nfts?&interval_months={number}

Expected return

An array of NFTs.

{
  "response": [
    {
      "rarity_score": 36.65,
      "meta_score": 0,
      "score": 36.65,
      "ranking": 208,
      "adjusted_meta_score": 0,
      "adjusted_rarity_score": 6428,
      "adjusted_score": 6428,
      "adjusted_ranking": 17,
      "matches": [],
      "nft_id": "1",
      "nft_index": 1,
      "collection_name": "curiocardswrapper",
      "collection_display_name": "My Curio Cards",
      "blockchain": "Ethereum",
      "website_link": null,
      "name": "Apples",
      "image": "https://lh3.googleusercontent.com/2OsEd7moIzM7K4-3F9xeHZTqjy-G0wAXDI5ExWs8ykSmvdpNqwhDaza9ga8DXMZeNtz0JAHLhB8ejwfgOjJPcZVwV67_FWqnZD0aiQU",
      "owner": "0x7055d2b309057d3396f7d005c8e1d61269b993a0",
      "last_price": "1750000000000000000"
    }
  ],
  "paging": {
    "total": 30,
    "pages": 1,
    "page": 1
  }
}
Errors

400 Invalid Request​

Your request is malformed. Please, check the documentation out.

401 API key is invalid​

You did not pass the API key for getting authorization.

404 Data not found​

Your request returned with no matches.

429 Too many requests​

You are hiting the API request limit.

500 Internal server error​

The server did not know how to handle this error.