Keys

Get KeyValueStore Keys

Allows to iterate over key value store keys.

POSThttps://xrd-gateway.nownodes.io/state/key-value-store/keys

Header parameters

Body

application/json

at_ledger_statenullable LedgerStateSelector (object)

Optional. This allows for a request to be made against a historic state. If a constraint is specified, the Gateway will resolve the request against the ledger state at that time. If not specified, requests will be made with respect to the top of the committed ledger.

cursornullable string

This cursor allows forward pagination, by providing the cursor from the previous request.

limit_per_pagenullable integer

The page size requested.

key_value_store_address*Address (string)

Bech32m-encoded human readable version of the address.

Response

2004XX

KeyValueStore keys collection

Body

application/json

ledger_state*LedgerState (object)

The ledger state against which the response was generated. Can be used to detect if the Network Gateway is returning up-to-date information.

total_countnullable integer (int64)

Total number of items in underlying collection, fragment of which is available in items collection.

next_cursornullable string

If specified, contains a cursor to query next page of the items collection.

items*array of StateKeyValueStoreKeysResponseItem (object)

key_value_store_address*Address (string)

Bech32m-encoded human readable version of the address.

Request

JavaScriptCurlPython

const response = await fetch('https://xrd-gateway.nownodes.io/state/key-value-store/keys', {
    method: 'POST',
    headers: {
      "api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key_value_store_address": "<key-value-store-address>"
    }),
});
const data = await response.json();

Response

2004XX

{
  "ledger_state": {
    "network": "mainnet",
    "proposer_round_timestamp": "text"
  },
  "next_cursor": "text",
  "items": [
    {
      "key": {
        "raw_hex": "text",
        "programmatic_json": {
          "kind": "Bool",
          "type_name": "text",
          "field_name": "text"
        }
      }
    }
  ],
  "key_value_store_address": "text"
}