# DomainRecommendations

The DomainRecommendations module for UAPI.

## Check whether a domain is available for registration

 - [GET /DomainRecommendations/domain_availability](https://api.docs.cpanel.net/specifications/cpanel.openapi/domainrecommendations/domainrecommendations-domain_availability.md): 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.

## Search for available domain names and pricing

 - [GET /DomainRecommendations/domain_suggestions](https://api.docs.cpanel.net/specifications/cpanel.openapi/domainrecommendations/domainrecommendations-domain_suggestions.md): 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 domain, page, and page_size. Use the use_cache=0 option to bypass the cache and force a live request.

Note:

This function requires the domain_recommendation feature.

## Retrieve the sanitized domain store configuration

 - [GET /DomainRecommendations/get_store_config](https://api.docs.cpanel.net/specifications/cpanel.openapi/domainrecommendations/domainrecommendations-get_store_config.md): This function returns the allowlisted store configuration for the Domain Recommendations feature.

Important:

This function returns only explicitly allowlisted fields. Any key not on the allowlist — including credentials, URLs, and future additions — is excluded by default.

Note:

This function requires the domain_recommendation feature.

## Check whether Domain Recommendations is enabled

 - [GET /DomainRecommendations/is_enabled](https://api.docs.cpanel.net/specifications/cpanel.openapi/domainrecommendations/domainrecommendations-is_enabled.md): This function returns the enablement status of the Domain Recommendations feature on the server.

Note:

This function requires the domain_recommendation feature. If the cPanel account does not have this feature, the function returns an error.

## Get a URL to purchase a domain

 - [GET /DomainRecommendations/purchase_domain](https://api.docs.cpanel.net/specifications/cpanel.openapi/domainrecommendations/domainrecommendations-purchase_domain.md): This function returns a URL for the configured domain store's checkout page. This URL allows the user to complete the purchase of a domain name.

Note:

This function requires the domain_recommendation feature.

## List the TLDs supported by the domain store

 - [GET /DomainRecommendations/supported_tlds](https://api.docs.cpanel.net/specifications/cpanel.openapi/domainrecommendations/domainrecommendations-supported_tlds.md): This function returns the list of top-level domains (TLDs) that the configured domain store supports for registration.

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

Note:

This function requires the domain_recommendation feature.