> For the complete documentation index, see [llms.txt](https://docs.getblock.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getblock.io/api-reference/bitcoin-btc/btc_getindexinfo.md).

# getindexinfo - Bitcoin

This method returns the status of one or more indices currently running on the node.

### Parameters

| Parameter   | Type   | Required | Description                                                                               |
| ----------- | ------ | -------- | ----------------------------------------------------------------------------------------- |
| index\_name | string | No       | Filter for a specific index name (e.g., "txindex", "coinstatsindex", "blockfilterindex"). |

### Request

{% tabs %}
{% tab title="cURL" %}

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

{% endtab %}

{% tab title="Axios" %}

```javascript
import axios from 'axios';

const data = JSON.stringify({
    "jsonrpc": "2.0",
    "method": "getindexinfo",
    "params": [],
    "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)))
    .catch(error => console.log(error));
```

{% endtab %}

{% tab title="Request" %}

```python
import requests
import json

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

payload = json.dumps({
    "jsonrpc": "2.0",
    "method": "getindexinfo",
    "params": [],
    "id": "getblock.io"
})

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

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

{% endtab %}

{% tab title="Rust" %}

```rust
use reqwest::header;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::Client::new();
    
    let response = client
        .post("https://go.getblock.io/<ACCESS-TOKEN>/")
        .header(header::CONTENT_TYPE, "application/json")
        .body(r#"{
            "jsonrpc": "2.0",
            "method": "getindexinfo",
            "params": [],
            "id": "getblock.io"
        }"#)
        .send()
        .await?;
    
    println!("{}", response.text().await?);
    Ok(())
}
```

{% endtab %}
{% endtabs %}

### Response

```json
{
    "jsonrpc": "2.0",
    "id": "getblock.io",
    "result": {
        "txindex": {
            "synced": true,
            "best_block_height": 820000
        },
        "blockfilterindex": {
            "synced": true,
            "best_block_height": 820000
        },
        "coinstatsindex": {
            "synced": true,
            "best_block_height": 820000
        }
    }
}
```

### Response Parameters

| Field               | Type    | Description                                       |
| ------------------- | ------- | ------------------------------------------------- |
| \[index\_name]      | object  | Object containing index status.                   |
| synced              | boolean | Whether the index is fully synced.                |
| best\_block\_height | number  | The block height up to which the index is synced. |

### Use Case

The `getindexinfo` method is essential for:

* Checking node index availability
* Verifying index sync status
* Debugging lookup failures
* Monitoring node health
* Validating feature availability
* Building admin dashboards

### Error Handling

| Status Code | Error Message      | Cause                                  |
| ----------- | ------------------ | -------------------------------------- |
| 403         | Forbidden          | Missing or invalid ACCESS-TOKEN.       |
| -8          | Unknown index name | The specified index name is not valid. |

### Integration With Web3

The `getindexinfo` method helps developers:

* Verify index availability before queries
* Build node monitoring tools
* Check sync progress for indices
* Ensure transaction lookups will work
* Debug index-related errors


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.getblock.io/api-reference/bitcoin-btc/btc_getindexinfo.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.