Keys

Get bigmap keys

Returns keys of a contract bigmap with the specified name.

GEThttps://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys

Path parameters

address*string

Contract address

name*string

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

Response

200

Body

application/json

idinteger (int32)

Internal Id, can be used for pagination

activeboolean

Bigmap key status (true - active, false - removed)

hashnullable string

Key hash

keynullable any

Key in JSON or Micheline format, depending on the micheline query parameter.

valuenullable any

Value in JSON or Micheline format, depending on the micheline query parameter. Note, if the key is inactive (removed) it will contain the last non-null value.

firstLevelinteger (int32)

Level of the block where the bigmap key was seen first time

lastLevelinteger (int32)

Level of the block where the bigmap key was seen last time

updatesinteger (int32)

Total number of actions with the bigmap key

Request

JavaScriptCurlPython

const response = await fetch('https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "active": false,
    "hash": "text"
  }
]

Get bigmap key

Returns the specified bigmap key.

GEThttps://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys/{key}

Path parameters

address*string

Contract address

name*string

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.

key*string

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

Response

200

Body

application/json

idinteger (int32)

Internal Id, can be used for pagination

activeboolean

Bigmap key status (true - active, false - removed)

hashnullable string

Key hash

keynullable any

Key in JSON or Micheline format, depending on the micheline query parameter.

valuenullable any

Value in JSON or Micheline format, depending on the micheline query parameter. Note, if the key is inactive (removed) it will contain the last non-null value.

firstLevelinteger (int32)

Level of the block where the bigmap key was seen first time

lastLevelinteger (int32)

Level of the block where the bigmap key was seen last time

updatesinteger (int32)

Total number of actions with the bigmap key

Request

JavaScriptCurlPython

const response = await fetch('https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys/{key}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "active": false,
  "hash": "text"
}