getindexinfo

POST

/{apiKey}

Returns the state of one or all available indices currently running. You can optionally filter the results by a specific index name.

Path Parameters

apiKeystringrequireddefaults to docs-demo

For higher throughput, create your own API key

Request

index_namestringoptional

Filter results for an index with a specific name.

Responses

200

A mapping of index names to their respective info.

POST/v2/{apiKey}

curl --request POST \  --url https://bitcoin-mainnet.g.alchemy.com/v2/docs-demo \  --header 'Content-Type: application/json' \  --data '{  "jsonrpc": "2.0",  "id": 1,  "method": "getindexinfo",  "params": [    "txindex"  ]}'

200Success

{  "jsonrpc": "2.0",  "id": 1,  "result": {    "txindex": {      "synced": true,      "best_block_height": 894717    }  }}

Was this page helpful?