getindexinfo

getindexinfo reports which optional indexes a Bitcoin Core node is running and how far each one has caught up to the chain tip. Bitcoin nodes can maintain several supplementary indexes — txindex for arbitrary transaction lookups, the basic block filter index for compact-filter scanning, and coinstatsindex for UTXO-set statistics — and each affects what other read methods you can call against this BTC node. Use this method to discover those capabilities before you depend on them. It is a read-only call against https://bitcoin.therpc.io/YOUR_API_KEY and returns an object keyed by index name, each with a synced flag and a best_block_height.

Use cases

• Confirm the node runs -txindex before relying on getrawtransaction to fetch arbitrary, non-wallet transactions by txid alone (without supplying a blockhash).
• Check whether the basic block filter index is available so you can decide whether compact-filter (BIP 157/158) style scanning is possible against this node.
• Verify an index is fully caught up by comparing its best_block_height to the current chain tip, rather than assuming a present index is usable.

Parameters

Response

Example request

1curl https://bitcoin.therpc.io/YOUR_API_KEY \
2  -X POST \
3  -H "Content-Type: application/json" \
4  -d '{
5  "jsonrpc": "1.0",
6  "id": "therpc",
7  "method": "getindexinfo",
8  "params": [
9    "0x0"
10  ]
11}'

Errors & troubleshooting

Common pitfalls

• An index can be enabled but still building. Presence of the key in the response does not mean it is ready — check the synced flag (and best_block_height against the tip) before relying on lookups that depend on that index, or you may get incomplete results.

Supported networks

• Mainnet
• Testnet

See also

• getrawtransaction
• getblockchaininfo