Accounts

Get balance history

Returns time series with historical balances* (only changes, without duplicates).
* - for non-baker tz-accounts historical balances do not include staked tez, because stakers do not really have staked tez on their balance, they have staking pseudotokens instead. If you want to get a full historical balance, including staked tez, use the Tezos node RPC: /chains/main/blocks/{level}/context/contracts/{address}/full_balance.

get/v1/accounts/{address}/balance_history

Request

  • Base URL
    https://api.tzkt.io
  • URL
    https://api.tzkt.io/v1/accounts/{address}/balance_history
  • Auth
    none declared

Path parameters

addressstring required

Account address (starting with tz or KT)

Query parameters

stepinteger nullable

Step of the time series, for example if step = 1000 you will get balances at blocks 1000, 2000, 3000, ....

fieldsstring[] nullable

Fields selection mode (optional, i.e. select.fields=balance is the same as select=balance).
Specify a comma-separated list of fields to include into response.

Example: ?select=address,balance => [ { "address": "asd", "balance": 10 } ].

valuesstring[] nullable

Values selection mode.
Specify a comma-separated list of fields to include their values into response.

Example: ?select.values=address,balance => [ [ "asd", 10 ] ].

Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both .fields and .values modes.

ascstring nullable

Ascending sort mode (optional, i.e. sort.asc=id is the same as sort=id).
Specify a field name to sort by.

Example: ?sort=balance.

descstring nullable

Descending sort mode.
Specify a field name to sort by descending.

Example: ?sort.desc=id.

Sorts historical balances by specified field. Supported fields: level.

offsetinteger

Specifies which or how many items should be skipped

limitinteger

Maximum number of items to return

quote'None' | 'Btc' | 'Eur' | 'Usd' | 'Cny' | 'Jpy' | 'Krw' | 'Eth' | 'Gbp'

Comma-separated list of ticker symbols to inject historical prices into response

Response

levelinteger

Height of the block at which the account balance was calculated

timestampstring date-time

Timestamp of the block at which the account balance was calculated

balanceinteger

Historical balance

Changes

No recorded changes to this operation across all 1 revision of this API.