checkDomainAvailability( )
Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Checks whether the given domain is available for purchase.
You can purchase the specified domain in case the returned
availability.available
boolean is true
. The domain is already taken
when false
is returned.
The domain
field must include the TLD. For example, my-new-domain.com
.
Important: This call requires an account level API key and cannot be authenticated with the standard authorization header.
Method Declaration
Copy
Method Parameters
domainstringRequired
Domain name. Must include the TLD. For example, my-new-domain.com. Only alphanumeric characters, hyphens, and dots are supported.
Min: 3 characters Max: 63 characters
Returns
Return Type:Promise<CheckDomainAvailabilityResponse>
Was this helpful?
Yes
No