Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
DomainRecommendations

Search for available domain names and pricing

This function returns available domain name suggestions and their registration pricing for a given search term.

The system retrieves the results from the configured domain store and caches them for up to two minutes per unique combination of search_field, page, page_size, and the requested tld list. Use the use_cache=0 option to bypass the cache and force a live request.

Note:

This function requires the domain_recommendation feature.

get/DomainRecommendations/domain_suggestions

Query parameters

search_fieldstring required
Example:mybusiness

The search term used to generate domain suggestions. This is a free-text query, not necessarily a fully-qualified domain name.

Note:

Use the base domain name without the TLD (for example, mybusiness instead of mybusiness.com).

pageinteger
Example:1

The page number to retrieve (1-indexed).

If you do not set this value, the function uses the store's default page.

page_sizeinteger
Example:10

The number of suggestions to return per page.

If you do not set this value, the function uses the store's default page size.

use_cache1 | 0
Example:1

Whether to use the local response cache.

  • 1 — Use the cache (default). The function caches the results for up to two minutes.
  • 0 — Bypass the cache and make a live request to the store.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "domain_suggestions",
  "module": "DomainRecommendations",
  "result": {
    "data": {
      "meta": {
        "page": 1,
        "page_size": 10,
        "total_items": 25,
        "total_pages": 3
      },
      "suggestions": {
        "mybusiness.com": {
          "is_premium": 0,
          "premium_cost_pricing": null,
          "pricing": [
            {
              "period": 1,
              "register": {
                "code": "USD",
                "display_value": "$9.99 USD",
                "prefix": "$",
                "suffix": " USD",
                "value": "9.99"
              },
              "renew": {
                "code": "USD",
                "display_value": "$9.99 USD",
                "prefix": "$",
                "suffix": " USD",
                "value": "9.99"
              },
              "transfer": null
            }
          ]
        }
      }
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}