Keys

Get bigmap keys

get

Returns keys of a contract bigmap with the specified name.

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

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

string · enumOptionalPossible values:

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/contracts/{address}/bigmaps/{name}/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

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