GetNameSuggestions


Definition

Generate variations of a domain name based on a search term.

Usage

Use this command to generate variations of the domain name you specify. This command will return a list of domains across a variety of SLD/TLD combinations.

Availability

All resellers have access to this command.

Implementation on eNom.com

http://resellertest.enom.com/domainsearch/search-results.aspx

Type an SLD into the Register A New Domain box and click GO. The results in the Related section are generated by the GetNameSuggestions command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • A search term must be passed in.

Input parameters

Build the query string using this syntax:

http://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
SearchTerm Required The term to use to generate suggestions, most commonly use is SLD 32
TldList Optional; default is all TLDs A coma separated list of TLDs to generate results on. Only TLDs included in this list will be included in the results. When used with AllGA it will also include additional TLDs you specify, such as some in pre-register status if desired. ?
OnlyTldList Optional; default is blank A coma separated list of TLDs to generate results on. Only TLDs included in this list will be included in the results, even if AllGA is true. ?
ExclueTldList Optional; default is no TLDs A coma separated list of TLDs to exclude from the results. ?
MaxResults Optional; default is 50 Maximum number of suggested names to return in addition to your input. The number actually returned may be lower based on search term. Permitted values are numbers 1 through 100 2
SpinType Optional; default is 0 Determine the type of results you will get;
0 - Both TLD and Spun recommendations - combination of 1 & 2
1 - Only TLD recommendations (exact SLD match) - no suggestions
2 - Only Spun recommendations - only suggestions
3 - Will allow suggestions such as domaintld to be treated as domain.tld suggestions
5
Adult Optional; default is False Allow domain names that may be considered "adult" in nature. Permitted values are True or False. 5
Premium Optional; default is True Allow suggestions that are considered to be "premium" to be returned in the result set. Permitted values are True or False. 5
AllGA Optional; default is True Controls if only TLDs in GA (General Availability) are returned, or if it will return ALL TLDs, including those in pre-registration. Permitted values are True or False. 5

 

Returned parameters and values

Parameter Description
DomainSuggestionCount Number of Suggestions returned in this response
Score Relevancy of the result to the search term
Tld Parsed TLD for this set of results
Sld Parsed SLD for this set of results
Idn Is this domain an IDN. True indicates yes; False indicates no.
Premium Is this domain considered "Premium"? True indicates yes; False indicates no. Unknown indicates that this is a TLD which we cant know for sure.
In_GA Is this TLD in GA. True indicates yes; False indicates no.
NativeSld If the item is an IDN, the Native language SLD.
NativeTld If the item is an IDN, the Native language TLD.
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
ErrX Error messages explaining the failure. These can be presented as is back to the client.
Done True indicates this entire response has reached you successfully.

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
  • Note: The Premium output attribute is a best guess based on data provided by the registries. This data is subject to change on a daily basis, so for the best results it is recommended to do a an EPP Check (Check API Command) on any domain to verify the domain is premium.

Example