# indexer.getStatus

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

Reads the indexer's health and how far each chain is indexed. Parameters, return value, errors and examples for indexer.getStatus in @ensforge/sdk.

Source: https://ensforge.com/docs/reference/sdk/indexer/get-status

<ApiMeta kind="Read" stability="stable" since="1.0.0" source="packages/sdk/src/actions/indexer/getStatus/index.ts#L50" batchable />

Reads the indexer's health and how far each chain is indexed.

## When to use [#when-to-use]

Use to show a sync banner, or to wait until a write is indexed before reading it back.

## Details [#details]

- Chains are keyed by chain ID; `safe` and `finalized` are `null` when the indexer does not
  track them.

## Signature [#signature]

```ts
function getStatus(
  client: Like,
  options?: getStatus.Options,
): Promise<getStatus.ReturnType>
```

Call it as `ens.indexer.getStatus(options)` on a client, or `Actions.indexer.getStatus(client, options)`.

`indexer.getStatus.request(options)` builds a deferred read for `Actions.batch`. See [Look up many at once](/docs/sdk/look-up-many-at-once).

## Parameters [#parameters]

Also takes the [read options](/docs/reference/sdk/client#read-options).

## Returns [#returns]

Resolves to `IndexerStatus`. Overall status and per-chain progress.

| Field | Type | Description |
| --- | --- | --- |
| `status` | `"ready" \| "degraded" \| "stale"` |  |
| `chains` | `Readonly<Record<number, ChainStatus>>` |  |
| `indexer` | `string` |  |

## Errors [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`ConfigError`](/docs/reference/errors/config-error) | [`INDEXER_NOT_CONFIGURED`](/docs/reference/errors/INDEXER_NOT_CONFIGURED) | the client has no indexer. |
| [`IndexerError`](/docs/reference/errors/indexer-error) | [`INDEXER_UNSUPPORTED`](/docs/reference/errors/INDEXER_UNSUPPORTED) | the indexer does not serve the query or its namespace. |
| [`IndexerError`](/docs/reference/errors/indexer-error) | [`INDEXER_UNAVAILABLE`](/docs/reference/errors/INDEXER_UNAVAILABLE), [`INDEXER_RATE_LIMITED`](/docs/reference/errors/INDEXER_RATE_LIMITED), [`INDEXER_BEHIND`](/docs/reference/errors/INDEXER_BEHIND), [`INDEXER_REQUEST_REJECTED`](/docs/reference/errors/INDEXER_REQUEST_REJECTED), [`INDEXER_RESPONSE_INVALID`](/docs/reference/errors/INDEXER_RESPONSE_INVALID) | the indexer is unavailable, rate limiting, behind, rejects the request or answers unexpectedly. |

It can also fail with the errors every read can (`Errors.CommonError`: `ConfigError`, `ContractRevertError`, `InternalError`, `NetworkError`).

See [How errors work](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Reading the status"
const status = await ens.indexer.getStatus()
```
</Tab>

<Tab>
```ts title="Reading the status with a standalone call"
import { Actions } from "@ensforge/sdk"

const { chains } = await Actions.indexer.getStatus(ens)
```
</Tab>

<Tab>
```ts title="Reading the status in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

const status = yield* Actions.indexer.getStatus(ens)
```
</Tab>
</Tabs>

## Example response [#example-response]

Recorded from Ethereum mainnet on 2026-11-18 at block 26443964. Values change as the chain does.

```ts
await ens.indexer.getStatus({})
```

```json
{
  "status": "ready",
  "chains": {
    "1": {
      "status": "ready",
      "indexed": "26443964n",
      "latest": "26443965n",
      "safe": "26443916n",
      "finalized": "26443884n",
      "lagBlocks": 1,
      "lagSeconds": 12
    }
  },
  "indexer": "bigname"
}
```