Queries whether a domain name can be registered based on input parameters.

Description

For more information about how to determine the validity of domain names, see Domain name validity.

Note The frequency of calling the CheckDomain operation is limited. The limit is 10 queries per second (QPS) for a single user and 100 QPS for this operation in total.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CheckDomain

The operation that you want to perform. Set the value to CheckDomain.

DomainName String Yes abc.xin

The domain name to be checked.

FeeCommand String No create

The operation command. Valid values:

  • create: New purchase
  • renew: Renewal
  • transfer: Transfer
  • restore: Redeem
FeeCurrency String No USD

The type of the currency. Valid values:

  • CNY: Chinese yuan
  • USD: United States dollar
FeePeriod Integer No 1

The validity period of the domain name that you want to purchase. Unit: year

Lang String No en

The language of the error message to return. Valid values:

  • zh: Chinese
  • en: English

Default value: en

Response parameters

Parameter Type Example Description 
Avail String 1

Indicates whether the domain name can be registered. Valid values:

  • 1: The domain name can be registered.
  • 3: The domain name can be pre-registered.
  • 4: The pre-registration of the domain name can be deleted.
  • 0: The domain name cannot be registered.
  • -1: The domain name was abnormal.
  • -2: The registration of the domain name was suspended.
  • -3: The domain name was blacklisted.
DomainName String abc.xin

The domain name that was queried.

DynamicCheck Boolean true

Indicates whether the domain name was dynamically inquired.

Premium String true

Indicates whether the domain name contains any premium words. Valid values:

  • true: Yes
  • false: No
Price Long 1286

The registration price of a premium word.

Reason String In use

The reason why the domain name cannot be registered.

RequestId String BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=CheckDomain
&DomainName=abc.xin
&<Common request parameters>

Sample success responses

XML format

<CheckDomain>
      <RequestId>BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1</RequestId>
      <DomainName>abc.xin</DomainName>
      <Avail>1</Avail>
      <Premium>true</Premium>
      <Reason></Reason>
      <Price>1286</Price>
</CheckDomain>

JSON format

{
    "RequestId": "BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1",
    "DomainName": "abc.xin",
    "Avail": 0,
    "Premium": false,
    "Reason": "",
    "Price": 1286
}

Error codes.

For a list of error codes, visit the API Error Center.