NM_Search


Definition

Search for available Premium Domains.

Usage

Use this command to search for Premium Domains that are available for purchase.

Availability

Premium Domains can only be sold by our direct ETP resellers.

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

https://resellertest.enom.com/domainsearch/search-premium.aspx

The text box populates the Keyword parameter, we set RecordsToReturn=50&SortBy=Quality, and the Search button calls the NM_Search command. Our UI divides the 50 results into five pages of 10 domains each.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.

Input parameters

Build the query string using this syntax:

https://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
Keyword Recommended; default is no keyword Word to include in search results. Does not function if query string includes the StartsWith or EndsWith parameter. This parameter expects full words to function as intended. Permitted values are single strings or comma-delimited lists of strings. For example, Keyword=Box,Office returns matches that contain Box and Office, followed by matches that contain Box or Office ?
Filter Optional; default is no filter Words to exclude from search results. This filter expects complete words, not just the first few letters, and does not extrapolate to variations such as plurals. Permitted values are single strings or comma-delimited lists of strings. For example, Keyword=Box,Office&Filter=Exchange,Chart returns matches that contain Box or Office, then removes any items from that list that contain Exchange or Chart, but does not remove items that contain Charts. ?
StartsWith Optional; default is no filter Return domain names that start with this character. Permitted values are alphanumeric 1
EndsWithWith Optional; default is no filter Return domain names that end with this character. Permitted values are alphanumeric 1
Category Optional; by default, the scope of a search is all categories Topic category to search. Use the NM_GetSearchCategories command to retrieve search categories 3
Subcategory Optional; by default, the scope of a search is all subcategories Topic subcategory to search. Use the NM_GetSearchCategories to retrieve search subcategories 3
TLDList Optional; default is com TLDs to include in results. Permitted format is tld or tld1,tld2,tld3, . . .. For example, TLDList=com,net,org returns .com, .net, and .org matches to your search ?
ExcludeHyphens Optional; default is No Exclude domain names that contain hyphens? Use ExcludeHyphens=Yes to exclude hyphens 3
MinLength Optional; default is no minimum Minimum number of characters in the SLDs returned by the search. Most registries impose a minimum of 1 letter for TLDs. Permitted values are numeric 2
MaxLength Optional; default is no maximum Maximum number of characters in the SLDs returned by the search. Most registries impose a maximum of 63 characters for SLDs. Permitted values are numeric 2
PriceHigh Optional; default is no maximum Filter return so that all results are at or below this price. We don’t impose a maximum price but you may want to, to manage risk. Permitted values are in DD or DD.cc format ?
PriceLow Optional; default is no minimum Filter return so that all results are at or above this price. Permitted values are in DD or DD.cc format ?
SortBy Optional; default is Quality Sort order for the list of domains that matches your search criteria. Note that search results will include topics related to the keyword you specify, and commonly include thousands of items. Choosing a sort criterion other than Quality can return unexpected matches. Permitted values: Quality Quality of match to specified keyword(s) Domain Alphabetic Alpha Alphabetic Price Price, lowest to highest PriceDesc Price, highest to lowest ?
Updated Optional Date added to inventory 9
RecordsToReturn Optional; default is 50 Number of domains to return in this response. Permitted values are integers 1 to 500. For example, if you return domains 25 at a time and want to retrieve the third set of 25 domains, use RecordsToReturn=25&StartPosition=51 3
StartPosition Optional; default is 1 For this set of results, start with this position in the set of 25 domains, use RecordsToReturn=25&StartPosition=51 to retrieve the third set of 25 domains, use RecordsToReturn=25&StartPosition=51 ?
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
Count Number of Premium Domains returned in this response
PremiumDomain Premium Domain name
Price Selling price for this domain name
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, sendResponseType=HTML or ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter o the client. Otherwise process the 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.

Example