Sign in
BigMaps

Get bigmap keys

Returns a list of all bigmap keys.

get/v1/bigmaps/keys

Query parameters

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.

Filter by internal TzKT id.
Click on the parameter to expand more details.

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.

Filter by bigmap ptr.
Click on the parameter to expand more details.

activeboolean nullable

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

eqstring nullable

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

Example: ?address=expr....

nestring nullable

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

Example: ?address.ne=expr....

instring[] nullable

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

Example: ?address.in=expr1,expr2.

nistring[] nullable

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

Example: ?address.ni=expr1,expr2.

Filter by key hash.
Click on the parameter to expand more details.

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.

Filter by key.
Note, this parameter supports the following format: key{.path?}{.mode?}=..., so you can specify a path to a particular field to filter by (for example, ?key.foo.in=bar,baz).
Click on the parameter to expand more details.

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.

Filter by value.
Note, this parameter supports the following format: value{.path?}{.mode?}=..., so you can specify a path to a particular field to filter by (for example, ?value.foo.in=bar,baz).
Click on the parameter to expand more details.

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.

Filter by level of the block where the key was first seen.
Click on the parameter to expand more details.

eqstring date-time nullable

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

Example: ?timestamp=2020-02-20T02:40:57Z.

nestring date-time nullable

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

Example: ?timestamp.ne=2020-02-20T02:40:57Z.

gtstring date-time nullable

Greater than filter mode.
Specify a datetime value to get items where the specified field is greater than the specified value.

Example: ?timestamp.gt=2020-02-20T02:40:57Z.

gestring date-time nullable

Greater or equal filter mode.
Specify a datetime value to get items where the specified field is greater than equal to the specified value.

Example: ?timestamp.ge=2020-02-20T02:40:57Z.

ltstring date-time nullable

Less than filter mode.
Specify a datetime value to get items where the specified field is less than the specified value.

Example: ?timestamp.lt=2020-02-20T02:40:57Z.

lestring date-time nullable

Less or equal filter mode.
Specify a datetime value to get items where the specified field is less than or equal to the specified value.

Example: ?timestamp.le=2020-02-20T02:40:57Z.

instring[] nullable

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

Example: ?timestamp.in=2020-02-20,2020-02-21.

nistring[] nullable

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

Example: ?timestamp.ni=2020-02-20,2020-02-21.

Filter by timestamp (ISO 8601) of the block where the key was first seen.
Click on the parameter to expand more details.

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.

Filter by level of the block where the key was last seen.
Click on the parameter to expand more details.

eqstring date-time nullable

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

Example: ?timestamp=2020-02-20T02:40:57Z.

nestring date-time nullable

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

Example: ?timestamp.ne=2020-02-20T02:40:57Z.

gtstring date-time nullable

Greater than filter mode.
Specify a datetime value to get items where the specified field is greater than the specified value.

Example: ?timestamp.gt=2020-02-20T02:40:57Z.

gestring date-time nullable

Greater or equal filter mode.
Specify a datetime value to get items where the specified field is greater than equal to the specified value.

Example: ?timestamp.ge=2020-02-20T02:40:57Z.

ltstring date-time nullable

Less than filter mode.
Specify a datetime value to get items where the specified field is less than the specified value.

Example: ?timestamp.lt=2020-02-20T02:40:57Z.

lestring date-time nullable

Less or equal filter mode.
Specify a datetime value to get items where the specified field is less than or equal to the specified value.

Example: ?timestamp.le=2020-02-20T02:40:57Z.

instring[] nullable

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

Example: ?timestamp.in=2020-02-20,2020-02-21.

nistring[] nullable

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

Example: ?timestamp.ni=2020-02-20,2020-02-21.

Filter by timestamp (ISO 8601) of the block where the key was last seen.
Click on the parameter to expand more details.

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.

Filter by number of actions with the bigmap key.
Click on the parameter to expand more details.

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 items (asc or desc) by the specified field. You can see what fields can be used for sorting in the response description, below.
Click on the parameter to expand more details.

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.
Click on the parameter to expand more details.

limitinteger

Maximum number of items to return.

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 as b,metadata.name as meta_name will result in [ { "address": "asd", "b": 10, "meta_name": "qwe" } ].

valuesstring[] nullable

Values selection mode.
Specify a comma-separated list of fields to include their values into response.

Example: ?select.values=address,balance,metadata.name will result in [ [ "asd", 10, "qwe" ] ].

Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields. This parameter accepts values of the following format: {field}{path?}{as alias?}, so you can do deep selection (for example, ?select=balance,token.metadata.symbol as token,...).
Note, if you select just one field, the response will be flatten into a simple array of values.
Click on the parameter to expand the details.

micheline'Json' | 'JsonString' | 'Raw' | 'RawString'

Format of the key and value fields: 0 - JSON, 2 - Micheline

Response

idinteger

Internal TzKT id.
[sortable]

bigmapinteger

Bigmap ptr.

activeboolean

Key status (true - active, false - removed).

hashstring required

Key hash.

{"stackTrail":"components:schemas:BigMapKeyFull:properties:key","oasType":"schema","type":"unknown","description":"Key in JSON or Micheline format, depending on the `micheline` query parameter. \n**[sortable]**"}
{"stackTrail":"components:schemas:BigMapKeyFull: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) this field will contain the last non-null value. \n**[sortable]**"}
firstLevelinteger

Level of the block where the key was first seen.
[sortable]

firstTimestring date-time

Timestamp of the block where the key was first seen.

lastLevelinteger

Level of the block where the key was last seen.
[sortable]

lastTimestring date-time

Timestamp of the block where the key was last seen.

updatesinteger

Total number of actions with the key.
[sortable]

Changes

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