availability_v3

GoDaddy Domains v3 API (Personal Access Token only). Mutations are asynchronous and return an operation to poll via domains.operations_v3.

Overview

Name	availability_v3
Type	Resource
Id	godaddy.registration.availability_v3

Fields

The following fields are returned by SELECT queries:

get

Availability result for the requested domain.

Name	Datatype	Description
available	boolean	Whether this domain appears to be available for registration. Best-effort; re-verified at quote time. Present only when the domain was successfully checked (no error).
definitive	boolean	When true, the availability result was confirmed directly with the registry (ACCURACY mode). When false, the result is from a cached zone data check (SPEED mode) and may be stale.
domain	string	The domain name checked, normalized to punycode A-label form. (example: example.com)
error	object	The error information. (title: Error)
inventory	string	The inventory source for a domain name. REGISTRY — standard registry price inventory. REGISTRY_PREMIUM — registry premium tier pricing. PREMIUM — third-party premium domain marketplace. (REGISTRY, REGISTRY_PREMIUM, PREMIUM) (title: Inventory Type, example: REGISTRY)
prices	array	Multi-term pricing for this domain. Each entry represents a different registration period (e.g. 1 year, 2 years). Present when available is true.
unicode_domain	string	The Unicode (U-label) form of the domain. Present only for IDN domains. (example: münchen.de) (wire: unicodeDomain)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain	x_request_id, optimize_for, isc_code	Returns an indicative availability result for one domain, including per-term pricing when available. Availability is best-effort; the authoritative check is performed at quote time. This operation does not persist the check — there is no check identity or poll URL. A domain that cannot be checked is still returned as a 200 with an error object on the body; request-level failures use the 4xx responses.
check_bulk	exec	domains	x_request_id	Batch controller for domain availability checking. Accepts 1–25 domain names alongside optional check criteria (optimization mode, ISC pricing code). Returns one Availability result per requested domain in input order inside { items: [...] }. Domains that cannot be checked carry an error object on that item. For a single domain, GET /check-availability (getDomainAvailability) offers the same check semantics and Availability result without a request body; the response is the lone item unwrapped. Availability is best-effort indicative; the authoritative check is always performed at quote time. This controller does not persist the check — there is no check identity or poll URL.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain	string	The domain name to check, in punycode A-label form for IDNs. (example: example.com)
x_request_id	string (uuid)	Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.
isc_code	string	ISC (International Shopper Code) for pricing context. When provided, prices reflect the applicable rates for this ISC. (example: ISC_PARTNER_001) (wire: iscCode)
optimize_for	string	Optional. When omitted, defaults to SPEED. Availability is always re-verified authoritatively at quote time regardless of this setting. (example: SPEED) (wire: optimizeFor)
x_request_id	string (uuid)	Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. (wire: X-Request-Id)

SELECT examples

get

Returns an indicative availability result for one domain, including
per-term pricing when available. Availability is best-effort; the
authoritative check is performed at quote time. This operation does
not persist the check — there is no check identity or poll URL.

A domain that cannot be checked is still returned as a 200 with an
error object on the body; request-level failures use the 4xx responses.

SELECT
available,
definitive,
domain,
error,
inventory,
prices,
unicode_domain
FROM godaddy.registration.availability_v3
WHERE domain = '{{ domain }}' -- required
AND x_request_id = '{{ x_request_id }}'
AND optimize_for = '{{ optimize_for }}'
AND isc_code = '{{ isc_code }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

check_bulk

Batch controller for domain availability checking. Accepts 1–25 domain
names alongside optional check criteria (optimization mode, ISC pricing
code). Returns one Availability result per requested domain in input
order inside { items: [...] }. Domains that cannot be checked carry
an error object on that item.

For a single domain, GET /check-availability (getDomainAvailability)
offers the same check semantics and Availability result without a
request body; the response is the lone item unwrapped.

Availability is best-effort indicative; the authoritative check is
always performed at quote time. This controller does not persist the
check — there is no check identity or poll URL.

EXEC godaddy.registration.availability_v3.check_bulk 
@x_request_id='{{ x_request_id }}', 
@domains='{{ domains }}', 
@optimize_for='{{ optimize_for }}', 
@isc_code='{{ isc_code }}'
;