Documentation for agents: an index at /llms.txt, every docs page in one file at /llms-full.txt, and Markdown for any docs page by adding .md to its URL.

Skip to Content
ensforgeSDK

registration.isAvailable

Checks whether a .eth name can be registered now. Parameters, return value, errors and examples for registration.isAvailable in @ensforge/sdk.

ReadBatchablestable
Since v1.0.0View source

Checks whether a .eth name can be registered now.

When to use

Use to show whether a name is free before quoting a price or starting a registration.

Details

  • Every new .eth name is registered on ENSv2, including names that expired on ENSv1, so one check covers both.
  • Names in their grace period are not available; anyone can renew them, and the name is available again once the grace period ends.
  • Labels the price oracle rejects (for example shorter than 3 characters) are not available.

Signature

function isAvailable(
  client: Like,
  options: isAvailable.Options,
): Promise<isAvailable.ReturnType>

Call it as ens.registration.isAvailable(options) on a client, or Actions.registration.isAvailable(client, options).

registration.isAvailable.request(options) builds a deferred read for Actions.batch. See Look up many at once.

In React, use useAvailability.

Parameters

OptionTypeDefaultDescription
name (required)string.eth second-level name, e.g. alice.eth. Normalized automatically.

Also takes the read options.

Returns

Resolves to boolean. Whether the name can be registered.

Errors

ErrorCodesWhen
InvalidInputErrorINVALID_NAMEnames that are not .eth second-level names.
UnsupportedErrorUNSUPPORTED_ON_DEPLOYMENTwithout ENSv2.
NetworkErrorRPC_REQUEST_FAILED, RPC_TIMEOUT, RATE_LIMITEDthe RPC request fails.

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

See How errors work.

Examples

Checking a name
const free = await ens.registration.isAvailable({ name: "alice.eth" })

Example response

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

await ens.registration.isAvailable({ name: "nick.eth" })
false

See also

Was this page helpful?