tokens

List token balances

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

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

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

Changed in 2 of the 53 revisions of this API.6

    • the response property balances/items/decimals became nullable for the status 200

      response-property-became-nullable

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

      response-property-became-nullable

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

      response-property-became-nullable

    • the response property balances/items/account became nullable for the status 200

      response-property-became-nullable

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

      response-property-became-nullable

    • the response property timestamp 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