Bigmaps

Get contract bigmaps

get

Returns all active bigmaps allocated in the contract storage.

Path parameters

addressstringRequired

Contract address

Query parameters

tagsone of | nullableOptional

Filters bigmaps tags (metadata, token_metadata, ledger).

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 bigmaps by specified field. Supported fields: id (default), firstLevel, lastLevel, totalKeys, activeKeys, 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 HTTP/1.1
Host: xtz-index.nownodes.io
Accept: */*

200Success

[
  {
    "ptr": 1,
    "contract": {
      "alias": "text",
      "address": "text"
    },
    "path": "text",
    "tags": [
      "text"
    ],
    "active": true,
    "firstLevel": 1,
    "lastLevel": 1,
    "totalKeys": 1,
    "activeKeys": 1,
    "updates": 1,
    "keyType": null,
    "valueType": null
  }
]

Get bigmap by name

get

Returns contract bigmap with the specified name or storage path.

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

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} HTTP/1.1
Host: xtz-index.nownodes.io
Accept: */*

200Success

{
  "ptr": 1,
  "contract": {
    "alias": "text",
    "address": "text"
  },
  "path": "text",
  "tags": [
    "text"
  ],
  "active": true,
  "firstLevel": 1,
  "lastLevel": 1,
  "totalKeys": 1,
  "activeKeys": 1,
  "updates": 1,
  "keyType": null,
  "valueType": null
}