▣ DATA VALIDATION · DEVELOPER TOOLS

Domain Availability API

Hosted on ApyHub

What it does

Domain Availability checks whether a domain name is available, taken, or indeterminate. Send a domain string such as example.com, and it returns a single data value: true, false, or null.

Use it when you need to validate a candidate domain during signup, domain search, registrar workflows, or product naming tools. The input must be a valid domain format with a lowercase name part made of letters, digits, and hyphens, and a TLD of at least two letters. The service normalises the domain to lowercase before checking it.

The response is intentionally compact so you can wire it straight into automation or UI logic. true means the domain appears available, false means it is already taken, and null means the check could not determine a result.

If you are building a domain picker, registration flow, or SEO tool, this endpoint gives you a simple availability signal without extra metadata to parse.

POST

Check domain availability

http://localhost:8080/apyhub/domain-availability-api

QUICKSTARTGUIDE

Quickstart

Check whether a domain is available by sending the domain name in the request body.

curl -X POST "http://localhost:8080/apyhub/domain-availability-api" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com"}'

What you'll get back

Returns a JSON object with a data boolean field — true means the domain is available, false means it’s taken, and null means the API could not determine the result.

{
  "data": true
}

TRY ITLIVE · 25 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Checks whether a domain name is available. The request sends a domain string, and the response returns a JSON object with a data boolean-or-null field indicating availability.

Request Body

Parameter	Type	Mandatory	Description
domain	String	Yes	The domain name to check, e.g. `example.com`. Must be a valid domain format: lowercase letters, digits, and hyphens; the name part must be 1–63 characters and cannot start or end with a hyphen; the TLD must be at least 2 letters. Case-insensitive; normalized to lowercase internally.

Response

Returns a JSON object with a data boolean-or-null field. true means the domain is available, false means it is taken, and null means the availability could not be determined.

Parameter	Type	Mandatory	Description
data	Boolean	Yes	`true` = available, `false` = taken, `null` = could not determine.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.