Historical keys

Get historical keys

get

Returns a list of bigmap keys at the specific block.

Path parameters

idinteger · int32Required

Bigmap Id

levelinteger · int32Required

Level of the block at which you want to get bigmap keys

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

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

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

string · enumOptionalPossible values:

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

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

Get historical key

get

Returns the specified bigmap key at the specific block.

Path parameters

idinteger · int32Required

Bigmap Id

levelinteger · int32Required

Level of the block at which you want to get bigmap key

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

string · enumOptionalPossible values:

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

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

200Success

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