Historical balances

Get historical token balances

get

Returns a list of token balances at the end of the specified block. Note, this endpoint is quite heavy, therefore at least one of the filters (account, token.id, token.contract with token.tokenId) must be specified.

Path parameters

levelinteger · int32Required

Level of the block at the end of which historical balances must be calculated

Query parameters

accountone of | nullableOptional

Filter by account address.
Click on the parameter to expand more details.

token.idone of | nullableOptional

Filter by internal TzKT id. Note, this is not the same as tokenId.
Click on the parameter to expand more details.

token.contractone of | nullableOptional

Filter by contract address.
Click on the parameter to expand more details.

token.tokenIdone of | nullableOptional

Filter by tokenId (for FA1.2 tokens tokenId is always "0").
Click on the parameter to expand more details.

token.standardone of | nullableOptional

Filter by token standard (fa1.2 or fa2).
Click on the parameter to expand more details.

token.metadataone of | nullableOptional

Filter by metadata. Note, this parameter supports the following format: token.metadata{.path?}{.mode?}=..., so you can specify a path to a particular field to filter by, for example: ?token.metadata.symbol.in=kUSD,uUSD.
Click on the parameter to expand more details.

balanceone of | nullableOptional

Filter by balance.
Click on the parameter to expand more details.

sortone of | nullableOptional

Sorts items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.

offsetone of | nullableOptional

Specifies which or how many items should be skipped.
Click on the parameter to expand more details.

limitinteger · int32 · max: 10000Optional

Maximum number of items to return.

selectone of | nullableOptional

Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection (for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.

Responses

application/json

object[]Optional

get

HTTPcURLJavaScriptPython

GET /v1/tokens/historical_balances/{level} HTTP/1.1
Host: xtz-index.nownodes.io
Accept: */*

200Success

[
  {
    "account": {
      "alias": "text",
      "address": "text"
    },
    "token": {
      "id": 1,
      "contract": {
        "alias": "text",
        "address": "text"
      },
      "tokenId": "text",
      "standard": "text",
      "totalSupply": "text",
      "metadata": null
    },
    "balance": "text"
  }
]