# getRecords

Gets a typed selection of resolver records in one operation.

## Import

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

## Usage

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

const result = await getRecords(config, {
  name: "example.eth",
  records: [],
});
```

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

## Parameters

```ts
type Parameters = Parameters<typeof getRecords>[1];
```

### name

`string`

ENS name to operate on. ensforge normalizes it before hashing or contract interaction.

### records

`Selection`

Records selected, read, or written by the operation.

### gatewayUrls

`AssetGatewayUrls | undefined`

Gateway URL overrides used to resolve external avatar assets.

### blockNumber

`bigint | undefined`

Block number to read from. Cannot be combined with `blockTag`.

### blockTag

`"latest" | "earliest" | "pending" | "safe" | "finalized" | undefined`

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

## Return Type

```ts
type GetRecordsResult = Awaited<ReturnType<typeof getRecords>>;
```

| Property | Type                               | Description          |
| -------- | ---------------------------------- | -------------------- |
| `name`   | `string & Brand<"NormalizedName">` | Normalized ENS name. |

## 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 = getRecords.effect(config, parameters);

type Success = Effect.Effect.Success<typeof program>;
type Failure = Effect.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 = getRecords.request(parameters);
```

## Error

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

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

* [`sdk.records.getRecords`](/sdk/api/records/get-records)