Bigmaps

Get contract bigmaps

Returns all active bigmaps allocated in the contract storage.

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

Path parameters

address*string

Contract address

Query parameters

Response

200

Body

application/json

ptrinteger (int32)

Bigmap pointer

contractnullable one of

Smart contract in which's storage the bigmap is allocated

object

pathnullable string

Path to the bigmap in the contract storage

tagsnullable array of string

List of tags ( `metadata`, `token_metadata`,`ledger`, or `null` if there are no tags)

activeboolean

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

firstLevelinteger (int32)

Level of the block where the bigmap was seen first time

lastLevelinteger (int32)

Level of the block where the bigmap was seen last time

totalKeysinteger (int32)

Total number of keys ever added to the bigmap

activeKeysinteger (int32)

Total number of currently active keys

updatesinteger (int32)

Total number of actions with the bigmap

keyTypenullable any

Bigmap key type as JSON schema or Micheline, depending on the `micheline` query parameter.

valueTypenullable any

Bigmap value type as JSON schema or Micheline, depending on the `micheline` query parameter.

Request

JavaScriptCurlPythonHTTP

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

Response

200

[
  {
    "ptr": 0,
    "contract": {
      "alias": "text",
      "address": "text"
    },
    "path": "text",
    "tags": [
      "text"
    ],
    "active": false,
    "firstLevel": 0,
    "lastLevel": 0,
    "totalKeys": 0,
    "activeKeys": 0,
    "updates": 0
  }
]

Get bigmap by name

Returns contract bigmap with the specified name or storage path.

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

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

ptrinteger (int32)

Bigmap pointer

contractnullable one of

Smart contract in which's storage the bigmap is allocated

object

pathnullable string

Path to the bigmap in the contract storage

tagsnullable array of string

List of tags ( `metadata`, `token_metadata`,`ledger`, or `null` if there are no tags)

activeboolean

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

firstLevelinteger (int32)

Level of the block where the bigmap was seen first time

lastLevelinteger (int32)

Level of the block where the bigmap was seen last time

totalKeysinteger (int32)

Total number of keys ever added to the bigmap

activeKeysinteger (int32)

Total number of currently active keys

updatesinteger (int32)

Total number of actions with the bigmap

keyTypenullable any

Bigmap key type as JSON schema or Micheline, depending on the `micheline` query parameter.

valueTypenullable any

Bigmap value type as JSON schema or Micheline, depending on the `micheline` query parameter.

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "ptr": 0,
  "contract": {
    "alias": "text",
    "address": "text"
  },
  "path": "text",
  "tags": [
    "text"
  ],
  "active": false,
  "firstLevel": 0,
  "lastLevel": 0,
  "totalKeys": 0,
  "activeKeys": 0,
  "updates": 0
}