Sign in
Contracts

Get contract bigmaps

Returns all active bigmaps allocated in the contract storage.

get/v1/contracts/{address}/bigmaps

Path parameters

addressstring required

Contract address

Query parameters

eqstring[] nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify a comma-separated list of bigmap tags to get bigmaps with exactly the same set of tags. Avoid using this mode and use .any or .all instead, because it may not work as expected due to internal 'hidden' tags.

Example: ?tags=metadata or ?tags=token_metadata,metadata.

anystring[] nullable

Has any filter mode.
Specify a comma-separated list of bigmap tags to get bigmaps where at least one of the specified tags is presented.

Example: ?tags.any=metadata or ?tags.any=token_metadata,metadata.

allstring[] nullable

Has all filter mode.
Specify a comma-separated list of bigmap tags to get bigmaps where all of the specified tags are presented.

Example: ?tags.all=metadata or ?tags.all=token_metadata,metadata.

Filters bigmaps tags (metadata, token_metadata, ledger).

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 bigmaps by specified field. Supported fields: id (default), firstLevel, lastLevel, totalKeys, activeKeys, updates.

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 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

{"stackTrail":"components:schemas:BigMap:properties:keyType","oasType":"schema","type":"unknown","description":"Bigmap key type as JSON schema or Micheline, depending on the `micheline` query parameter."}
{"stackTrail":"components:schemas:BigMap:properties:valueType","oasType":"schema","type":"unknown","description":"Bigmap value type as JSON schema or Micheline, depending on the `micheline` query parameter."}

Changes

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