getindexinfo - Bitcoin

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

This method returns the status of the optional block indexes, such as the transaction index and the coinstats index, including whether each is synced and its best block height.

Parameters

Parameter	Type	Required	Description
index_name	string	No	Filter to a single index by name

Request

cURL

curl --location --request POST 'https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "getindexinfo",
    "params": [],
    "id": "getblock.io"
}'

bitcoinjs-lib

example.js

const axios = require('axios');

const response = await axios.post('https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/', {
    jsonrpc: '2.0',
    method: 'getindexinfo',
    params: [],
    id: 'getblock.io'
}, {
    headers: { 'Content-Type': 'application/json' }
});

console.log(response.data.result);

Request

example.py

import requests

response = requests.post(
    'https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/',
    headers={'Content-Type': 'application/json'},
    json={
        'jsonrpc': '2.0',
        'method': 'getindexinfo',
        'params': [],
        'id': 'getblock.io'
    }
)

print(response.json())

Rust

example.rs

use reqwest::Client;
use serde_json::{json, Value};

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

    let response = client
        .post("https://shared.eu-central-1.getblock.io/<ACCESS-TOKEN>/")
        .header("Content-Type", "application/json")
        .json(&json!({
            "jsonrpc": "2.0",
            "method": "getindexinfo",
            "params": [],
            "id": "getblock.io"
        }))
        .send()
        .await?
        .json::<Value>()
        .await?;

    println!("Result: {}", response["result"]);
    Ok(())
}

Response

{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": {
        "txindex": {
            "synced": true,
            "best_block_height": 830000
        },
        "coinstatsindex": {
            "synced": true,
            "best_block_height": 830000
        }
    }
}

Response Parameters

Parameter	Type	Description
jsonrpc	string	JSON-RPC protocol version ("2.0")
id	string	Request identifier matching the request
result	object	Object keyed by index name

Per-Index Object

Field	Type	Description
synced	boolean	Whether the index is synced to the chain tip
best_block_height	number	Highest block the index has processed

Use Cases

• Capability Checks: Confirm the transaction index is available

• Readiness: Confirm an index is fully synced

• Diagnostics: Investigate missing index data

• Feature Gating: Gate features on index availability

Error Handling

Error Code	Message	Description
403	Forbidden	Missing or invalid ACCESS-TOKEN
-8	Invalid parameter	A parameter is out of range or malformed
-32601	Method not found	The method is not available on this endpoint
-32602	Invalid params	A parameter is missing or has the wrong type