Support

Check availability of a domain

View as Markdown

Checks whether a single domain is available to register and returns the current price in currency-micro-unit format.

Full description

Checks whether a single domain is available to register and returns the current price in currency-micro-unit format. The definitive flag indicates whether the result came from a live registry query.

GET
/v1/domains/available

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer .

In: header

Query Parameters

domain*string

Domain name whose availability is to be checked

checkType?string

Optimize for time ('FAST') or accuracy ('FULL')

Default"FAST"

Value in

  • "FAST"
  • "FULL"
  • "fast"
  • "full"
forTransfer?boolean

Whether or not to include domains available for transfer. If set to True, checkType is ignored

Defaultfalse

Response Body

curl -X GET "https://example.com/v1/domains/available?domain=string"
{  "available": true,  "currency": "USD",  "definitive": true,  "domain": "string",  "period": 0,  "price": 0}

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.domain:delete, domains.domain:update, domains.contact:update, domains.dns:update, domains.transfer:execute
Rate limit60 req/min per credential
On failureGET operations are safe to retry. PUT/PATCH DNS are idempotent by shape. POST purchase is NOT idempotent — verify state before retrying.

Last updated on

How is this guide?