Contracts

Get bigmap key

Returns the specified bigmap key.

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

Request

  • Base URL
    https://api.tzkt.io
  • URL
    https://api.tzkt.io/v1/contracts/{address}/bigmaps/{name}/keys/{key}
  • 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

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

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

Response

idinteger

Internal Id, can be used for pagination

activeboolean

Bigmap key status (true - active, false - removed)

hashstring required

Key hash

keyunknown required
valueunknown required
firstLevelinteger

Level of the block where the bigmap key was seen first time

lastLevelinteger

Level of the block where the bigmap key was seen last time

updatesinteger

Total number of actions with the bigmap key

Changes

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