availability
GoDaddy Domains v1 API. Accepts a Personal Access Token (Bearer) or a classic sso-key credential.
Overview
| Name | availability |
| Type | Resource |
| Id | godaddy.registration.availability |
Fields
The following fields are returned by SELECT queries:
- get
Request was successful
| Name | Datatype | Description |
|---|---|---|
available | boolean | Whether or not the domain name is available |
currency | string (iso-currency-code) | Currency in which the price is listed. Only returned if tld is offered (default: USD) |
definitive | boolean | Whether or not the available answer has been definitively verified with the registry |
domain | string | Domain name |
period | integer (integer-positive) | Number of years included in the price. Only returned if tld is offered |
price | integer (currency-micro-unit) | Price of the domain excluding taxes or fees. Only returned if tld is offered |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | domain | check_type, for_transfer | 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. |
check_bulk | exec | domains | check_type | Checks availability for multiple domains in a single request. Returns an array of availability and pricing results, one per domain queried. |
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 | Domain name whose availability is to be checked |
check_type | string | Optimize for time ('FAST') or accuracy ('FULL') |
check_type | string | Optimize for time ('FAST') or accuracy ('FULL') (wire: checkType) |
for_transfer | boolean | Whether or not to include domains available for transfer. If set to True, checkType is ignored (wire: forTransfer) |
SELECT examples
- get
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.
SELECT
available,
currency,
definitive,
domain,
period,
price
FROM godaddy.registration.availability
WHERE domain = '{{ domain }}' -- required
AND check_type = '{{ check_type }}'
AND for_transfer = '{{ for_transfer }}'
;
Lifecycle Methods
EXEC variables use wire (API) names.
- check_bulk
Checks availability for multiple domains in a single request. Returns an array of availability and pricing results, one per domain queried.
EXEC godaddy.registration.availability.check_bulk
@check_type='{{ check_type }}',
@domains='{{ domains }}'
;