--- title: "Get bigmap keys" method: GET path: "/v1/bigmaps/{id}/keys" tags: ["BigMaps"] --- # Get bigmap keys `GET /v1/bigmaps/{id}/keys` Returns a list of bigmap keys. ## Path parameters - `id` integer, required ## Query parameters - `active` boolean, nullable - `key` JsonParameter - `eq` string, 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`. - `ne` string, 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`. - `gt` string, 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`. - `ge` string, 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`. - `lt` string, 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`. - `le` string, 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`. - `as` string, 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`. - `un` string, 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`. - `in` string[], 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"}]`. - `ni` string[], 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"}]`. - `null` boolean — **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`. - `value` JsonParameter - `eq` string, 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`. - `ne` string, 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`. - `gt` string, 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`. - `ge` string, 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`. - `lt` string, 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`. - `le` string, 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`. - `as` string, 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`. - `un` string, 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`. - `in` string[], 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"}]`. - `ni` string[], 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"}]`. - `null` boolean — **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`. - `lastLevel` Int32Parameter - `eq` integer, 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`. - `ne` integer, 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`. - `gt` integer, 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`. - `ge` integer, 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`. - `lt` integer, 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`. - `le` integer, 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`. - `in` integer[], 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`. - `ni` integer[], 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`. - `select` SelectParameter - `fields` string[], 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 } ]`. - `values` string[], nullable — **Values** selection mode. \ Specify a comma-separated list of fields to include their values into response. Example: `?select.values=address,balance` => `[ [ "asd", 10 ] ]`. - `sort` SortParameter - `asc` string, 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`. - `desc` string, nullable — **Descending** sort mode. \ Specify a field name to sort by descending. Example: `?sort.desc=id`. - `offset` OffsetParameter - `el` integer, nullable — **Elements** offset mode (optional, i.e. `offset.el=123` is the same as `offset=123`). \ Skips specified number of elements. Example: `?offset=100`. - `pg` integer, nullable — **Page** offset mode. \ Skips `page * limit` elements. This is a classic pagination. Example: `?offset.pg=1`. - `cr` integer, 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`. - `limit` integer - `micheline` 'Json' | 'JsonString' | 'Raw' | 'RawString' ## Response `200` - BigMapKey[] - `id` integer — Internal Id, can be used for pagination - `active` boolean — Bigmap key status (`true` - active, `false` - removed) - `hash` string, required — Key hash - `key` unknown, required - `value` unknown, required - `firstLevel` integer — Level of the block where the bigmap key was seen first time - `lastLevel` integer — Level of the block where the bigmap key was seen last time - `updates` integer — Total number of actions with the bigmap key --- [API](https://skmtc.dev/tzkt/apis/tzkt-api.md) · [All operations](https://skmtc.dev/tzkt/apis/tzkt-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tzkt/tzkt-api/revisions/a2e2aba5e534/schema)