Bigmaps

Get bigmaps

get

Returns a list of bigmaps.

Query parameters

contractone of | nullableOptional

Filters bigmaps by smart contract address.

pathone of | nullableOptional

Filters bigmaps by path in the contract storage.

tagsone of | nullableOptional

Filters bigmaps by tags: metadata, token_metadata, ledger.

activeboolean | nullableOptional

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

lastLevelone of | nullableOptional

Filters bigmaps 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 bigmaps by specified field. Supported fields: id (default), ptr, 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 type: 0 - JSON, 2 - Micheline

Default: Json

string · enumOptionalPossible values:

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/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 Id

get

Returns a bigmap with the specified Id.

Path parameters

idinteger · int32Required

Bigmap Id

Query parameters

michelineone ofOptional

Format of the bigmap key and value type: 0 - JSON, 2 - Micheline

Default: Json

string · enumOptionalPossible values:

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/bigmaps/{id} 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
}