# getindexinfo

> For the complete documentation index, see [llms.txt](/docs/llms.txt).

POST https://bitcoin-mainnet.g.alchemy.com/v2/{apiKey}

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


Reference: https://www.alchemy.com/docs/chains/bitcoin/bitcoin-api-endpoints/getindexinfo

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| index_name | string | No | Filter results for an index with a specific name.  |

## Result

**result** (object): A mapping of index names to their respective info.

## Example

### Request

```json
{
  "jsonrpc": "2.0",
  "method": "getindexinfo",
  "params": [
    "txindex"
  ],
  "id": 1
}
```

### Response

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

## Code Examples

### cURL

```bash
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"
  ]
}'
```

### JavaScript

```javascript
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({jsonrpc: '2.0', id: 1, method: 'getindexinfo', params: ['txindex']})
};

fetch('https://bitcoin-mainnet.g.alchemy.com/v2/docs-demo', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://bitcoin-mainnet.g.alchemy.com/v2/docs-demo"

payload = {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "getindexinfo",
    "params": ["txindex"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

### Go

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://bitcoin-mainnet.g.alchemy.com/v2/docs-demo"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"getindexinfo\",\n  \"params\": [\n    \"txindex\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

### Java

```java
HttpResponse<String> response = Unirest.post("https://bitcoin-mainnet.g.alchemy.com/v2/docs-demo")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"getindexinfo\",\n  \"params\": [\n    \"txindex\"\n  ]\n}")
  .asString();
```

### C#

```csharp
using RestSharp;


var options = new RestClientOptions("https://bitcoin-mainnet.g.alchemy.com/v2/docs-demo");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 1,\n  \"method\": \"getindexinfo\",\n  \"params\": [\n    \"txindex\"\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

```


## OpenRPC Method Specification

```yaml
name: getindexinfo
summary: Get information about one or all available indices
description: |
  Returns the state of one or all available indices currently running.  You can optionally filter the results by a specific index name.
params:
  - name: index_name
    required: false
    description: |
      Filter results for an index with a specific name.
    schema:
      type: string
result:
  name: result
  description: A mapping of index names to their respective info.
  schema:
    type: object
    additionalProperties:
      type: object
      properties:
        txindex:
          type: string
          description: The index name.
        synced:
          type: boolean
          description: Whether the index is fully synced.
        best_block_height:
          type: integer
          description: The block height to which the index is synced.
examples:
  - name: getindexinfo example
    params:
      - name: index_name
        value: txindex
    result:
      name: result
      value:
        txindex:
          synced: true
          best_block_height: 894717
```