tokens

List token balances

Changed on

Returns a list of token balances given the id. This represents the Token supply distribution across the network

get/api/v1/tokens/{tokenId}/balances

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/tokens/{tokenId}/balances
  • Auth
    none declared

Path parameters

tokenIdstring nullable required

Network entity ID in the format of shard.realm.num

Example:0.0.2

Token id

Query parameters

account.balancestring

The optional balance value to compare against

account.idstring

The ID of the account to return information for

account.publickeystring

The account's public key to compare against

limitinteger

The maximum number of items to return

order'asc' | 'desc'

The order in which items are listed

timestampstring[]

The consensus timestamp as a Unix timestamp in seconds.nanoseconds format with an optional comparison operator. See unixtimestamp.com for a simple way to convert a date to the 'seconds' part of the Unix time.

Response

OK

timestampstring nullable

A Unix timestamp in seconds.nanoseconds format

Example response

{
  "timestamp": "1586567700.453054000",
  "balances": [
    {
      "account": "0.15.2",
      "balance": 1000,
      "decimals": 3
    }
  ]
}

Changes

  • v106a98b556c72Revision changes
    • warning

      changed the pattern of the query request parameter account.balance from ^((gte?|lte?|eq|ne)\:)?\d{1,10}$ to ^((gte?|lte?|eq|ne)\:)?\d{1,19}$

  • v18ce3e9a7251eRevision changes
    • breaking

      the response property // became nullable for the status