Contracts

Get bigmap key updates

Returns updates history for the specified bigmap key.

get/v1/contracts/{address}/bigmaps/{name}/keys/{key}/updates

Request

  • Base URL
    https://api.tzkt.io
  • URL
    https://api.tzkt.io/v1/contracts/{address}/bigmaps/{name}/keys/{key}/updates
  • Auth
    none declared

Path parameters

addressstring required

Contract address

namestring required

Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is ledger or assets.ledger, then the name is ledger. If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.

keystring required

Either a key hash (expr123...) or a plain value (foo...). Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.

Query parameters

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 bigmap updates by specified field. Supported fields: id (default).

elinteger nullable

Elements offset mode (optional, i.e. offset.el=123 is the same as offset=123).
Skips specified number of elements.

Example: ?offset=100.

pginteger nullable

Page offset mode.
Skips page * limit elements. This is a classic pagination.

Example: ?offset.pg=1.

crinteger nullable

Cursor offset mode.
Skips all elements with the cursor before (including) the specified value. Cursor is a field used for sorting, e.g. id. Avoid using this offset mode with non-unique or non-sequential cursors such as amount, balance, etc.

Example: ?offset.cr=45837.

Specifies which or how many items should be skipped

limitinteger

Maximum number of items to return

micheline'Json' | 'JsonString' | 'Raw' | 'RawString'

Format of the key value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string

Response

idinteger

Internal Id, can be used for pagination

levelinteger

Level of the block where the bigmap key was updated

timestampstring date-time

Timestamp of the block where the bigmap key was updated

actionstring required

Action with the key (add_key, update_key, remove_key)

valueunknown required

Changes

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