Check Availability

CheckAvailability will check a list of domains to see if they are purchasable. A Maximum of 50 domains can be specified. Recommendation: Set purchaseType to registration. Most resellers restrict results to domains with a purchaseType of registration to ensure predictable pricing and immediate fulfillment. Other purchase types (such as aftermarket variants) can introduce higher costs and non-instant transactions that may be delayed or declined by third parties.

POST /core/v1/domains:checkAvailability

Check Availability

cURL

curl --request POST \
  --url https://api.dev.name.com/core/v1/domains:checkAvailability \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domainNames": [
    "<string>"
  ]
}
'

200

{
  "results": [
    {
      "domainName": "example.com",
      "purchasable": true,
      "sld": "example",
      "tld": "com",
      "premium": true,
      "purchasePrice": 10.99,
      "renewalPrice": 10.99,
      "reason": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Body

application/json

AvailabilityRequest is used to list the domain names to check availability for.

Checks if one or more domain names are available for registration (up to 50 domains). Important: Do not encode the : in the path. Use /core/v1/domains:checkAvailability, not /core/v1/domains%3AcheckAvailability.

domainNames · string[] · required

DomainNames is the list of domains to check if they are available.

Required array length: 1 - 50 elements

Minimum string length: 1

purchaseType · enum<string>

Optional filter: when set, only results whose purchaseType matches this value are returned. When omitted, the response may include all purchase types the service can surface for each domain (for example registration and aftermarket variants).

Available options: registration, aftermarket_i, expiring, backorder, aftermarket_s, aftermarket_b

Response

200

application/json

A successful response.

SearchResponse returns a list of search results.

results · object[]

Results of the search are returned here, the order should not be relied upon.

Show child attributes