Contracts

Get bigmap by name

Returns contract bigmap with the specified name or storage path.

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

Request

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

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

ptrinteger

Bigmap pointer

pathstring required

Path to the bigmap in the contract storage

tagsstring[] nullable

List of tags ( metadata, token_metadata,ledger, or null if there are no tags)

activeboolean

Bigmap status (true - active, false - removed)

firstLevelinteger

Level of the block where the bigmap was seen first time

lastLevelinteger

Level of the block where the bigmap was seen last time

totalKeysinteger

Total number of keys ever added to the bigmap

activeKeysinteger

Total number of currently active keys

updatesinteger

Total number of actions with the bigmap

keyTypeunknown required
valueTypeunknown required

Changes

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