Domains-domainName-namespinner:GET
From Hostway API Documentation
GET /domains/{domainName}/namespinner
The NameSpinner command generates domain name suggestions that are similar to the given domain. The results include information on the availability of each suggested domain in different Top Level Domains (TLD). Results can be adjusted by TLD, the number of results to return, the inclusion of hyphens to seperate words, and the use of related terms or phrases. The name spinner can be used to suggest alternative choices for domains when the customers preferred choices are all taken. It is therefore useful to use in conjunction with the standard domain availability check command.
Contents |
Request
GET /domains/{domainName}/namespinner
Parameters
- domainName
- Required, the domain name, word or search terms for which to get suggestions. The input must include only alphanumeric characters, the 'dot' character, hyphens and spaces. For example the following are valid domainName values "Check my domain", "checkmydomain.com", "check-my-domain". The following are not valid "http://www.checkmydomain.com", "www.checkmydomain.com"
URI Parameters
- maxResults - int
- Optional, if specified controls the maximum number of suggestions per TLD. The value must be between 1 and 99. The default value is 20. NOTE: the number of results returned may be less than maxResults if there are not enough suggestions to provide based on the search terms.
- useHyphens - boolean
- Optional, if specified controls whether to use hyphens when generating suggestions. Depending on the search terms and the number of results, the useHyphens toggle may or may not have an impact on results. The default is 'false'.
- addRelated - boolean
- Optional, if specified controls whether to use related terms or phrases when generating suggestions. For example if the input includes the words 'HorseTrading' the addRelated parameter might cause a result such as SportHorseTrading, since sport and horse are related. The default is false.
- TLDList - string
- Optional, if specified the list of TLDs may include COM, NET, ORG, INFO, BIZ, CO, PRO, US, CA, ASIA & MOBI. The list is a comma separated list of the desired TLDs to include in the results, and must not include the 'dot' ('.') separator. The default is to include all supported TLDs.
Request Headers
- Accept
- Allows the client to specify the preferred response content type. Currently supported values:
- application/json
Response
Status Code
- 200 OK
- Success.
Response Body
{"suggestions":
[
{"available": "{available}", "name": "{suggestion}", "tld": "{tld}"}
]
}
Response parameters
- available - boolean
- Indicates true or false if the suggested domain name is available for registration for this TLD.
- suggestion - string
- The second level domain name label.
- tld - string
- The TLD associated with this suggestion. The 'name' and 'tld' should be combined to form the complete domain name. For example 'name'.'tld'
Example Name Spinner
Request
GET /domains/greenenergy/namespinner?maxResults=10&addRelated=true&useHyphens=true&TLDList=com,net,org,us
Response
{
"suggestions":[
{
"available":"true",
"name":"Green-Energy-Home",
"tld":"Com"
},
{
"available":"false",
"name":"Green-Energy-Home",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Home",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Home",
"tld":"Us"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Best-Green-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Free-Green-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Savings",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Technologies",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Clean-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Future",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Future",
"tld":"Net"
},
{
"available":"false",
"name":"Green-Energy-Future",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Future",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Wind-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Wind-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Wind-Energy",
"tld":"Org"
},
{
"available":"false",
"name":"Green-Wind-Energy",
"tld":"Us"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Com"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Net"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Org"
},
{
"available":"true",
"name":"Green-Energy-Barrier",
"tld":"Us"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Com"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Net"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Org"
},
{
"available":"true",
"name":"Austin-Green-Energy",
"tld":"Us"
}
]
}
NameSpinner Sample Code
HTML and JavaScript sample code is available for download here.
See also
