Keys

Get bigmap keys

get

Returns a list of all bigmap keys.

Query parameters

idone of | nullableOptional

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

bigmapone of | nullableOptional

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

activeboolean | nullableOptional

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

hashone of | nullableOptional

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

keyone of | nullableOptional

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.

valueone of | nullableOptional

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.

firstLevelone of | nullableOptional

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

firstTimeone of | nullableOptional

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

lastLevelone of | nullableOptional

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

lastTimeone of | nullableOptional

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

updatesone of | nullableOptional

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

sortone of | nullableOptional

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.

offsetone of | nullableOptional

Specifies which or how many items should be skipped.
Click on the parameter to expand more details.

limitinteger · int32 · max: 10000Optional

Maximum number of items to return.

selectone of | nullableOptional

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.

michelineone ofOptional

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

Default: Json

Responses

application/json

object[]Optional

get

HTTPcURLJavaScriptPython

GET /v1/bigmaps/keys HTTP/1.1
Host: xtz-index.nownodes.io
Accept: */*

200Success

[
  {
    "id": 1,
    "bigmap": 1,
    "active": true,
    "hash": "text",
    "key": null,
    "value": null,
    "firstLevel": 1,
    "firstTime": "2025-04-23T17:49:09.293Z",
    "lastLevel": 1,
    "lastTime": "2025-04-23T17:49:09.293Z",
    "updates": 1
  }
]

Get bigmap keys

get

Returns a list of bigmap keys.

Path parameters

idinteger · int32Required

Bigmap Id

Query parameters

activeboolean | nullableOptional

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

keyone of | nullableOptional

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

valueone of | nullableOptional

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

lastLevelone of | nullableOptional

Filters bigmap keys by the last update level.

selectone of | nullableOptional

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.

sortone of | nullableOptional

Sorts bigmap keys by specified field. Supported fields: id (default), firstLevel, lastLevel, updates.

offsetone of | nullableOptional

Specifies which or how many items should be skipped

limitinteger · int32 · max: 10000Optional

Maximum number of items to return

Default: 100

michelineone ofOptional

Format of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string

Default: Json

Responses

application/json

object[]Optional

get

HTTPcURLJavaScriptPython

GET /v1/bigmaps/{id}/keys HTTP/1.1
Host: xtz-index.nownodes.io
Accept: */*

200Success

[
  {
    "id": 1,
    "active": true,
    "hash": "text",
    "key": null,
    "value": null,
    "firstLevel": 1,
    "lastLevel": 1,
    "updates": 1
  }
]

Get bigmap key

get

Returns the specified bigmap key.

Path parameters

idinteger · int32Required

Bigmap Id

keystringRequired

Either a key hash (expr123...) or a plain value (foo...). Even if the key is complex (an object or an array), you can specify it as is, for example, /keys/{"address":"tz123","nat":"123"}.

Query parameters

michelineone ofOptional

Format of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string

Default: Json

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /v1/bigmaps/{id}/keys/{key} HTTP/1.1
Host: xtz-index.nownodes.io
Accept: */*

200Success

{
  "id": 1,
  "active": true,
  "hash": "text",
  "key": null,
  "value": null,
  "firstLevel": 1,
  "lastLevel": 1,
  "updates": 1
}