accounts

Get nfts for an account info

Returns information for all non-fungible tokens for an account.

Ordering

When considering NFTs, their order is governed by a combination of their numerical token.Id and serialnumber values, with token.id being the parent column. A serialnumbers value governs its order within the given token.id

In that regard, if a user acquired a set of NFTs in the order (2-2, 2-4 1-5, 1-1, 1-3, 3-3, 3-4), the following layouts illustrate the ordering expectations for ownership listing

  1. All NFTs in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
  2. All NFTs in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3, 1-1
  3. NFTs above 1-1 in ASC order: 1-3, 1-5, 2-2, 2-4, 3-3, 3-4
  4. NFTs below 3-3 in ASC order: 1-1, 1-3, 1-5, 2-2, 2-4
  5. NFTs between 1-3 and 3-3 inclusive in DESC order: 3-4, 3-3, 2-4, 2-2, 1-5, 1-3

Note: The default order for this API is currently DESC

Filtering

When filtering there are some restrictions enforced to ensure correctness and scalability.

The table below defines the restrictions and support for the NFT ownership endpoint

Query ParamComparison OperatorSupportDescriptionExample
token.ideqYSingle occurrence only.?token.id=X
neN
lt(e)YSingle occurrence only.?token.id=lte:X
gt(e)YSingle occurrence only.?token.id=gte:X
serialnumbereqYSingle occurrence only. Requires the presence of a token.id query?serialnumber=Y
neN
lt(e)YSingle occurrence only. Requires the presence of an lte or eq token.id query?token.id=lte:X&serialnumber=lt:Y
gt(e)YSingle occurrence only. Requires the presence of an gte or eq token.id query?token.id=gte:X&serialnumber=gt:Y
spender.ideqY?spender.id=Z
neN
lt(e)Y?spender.id=lt:Z
gt(e)Y?spender.id=gt:Z

Note: When searching across a range for individual NFTs a serialnumber with an additional token.id query filter must be provided. Both filters must be a single occurrence of gt(e) or lt(e) which provide a lower and or upper boundary for search.

get/api/v1/accounts/{idOrAliasOrEvmAddress}/nfts

Path parameters

idOrAliasOrEvmAddressstring required

Account alias or account id or evm address

Query parameters

limitinteger

The maximum number of items to return

order'asc' | 'desc'

The order in which items are listed

serialnumberstring

The nft serial number (64 bit type). Requires a tokenId value also be populated.

spender.idstring

The ID of the spender to return information for

token.idstring

The ID of the token to return information for

Response

OK

Example response

{
  "nfts": [
    {
      "account_id": "0.1.2",
      "created_timestamp": "1234567890.000000001",
      "delegating_spender": "0.0.400",
      "deleted": false,
      "metadata": "VGhpcyBpcyBhIHRlc3QgTkZU",
      "modified_timestamp": "1610682445.003266001",
      "serial_number": 124,
      "spender_id": "0.0.500",
      "token_id": "0.0.222"
    }
  ]
}

Changes

Changed in 1 of the 53 revisions of this API.11

    • the response property _status/messages/items/data became nullable for the status 400

      response-property-became-nullable

    • the response property _status/messages/items/data became nullable for the status 404

      response-property-became-nullable

    • the response property _status/messages/items/detail became nullable for the status 400

      response-property-became-nullable

    • the response property _status/messages/items/detail became nullable for the status 404

      response-property-became-nullable

    • the response property links/next became nullable for the status 200

      response-property-became-nullable

    • the response property nfts/items/account_id became nullable for the status 200

      response-property-became-nullable

    • the response property nfts/items/created_timestamp became nullable for the status 200

      response-property-became-nullable

    • the response property nfts/items/delegating_spender became nullable for the status 200

      response-property-became-nullable

    • the response property nfts/items/modified_timestamp became nullable for the status 200

      response-property-became-nullable

    • the response property nfts/items/spender became nullable for the status 200

      response-property-became-nullable

    • the response property nfts/items/token_id became nullable for the status 200

      response-property-became-nullable

    This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog