checkDomainAvailability( )

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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Domains
SCOPE.ACCOUNT.BASIC_TEAM_MEMBER
SCOPE.ACCOUNT.OWNER
Manage Apps in Den Center
Manage Billing
Manage Domains
Learn more about app permissions.
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>
Check domain availability with an API Key
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?