Get bigmap keys

GET

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

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Returns keys of a contract bigmap with the specified name.

Parameters

addressstringrequiredpath

Contract address

namestringrequiredpath

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.

activeboolean | nullquery

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

keyobject | nullquery

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=....

valueobject | nullquery

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=....

lastLevelobject | nullquery

Filters bigmap keys by the last update level.

selectobject | nullquery

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.

sortobject | nullquery

Sorts bigmap keys by specified field. Supported fields: id (default), firstLevel, lastLevel, updates.

offsetobject | nullquery

Specifies which or how many items should be skipped

limitinteger<int32>[0, 10000]100query

Maximum number of items to return

michelinestringJsonJsonStringRawRawStringJsonquery

Format of the bigmap key and value: 0 - JSON, 1 - JSON string, 2 - Micheline, 3 - Micheline string

Response

200OK

Successful response.

400Bad Request

Invalid request.

Get bigmap keys

curl -X GET 'https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys'

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

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

response = requests.get('https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys')
data = response.json()

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

const data = await response.json();

const endpoint = "https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

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

const data = await response.json();

import requests

response = requests.get('https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://xtz-index.nownodes.io/v1/contracts/{address}/bigmaps/{name}/keys')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

[
  {
    "hash": "ooRAfDhmSNiwEdGQi2M5qt27EVtBdh3WD7LX3Rpoet3BTUssKTT",
    "key": "string",
    "value": "string"
  }
]

{
  "error": "Invalid request parameters."
}