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.

Method Declaration
Copy
function checkDomainAvailability(
  domain: string,
): Promise<CheckDomainAvailabilityResponse>;
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
import { createClient } from "@wix/sdk";
import { domainAvailability, ApiKeyStrategy } from "@wix/domains";

const wixClient = createClient({
  modules: { domainAvailability },
  auth: ApiKeyStrategy({
    siteId: "MY-SITE-ID",
    apiKey: "MY-API-KEY",
  }),
});

async function checkDomainAvailability(domain) {
  const response = await domainAvailability.checkDomainAvailability(domain);
}
Errors

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

Did this help?