BigMaps

Get bigmap key

Returns the specified bigmap key.

get/v1/bigmaps/{id}/keys/{key}

Path parameters

idinteger required

Bigmap Id

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

{"stackTrail":"components:schemas:BigMapKey:properties:key","oasType":"schema","type":"unknown","description":"Key in JSON or Micheline format, depending on the `micheline` query parameter."}

{"stackTrail":"components:schemas:BigMapKey:properties:value","oasType":"schema","type":"unknown","description":"Value in JSON or Micheline format, depending on the `micheline` query parameter.\nNote, if the key is inactive (removed) it will contain the last non-null value."}

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 endpoint across all 1 revision of this API.