---
title: "Check whether a domain is available for registration"
method: GET
path: "/DomainRecommendations/domain_availability"
tags: ["DomainRecommendations"]
---

# Check whether a domain is available for registration

`GET /DomainRecommendations/domain_availability`

This function checks whether a specific domain name is available for registration through the configured domain store.

The system caches the results for up to two minutes per domain. Use the `use_cache=0` option to bypass the cache and force a live request.

**Note:**

This function requires the `domain_recommendation` feature.

## Query parameters

- `domain` string, required
- `use_cache` 1 | 0

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object, nullable — An object containing the domain availability result from the configured domain store.
      - `domain_name` string — The fully-qualified domain name (FQDN) that the function checked.
      - `group` string, nullable — The domain group, if applicable.
      - `idn_domain_name` string — The internationalized domain name (IDN) of the checked domain.
      - `idn_sld` string — The internationalized second-level domain (SLD) portion of the checked domain.
      - `is_domain_available` boolean — Whether the domain is available for registration. * `true` — Available. * `false` — Not available.
      - `is_premium` boolean — Whether the domain is a premium domain with special pricing. * `true` — The domain is a premium domain. * `false` — The domain is not a premium domain.
      - `is_tld_available` boolean — Whether the TLD is available for registration through the configured store. * `true` — The TLD is available. * `false` — The TLD is not available.
      - `premium_cost_pricing` object, nullable — The pricing structure for the premium domain, if applicable.
      - `pricing` PricingPeriod[] — An array of pricing options for each registration period (in years).
        - `period` integer — The registration period in years.
        - `register` object, nullable — The registration price for this period.
          - `code` string — The ISO 4217 currency code.
          - `display_value` string — The formatted price string including prefix and suffix.
          - `prefix` string — The currency symbol that appears before the value.
          - `suffix` string — The currency label that appears after the value.
          - `value` string — The numeric price as a decimal string.
        - `renew` object, nullable — The renewal price for this period.
          - `code` string — The ISO 4217 currency code.
          - `display_value` string — The formatted price string including prefix and suffix.
          - `prefix` string — The currency symbol that appears before the value.
          - `suffix` string — The currency label that appears after the value.
          - `value` string — The numeric price as a decimal string.
        - `transfer` object, nullable — The transfer price for this period.
          - `code` string — The ISO 4217 currency code.
          - `display_value` string — The formatted price string including prefix and suffix.
          - `prefix` string — The currency symbol that appears before the value.
          - `suffix` string — The currency label that appears after the value.
          - `value` string — The numeric price as a decimal string.
      - `shortest_period` object — The pricing for the shortest available registration period.
        - `period` integer — The registration period in years.
        - `register` object, nullable — The registration price for this period.
          - `code` string — The ISO 4217 currency code.
          - `display_value` string — The formatted price string including prefix and suffix.
          - `prefix` string — The currency symbol that appears before the value.
          - `suffix` string — The currency label that appears after the value.
          - `value` string — The numeric price as a decimal string.
        - `renew` object, nullable — The renewal price for this period.
          - `code` string — The ISO 4217 currency code.
          - `display_value` string — The formatted price string including prefix and suffix.
          - `prefix` string — The currency symbol that appears before the value.
          - `suffix` string — The currency label that appears after the value.
          - `value` string — The numeric price as a decimal string.
        - `transfer` object, nullable — The transfer price for this period.
          - `code` string — The ISO 4217 currency code.
          - `display_value` string — The formatted price string including prefix and suffix.
          - `prefix` string — The currency symbol that appears before the value.
          - `suffix` string — The currency label that appears after the value.
          - `value` string — The numeric price as a decimal string.
      - `sld` string — The second-level domain (SLD) portion of the checked domain.
      - `status` string — A string describing the availability status of the domain.
      - `tld` string — The top-level domain (TLD) portion of the checked domain.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — * `1` — Success. * `0` — Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)