Description
Returns domain name suggestions for a user-specified keyword.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
keyword | String | Required |
Search term (keyword or phrase) e.g. "search" or "search world" Note
|
tld-only | String | Optional | Specific TLD(s) you may want to search for See details
Note
Name Suggestion is not supported for ccTLDs except: |
exact-match | Boolean | Optional | Will return keyword alternatives when set to True. Can be set to False to only return TLD alternatives. |
adult | Boolean | Optional | If set to false, the suggestions will not contain any adult or explicit suggestions which contain words like"nude","porn",etc. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/domains/v5/suggest-names.json?auth-userid=0&api-key=key&keyword=domain
Response
Returns a hash map containing availability status of suggested domain names for the keyword supplied.
Example Scenarios
-
When tld-only is not specified, and exact-match is false: Results will include keyword matches and alternatives against all TLDs the reseller is signed up for.
-
When tld-only is specified, and exact-match is false: Results will include keyword matches and alternatives against only the TLDs specified.
-
When tld-only is not specified, and exact-match is true: Results will include keyword matches against all TLDs that the reseller is signed up for. No keyword alternatives will be returned.
-
When tld-only is specified, and exact-match is true: Results will include keyword matches against only the TLDs specified. No keyword alternatives will be returned.
Old API call being deprecated
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key or auth-password | String | Required | Authentication Parameter |
keyword | String | Required |
Search term (keyword or phrase) e.g. "search" or "search world" Note
The search term will be considered as invalid, if it contains more than one consecutive space character. |
tlds | Array of Strings | Required | Domain name extensions (TLDs) you want to search in See details |
no-of-results | Integer | Required | Maximum number of suggestions to be returned |
hyphen-allowed | Boolean | Optional | Default value is false. Recommended value is true. If true is passed, generates suggestions with hyphens (Dashes) "-". |
add-related | Boolean | Optional | Default value is false. Recommended value is true. If true is passed, generates suggestions with related keywords. |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/domains/suggest-names.json?auth-userid=0&api-key=key&keyword=domain&tlds=com&tlds=net&no-of-results=0&hyphen-allowed=true&add-related=true
Response
Returns a hash map containing availability status of suggested domain names, for the given keyword under the specified domain name extension(s). The domain name extensions will be listed in alphabetical order.