DomainRecommendations
Check whether a domain is available for registration
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.
get/DomainRecommendations/domain_availability
Query parameters
domainstring required
Example:mybusiness.com
The fully-qualified domain name (FQDN) to check for availability.
Note:
This value must include the TLD (for example, mybusiness.com).
use_cache1 | 0
Example:1
Whether to use the local response cache.
- 1 — Use the cache (default). The system 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.
Example response
{
"apiversion": 3,
"func": "domain_availability",
"module": "DomainRecommendations",
"result": {
"data": {
"domain_name": "mybusiness.com",
"idn_domain_name": "mybusiness.com",
"idn_sld": "mybusiness",
"is_domain_available": true,
"is_tld_available": true,
"pricing": [
{
"period": 1,
"register": {
"code": "USD",
"display_value": "$10.74 USD",
"prefix": "$",
"suffix": " USD",
"value": "10.74"
},
"renew": {
"code": "USD",
"display_value": "$10.74 USD",
"prefix": "$",
"suffix": " USD",
"value": "10.74"
},
"transfer": {
"code": "USD",
"display_value": "$11.40 USD",
"prefix": "$",
"suffix": " USD",
"value": "11.40"
}
}
],
"shortest_period": {
"period": 1,
"register": {
"code": "USD",
"display_value": "$10.74 USD",
"prefix": "$",
"suffix": " USD",
"value": "10.74"
},
"renew": {
"code": "USD",
"display_value": "$10.74 USD",
"prefix": "$",
"suffix": " USD",
"value": "10.74"
},
"transfer": {
"code": "USD",
"display_value": "$11.40 USD",
"prefix": "$",
"suffix": " USD",
"value": "11.40"
}
},
"sld": "mybusiness",
"status": "available for registration",
"tld": "com"
},
"metadata": {
"transformed": 1
},
"status": 1
}
}