---
title: "Get NFT rarity"
method: GET
path: "/v1/nft/rarity"
tags: ["NFT Metadata"]
---

# Get NFT rarity

`GET /v1/nft/rarity`

## Query parameters

- `chain_id` string, required — chain network id, see [list of details](/platform/features/api/web3-api)
- `contract_address` string, required — The address of the NFT contract
- `token_id` string — NFT token id in hex or num string
- `rank_min` integer
- `rank_max` integer
- `page` integer — The page offset
- `limit` integer

## Headers

- `x-api-key` string, required

## Response `200`

Successful Response

- ResponseNFTRarity
  - `code` integer
  - `message` string
  - `data` NFTRarity[]
    - `token_id` string, required
    - `rank` integer, required
    - `rank_share` integer, required
    - `score` number, required
    - `total_supply` integer, required
    - `properties` NFTRarityProperties[]
      - `trait_type` string, required
      - `value` string, required
      - `rate` number, required
      - `total` integer, required
  - `next_page` integer
  - `count` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.dev/chainbase/apis/data-cloud-task-api.md) · [All operations](https://skmtc.dev/chainbase/apis/data-cloud-task-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/chainbase/data-cloud-task-api/revisions/4013781aa422/schema)