Get Token Balances

List token balances.

This method will use 20 Compute Units.

---

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 | nullablerequired

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

Example: 0.1.2

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Query parameters

account.balancestring

The optional balance value to compare against

Example: {"summary":"--","value":""}

Pattern: ^((gte?|lte?|eq|ne)\:)?\d{1,10}$

account.idstring

The ID of the account to return information for

Example: {"summary":"--","value":""}

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

account.publickeystring

The account's public key to compare against

Example: 3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be

limitinteger · int32 · min: 1 · max: 100 · default: 25

The maximum number of items to return

Example: 2

orderundefined · enum · default: asc

The order in which items are listed

Example: desc

Options: asc, desc

timestampstring[]

The consensus timestamp in seconds.nanoseconds format with an optional comparison operator

Example: {"summary":"--","value":""}

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/tokens/{tokenId}/balances'

200

400

200

{
  "timestamp": "1586567700.453054000",
  "balances": [
    {
      "account": "0.15.2",
      "balance": 1000
    }
  ],
  "links": {
    "next": "/api/v1/transactions?timestamp=lt:1657598275.517984411"
  }
}

OK