Keys

Get bigmap keys

Returns keys of a contract bigmap with the specified name.

get

/v1/contracts/{address}/bigmaps/{name}/keys

Path parameters

addressstringrequired

Contract address

namestringrequired

Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is ledger or assets.ledger, then the name is ledger. If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.

Query parameters

activenullable boolean

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

keynullable one of

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

valuenullable one of

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

lastLevelnullable one of

Filters bigmap keys by the last update level.

selectnullable one of

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.

sortnullable one of

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

offsetnullable one of

Specifies which or how many items should be skipped

limitinteger int32

Maximum number of items to return

michelineone of

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/contracts/{address}/bigmaps/{name}/keys'

200

200

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

Get bigmap key

Returns the specified bigmap key.

get

/v1/contracts/{address}/bigmaps/{name}/keys/{key}

Path parameters

addressstringrequired

Contract address

namestringrequired

Bigmap name is the last piece of the bigmap storage path. For example, if the storage path is ledger or assets.ledger, then the name is ledger. If there are multiple bigmaps with the same name, for example assets.ledger and tokens.ledger, you can specify the full path.

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

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/contracts/{address}/bigmaps/{name}/keys/{key}'

200

200

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