Get Balances

List account balances.

This method will use 15 Compute Units.

List account balances

Returns a timestamped list of account balances on the network, limited to at most 50 token balances per account as outlined in HIP-367. This includes both HBAR and token balances for accounts.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/balances

Query parameters

account.idstring

Account id or account alias with no shard realm or evm address with no shard realm

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

account.balancestring

The optional balance value to compare against

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

account.publickeystring

The account's public key to compare against

Example: "3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be"

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

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

itemsstring

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

Response

Body

timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

balancesarray of AccountBalance (object)

account*nullable EntityId (string)

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

Example: "0.1.2"

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

balance*integer (int64)

tokens*array of TokenBalance (object)

token_id*nullable EntityId (string)

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

Example: "0.1.2"

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

balance*integer (int64)

linksLinks (object)

nextnullable string

Example: "/api/v1/transactions?timestamp=lt:1657598275.517984411"

Request

Response

List account balances

Returns a timestamped list of account balances on the network, limited to at most 50 token balances per account as outlined in HIP-367. This includes both HBAR and token balances for accounts.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/balances

Query parameters

account.idstring

Account id or account alias with no shard realm or evm address with no shard realm

Pattern: ^(\d{1,10}\.){0,2}(\d{1,10}|(0x)?[A-Fa-f0-9]{40}|(?:[A-Z2-7]{8})*(?:[A-Z2-7]{2}|[A-Z2-7]{4,5}|[A-Z2-7]{7,8}))$

account.balancestring

The optional balance value to compare against

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

account.publickeystring

The account's public key to compare against

Example: "3c3d546321ff6f63d701d2ec5c277095874e19f4a235bee1e6bb19258bf362be"

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "asc"

ascdesc

timestamparray of string

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

itemsstring

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

Response

Body

timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

balancesarray of AccountBalance (object)

account*nullable EntityId (string)

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

Example: "0.1.2"

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

balance*integer (int64)

tokens*array of TokenBalance (object)

token_id*nullable EntityId (string)

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

Example: "0.1.2"

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

balance*integer (int64)

linksLinks (object)

nextnullable string

Example: "/api/v1/transactions?timestamp=lt:1657598275.517984411"

Request

Response