state_getkeyspagedat - Midnight

Example code for the state_getkeyspagedat JSON-RPC method. Complete guide on how to use state_getkeyspagedat JSON-RPC in GetBlock Web3 documentation.

This method is the same as state_getKeysPaged but takes the block hash as a required parameter, returning keys at that specific block.

Parameters

Parameter

Type

Required

Description

prefix

string

Yes

Hex-encoded storage key prefix

count

integer

Yes

Maximum number of keys to return

startKey

string

Hex-encoded key to start from (exclusive)

hash

string

Yes

Block hash at which to query

Request Example

curl --location --request POST 'https://go.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "state_getKeysPagedAt",
    "params": [
        "0x26aa394eea5630e07c48ae0c9558cef7",
        100,
        null,
        "0x87f5c08ba8334e4ee1642ff9646e94dd46080b71fff03714be8b36f22e481b95"
    ],
    "id": "getblock.io"
}'

import axios from 'axios';

const data = JSON.stringify({
    "jsonrpc": "2.0",
    "method": "state_getKeysPagedAt",
    "params": [
        "0x26aa394eea5630e07c48ae0c9558cef7",
        100,
        null,
        "0x87f5c08ba8334e4ee1642ff9646e94dd46080b71fff03714be8b36f22e481b95"
    ],
    "id": "getblock.io"
});

const config = {
    method: 'post',
    url: 'https://go.getblock.io/<ACCESS-TOKEN>/',
    headers: {
        'Content-Type': 'application/json'
    },
    data: data
};

axios(config)
    .then(response => console.log(JSON.stringify(response.data, null, 2)))
    .catch(error => console.log(error));

import requests
import json

url = "https://go.getblock.io/<ACCESS-TOKEN>/"

payload = json.dumps({
    "jsonrpc": "2.0",
    "method": "state_getKeysPagedAt",
    "params": [
        "0x26aa394eea5630e07c48ae0c9558cef7",
        100,
        null,
        "0x87f5c08ba8334e4ee1642ff9646e94dd46080b71fff03714be8b36f22e481b95"
    ],
    "id": "getblock.io"
})

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers, data=payload)
print(response.text)

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let payload = json!({
        "jsonrpc": "2.0",
        "method": "state_getKeysPagedAt",
        "params": [
                "0x26aa394eea5630e07c48ae0c9558cef7",
                100,
                null,
                "0x87f5c08ba8334e4ee1642ff9646e94dd46080b71fff03714be8b36f22e481b95"
        ],
        "id": "getblock.io"
});

    let response = client
        .post("https://go.getblock.io/<ACCESS-TOKEN>/")
        .header("Content-Type", "application/json")
        .json(&payload)
        .send()
        .await?;

    let result: serde_json::Value = response.json().await?;
    println!("{:#?}", result);

    Ok(())
}

Response Example

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": [
        "0x26aa394eea5630e07c48ae0c9558cef7b99d880ec681799c0cf30e8886371da9"
    ]
}

Response Parameters

Field

Type

Description

result

array of string

Array of hex-encoded storage keys at the given block

Use Cases

Reading historical state pages at a specific block
Archival indexers that need consistent snapshots

Error Handling

Status Code

Error Message

Cause

403

Forbidden

Missing or invalid <ACCESS-TOKEN>

-32602

Invalid params

Request parameters are missing or malformed

429

Too Many Requests

Rate limit exceeded for your plan

SDK Integration

import { ApiPromise, WsProvider } from '@polkadot/api';

const wsProvider = new WsProvider('wss://go.getblock.io/<ACCESS-TOKEN>/');
const api = await ApiPromise.create({ provider: wsProvider });

// Call via the typed API:
const result = await api.rpc.state.getKeysPagedAt("0x26aa394eea5630e07c48ae0c9558cef7", 100, null, "0x87f5c08ba8334e4ee1642ff9646e94dd46080b71fff03714be8b36f22e481b95");
console.log(result.toJSON());

// Or call the raw JSON-RPC method:
const raw = await api.rpc.rpc.methods();
// const raw = await (api as any)._rpcCore.provider.send('state_getKeysPagedAt', ["0x26aa394eea5630e07c48ae0c9558cef7", 100, null, "0x87f5c08ba8334e4ee1642ff9646e94dd46080b71fff03714be8b36f22e481b95"]);

from substrateinterface import SubstrateInterface

substrate = SubstrateInterface(url='wss://go.getblock.io/<ACCESS-TOKEN>/')

# Generic RPC call:
result = substrate.rpc_request('state_getKeysPagedAt', ["0x26aa394eea5630e07c48ae0c9558cef7", 100, null, "0x87f5c08ba8334e4ee1642ff9646e94dd46080b71fff03714be8b36f22e481b95"])
print(result)

Previoussidechain_getStatus - Midnight Nextstate_call - Midnight

Last updated 1 month ago

Was this helpful?