Historical keys

Get historical keys

Returns a list of bigmap keys at the specific block.

get

/v1/bigmaps/{id}/historical_keys/{level}

Path parameters

idinteger · int32required

Bigmap Id

levelinteger · int32required

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

Query parameters

activeboolean | nullable

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

keyone of | nullable

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 | nullable

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 | nullable

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 | nullable

Sorts bigmap keys by specified field. Supported fields: id (default).

offsetone of | nullable

Specifies which or how many items should be skipped

limitinteger · int32 · max: 10000 · default: 100

Maximum number of items to return

michelineone of · default: Json

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xtz-index.nownodes.io/v1/bigmaps/{id}/historical_keys/{level}'

200

200

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

Get historical key

Returns the specified bigmap key at the specific block.

get

/v1/bigmaps/{id}/historical_keys/{level}//{key}

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 of · default: Json

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://xtz-index.nownodes.io/v1/bigmaps/{id}/historical_keys/{level}/{key}'

200

200

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