Get NFT items

Returns NFT items matching the specified filters. Filter by item address, owner address, collection address, or item index. Use include_on_sale to include items listed on marketplaces. When querying multiple collections, provide exactly one owner_address.

GET /api/v3/nft/items

Get NFT items

cURL

curl --request GET \
  --url https://toncenter.com/api/v3/nft/items

200

{
  "address_book": {},
  "metadata": {},
  "nft_items": [
    {
      "address": "<string>",
      "auction_contract_address": "<string>",
      "code_hash": "<string>",
      "collection": {
        "address": "<string>",
        "code_hash": "<string>",
        "collection_content": {},
        "data_hash": "<string>",
        "last_transaction_lt": "0",
        "next_item_index": "<string>",
        "owner_address": "<string>"
      },
      "collection_address": "<string>",
      "content": {},
      "data_hash": "<string>",
      "index": "<string>",
      "init": true,
      "last_transaction_lt": "0",
      "on_sale": true,
      "owner_address": "<string>",
      "real_owner": "<string>",
      "sale_contract_address": "<string>"
    }
  ]
}

Query Parameters

address · string[]

NFT item address in any form. Max: 1000.

owner_address · string[]

Address of NFT item owner in any form. Max: 1000.

collection_address · string[]

Collection address in any form.

index · string[]

Index of item for given collection. Max: 1000.

include_on_sale · boolean · default: false

Include nft on sales and auctions. Used only when owner_address is passed

sort_by_last_transaction_lt · boolean

Sort NFT items by last transaction lt descending. Warning: results may be inconsistent during pagination with limit and offset.

limit · integer<int32> · default: 10

Limit number of queried rows. Use with offset to batch read.

Required range: 1 <= x <= 1000

offset · integer<int32> · default: 0

Skip first N rows. Use with limit to batch read.

Required range: x >= 0

Response

200

application/json

Matching NFT items with address book and metadata.

Response wrapper containing NFT items with address book and token metadata.

address_book · object

Address book mapping raw addresses to user-friendly forms for all addresses referenced in the response.

Show child attributes

metadata · object

Token and indexing metadata for all addresses referenced in the response.

Show child attributes

nft_items · object[]

Array of NFT items matching the query filters.

Show child attributes