BigMaps

Get bigmaps

Returns a list of bigmaps.

get/v1/bigmaps

Query parameters

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify a tz or KT address to get items where the specified field is equal to the specified value.

Example: ?sender=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8.

nestring nullable

Not equal filter mode.
Specify a tz or KT address to get items where the specified field is not equal to the specified value.

Example: ?sender.ne=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8.

instring[] nullable

In list (any of) filter mode.
Specify a comma-separated list of addresses to get items where the specified field is equal to one of the specified values.

Example: ?sender.in=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M.

nistring[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of addresses to get items where the specified field is not equal to all the specified values.

Example: ?sender.ni=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M.

eqxstring nullable

Equal to another field filter mode.
Specify a field name to get items where the specified fields are equal.

Example: ?sender.eqx=target.

nexstring nullable

Not equal to another field filter mode.
Specify a field name to get items where the specified fields are not equal.

Example: ?sender.nex=initiator.

nullboolean nullable

Is null filter mode.
Use this mode to get items where the specified field is null or not.

Example: ?initiator.null or ?initiator.null=false.

Filters bigmaps by smart contract address.

eqstring nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify a string to get items where the specified field is equal to the specified value.

Example: ?parameters=abc.

nestring nullable

Not equal filter mode.
Specify a string to get items where the specified field is not equal to the specified value.

Example: ?parameters.ne=abc.

asstring nullable

Same as filter mode.
Specify a string template to get items where the specified field matches the specified template.
This mode supports wildcard *. Use \* as an escape symbol.

Example: ?parameters.as=*mid* or ?parameters.as=*end.

unstring nullable

Unlike filter mode.
Specify a string template to get items where the specified field doesn't match the specified template. This mode supports wildcard *. Use \* as an escape symbol.

Example: ?parameters.un=*mid* or ?parameters.un=*end.

instring[] nullable

In list (any of) filter mode.
Specify a comma-separated list of strings to get items where the specified field is equal to one of the specified values.
Use \, as an escape symbol.

Example: ?errors.in=bla,bal,abl.

nistring[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of strings to get items where the specified field is not equal to all the specified values.
Use \, as an escape symbol.

Example: ?errors.ni=bla,bal,abl.

nullboolean nullable

Is null filter mode.
Use this mode to get items where the specified field is null or not.

Example: ?parameters.null or ?parameters.null=false.

Filters bigmaps by path in the contract storage.

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 by tags: metadata, token_metadata, ledger.

activeboolean nullable

Filters bigmaps by status: true - active, false - removed.

eqinteger nullable

Equal filter mode (optional, i.e. param.eq=123 is the same as param=123).
Specify an integer number to get items where the specified field is equal to the specified value.

Example: ?balance=1234.

neinteger nullable

Not equal filter mode.
Specify an integer number to get items where the specified field is not equal to the specified value.

Example: ?balance.ne=1234.

gtinteger nullable

Greater than filter mode.
Specify an integer number to get items where the specified field is greater than the specified value.

Example: ?balance.gt=1234.

geinteger nullable

Greater or equal filter mode.
Specify an integer number to get items where the specified field is greater than equal to the specified value.

Example: ?balance.ge=1234.

ltinteger nullable

Less than filter mode.
Specify an integer number to get items where the specified field is less than the specified value.

Example: ?balance.lt=1234.

leinteger nullable

Less or equal filter mode.
Specify an integer number to get items where the specified field is less than or equal to the specified value.

Example: ?balance.le=1234.

ininteger[] nullable

In list (any of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.

Example: ?level.in=12,14,52,69.

niinteger[] nullable

Not in list (none of) filter mode.
Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.

Example: ?level.ni=12,14,52,69.

Filters bigmaps by the last update level.

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), ptr, 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 type: 0 - JSON, 2 - Micheline

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.