Get Nft Inventory Details

GET 
/api/v1/nfts/:tokenAddress/inventory-details

Free [5 Credits]

Retrieve the inventory details for a non-fungible-token.

Request

Path Parameters

tokenAddress stringrequired

token address

Query Parameters

keyword string

accountAddress or tokenId

page int32
Possible values: >= 1
Results page you want to retrieve (1..N)
Example: 1
size int32
Number of records per page, min: 1, Max: 2000
Example: 20

Responses

200

OK

*/*

Schema

Schema

results

object[]

required

Array [

contract_type Contract Type (string)required

Possible values: [ERC20, KIP7, KIP17, KIP37, ERC721, ERC1155, CONSENSUS_NODE, CUSTOM, UNKNOWN, UNKNOWN_]

Example: KIP17, KIP37

token_id Token ID (string)required

holder

object

required

address Address (string)required

account_type Account Type (string)

Possible values: [EOA, SCA, UNKNOWN]

Example: EOA, SCA

contract_type Contract Type (string)

Possible values: [ERC20, KIP7, KIP17, KIP37, ERC721, ERC1155, CONSENSUS_NODE, CUSTOM, UNKNOWN, UNKNOWN_]

Example: Token, NFT17, NFT37

symbol Token/NFT Symbol (string)

name Token/NFT Name (string)

icon Token/NFT Icon (string)

verified Token/NFT Verified Status (boolean)

kns_domain Kaia Name Service Domain (string)

address_label Address Label (string)

token_uri Token URI (string)required

token_count Token Count (integer)

metadata

object

id int64required

contract_address stringrequired

token_id integerrequired

metadata string

image string

image_data string

external_url string

description string

name string

animation_url string

youtube_url string

background_color string

display_image string

last_updated date-timerequired

]

paging

object

required

total_count int64required

current_page int32required

last booleanrequired

total_page int32required

property

object

property name* object

Example (from schema)

{
  "results": [
    {
      "contract_type": "KIP17, KIP37",
      "token_id": "string",
      "holder": {
        "address": "string",
        "account_type": "EOA, SCA",
        "contract_type": "Token, NFT17, NFT37",
        "symbol": "string",
        "name": "string",
        "icon": "string",
        "verified": true,
        "kns_domain": "string",
        "address_label": "string"
      },
      "token_uri": "string",
      "token_count": 0,
      "metadata": {
        "id": 0,
        "contract_address": "string",
        "token_id": 0,
        "metadata": "string",
        "image": "string",
        "image_data": "string",
        "external_url": "string",
        "description": "string",
        "name": "string",
        "animation_url": "string",
        "youtube_url": "string",
        "background_color": "string",
        "display_image": "string",
        "last_updated": "2025-04-16T01:16:41.340Z"
      }
    }
  ],
  "paging": {
    "total_count": 0,
    "current_page": 0,
    "last": true,
    "total_page": 0
  },
  "property": {}
}

Loading...