TZtzkt
Contracts

Get bigmap keys

Changed on

Returns keys of a contract bigmap with the specified name.

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

Request

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

activeboolean nullable

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

eqstring nullable

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

Example: ?parameter.from=tz1... or ?parameter.signatures.[3].[0]=null or ?parameter.sigs.[*]=null.

nestring nullable

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

Example: ?parameter.ne=true or ?parameter.amount.ne=0.

gtstring nullable

Greater than filter mode.
Specify a string to get items where the specified field is greater than the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.gt=1234 or ?parameter.time.gt=2021-02-01.

gestring nullable

Greater or equal filter mode.
Specify a string to get items where the specified field is greater than equal to the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.ge=1234 or ?parameter.time.ge=2021-02-01.

ltstring nullable

Less than filter mode.
Specify a string to get items where the specified field is less than the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.lt=1234 or ?parameter.time.lt=2021-02-01.

lestring nullable

Less or equal filter mode.
Specify a string to get items where the specified field is less than or equal to the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.le=1234 or ?parameter.time.le=2021-02-01.

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: ?parameter.as=*mid* or ?parameter.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: ?parameter.un=*mid* or ?parameter.un=*end.

instring[] nullable

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

Example: ?parameter.amount.in=1,2,3 or ?parameter.in=[{"from":"tz1","to":"tz2"},{"from":"tz2","to":"tz1"}].

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: ?parameter.amount.ni=1,2,3 or ?parameter.ni=[{"from":"tz1","to":"tz2"},{"from":"tz2","to":"tz1"}].

nullboolean

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

Example: ?parameter.null or ?parameter.null=false or ?parameter.sigs.[0].null=false.

Filters keys by JSON key. Note, this query parameter supports the following format: ?key{.path?}{.mode?}=..., so you can specify a path to a particular field to filter by, for example: ?key.token_id=....

eqstring nullable

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

Example: ?parameter.from=tz1... or ?parameter.signatures.[3].[0]=null or ?parameter.sigs.[*]=null.

nestring nullable

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

Example: ?parameter.ne=true or ?parameter.amount.ne=0.

gtstring nullable

Greater than filter mode.
Specify a string to get items where the specified field is greater than the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.gt=1234 or ?parameter.time.gt=2021-02-01.

gestring nullable

Greater or equal filter mode.
Specify a string to get items where the specified field is greater than equal to the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.ge=1234 or ?parameter.time.ge=2021-02-01.

ltstring nullable

Less than filter mode.
Specify a string to get items where the specified field is less than the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.lt=1234 or ?parameter.time.lt=2021-02-01.

lestring nullable

Less or equal filter mode.
Specify a string to get items where the specified field is less than or equal to the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (parameter.number.gt=123), datetime strings with datetime strings (parameter.date.gt=2021-01-01), etc. Otherwise, result may surprise you.

Example: ?parameter.balance.le=1234 or ?parameter.time.le=2021-02-01.

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: ?parameter.as=*mid* or ?parameter.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: ?parameter.un=*mid* or ?parameter.un=*end.

instring[] nullable

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

Example: ?parameter.amount.in=1,2,3 or ?parameter.in=[{"from":"tz1","to":"tz2"},{"from":"tz2","to":"tz1"}].

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: ?parameter.amount.ni=1,2,3 or ?parameter.ni=[{"from":"tz1","to":"tz2"},{"from":"tz2","to":"tz1"}].

nullboolean

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

Example: ?parameter.null or ?parameter.null=false or ?parameter.sigs.[0].null=false.

Filters keys by JSON value. Note, this query parameter supports the following format: ?value{.path?}{.mode?}=..., so you can specify a path to a particular field to filter by, for example: ?value.balance.gt=....

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 bigmap keys 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 bigmap keys by specified field. Supported fields: id (default), firstLevel, lastLevel, 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

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

  • a2e2aba5e534Revision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status