> **Can't find what you're looking for?** Use `search_docs` on the docs MCP server at `https://ensforge.com/api/mcp` to find what you need.

# getHca

Inspect the account and deployment state.

## Import

```ts
import { getHca } from "@ensforge/core/hca";
```

## Usage

:::code-group
```ts [index.ts]
import { getHca } from "@ensforge/core/hca";
import { config } from "./config";

const result = await getHca(config, {
  hca: "0x1234567890123456789012345678901234567890",
});
```

```ts [config.ts]
// [!include ~/snippets/hca/config.ts]
```
:::

## Parameters

```ts
import type { HcaReadParameters } from "@ensforge/core/hca";
```

### hca

`` `0x${string}` ``

HCA address to inspect or operate on.

### blockNumber

`bigint | undefined`

Block number to read. Cannot be combined with blockTag.

### blockTag

`BlockTag | undefined`

Named block state to read. Cannot be combined with blockNumber.

## Return Type

```ts
import type { HcaState } from "@ensforge/core/hca";
```

| Property      | Type                         | Description                            |
| ------------- | ---------------------------- | -------------------------------------- |
| `status`      | `"deployed" \| "undeployed"` | Current deployment or execution state. |
| `address`     | `` `0x${string}` ``          | HCA address.                           |
| `chainId`     | `number`                     | Chain containing the account.          |
| `blockNumber` | `bigint`                     | Block used for this read.              |

When `status` is `"deployed"`, the result also contains `owner`, `implementation`, `accountId`, and `sessionNonce`.

## Effect

Use `.effect` when composing the action in an Effect program. The success and error channels remain
fully typed.

```ts
import { Effect } from "effect";

const program = getHca.effect(config, {
  hca: "0x1234567890123456789012345678901234567890",
});

type Success = Effect.Success<typeof program>;
type Failure = Effect.Error<typeof program>;

const result = await Effect.runPromise(program);
```

## Request

Use `.request` to describe the read without executing it, then include it in a typed
[read batch](/core/guides/batching).

```ts
const request = getHca.request({
  hca: "0x1234567890123456789012345678901234567890",
});
```

## Error

The Promise API rejects with the same typed failures exposed by the Effect error channel. Errors
have a stable `_tag`, `code`, and `message`; boundary errors retain their original `cause`.

See [Error Handling](/core/guides/error-handling).

## Related

* [`getHca`](/sdk/api/hca/get-hca)
* [Guide](/core/guides/hca)