suggestions
GoDaddy Domains v1 API. Accepts a Personal Access Token (Bearer) or a classic sso-key credential.
Overview
| Name | suggestions |
| Type | Resource |
| Id | godaddy.registration.suggestions |
Fields
The following fields are returned by SELECT queries:
- list
Request was successful
| Name | Datatype | Description |
|---|---|---|
domain | string | Suggested domain name |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | x_shopper_id, query, country, city, sources, tlds, length_max, length_min, limit, wait_ms | Returns domain name suggestions based on a seed domain, keywords, or purchase history. Useful for presenting alternatives when a desired domain is unavailable. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
city | string (city-name) | Name of city to be used as a hint for target region |
country | string (iso-country-code) | Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more |
length_max | integer | Maximum length of second-level domain (wire: lengthMax) |
length_min | integer | Minimum length of second-level domain (wire: lengthMin) |
limit | integer | Maximum number of suggestions to return |
query | string | Domain name or set of keywords for which alternative domain names will be suggested |
sources | array | Sources to be queried - CC_TLD — Varies the TLD using Country Codes - EXTENSION — Varies the TLD - KEYWORD_SPIN — Identifies keywords and then rotates each one - PREMIUM — Includes variations with premium prices |
tlds | array | Top-level domains to be included in suggestions NOTE: These are sample values, there are many more |
wait_ms | integer (integer-positive) | Maximum amount of time, in milliseconds, to wait for responses If elapses, return the results compiled up to that point (wire: waitMs) |
x_shopper_id | string | Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. (wire: X-Shopper-Id) |
SELECT examples
- list
Returns domain name suggestions based on a seed domain, keywords, or purchase history. Useful for presenting alternatives when a desired domain is unavailable.
SELECT
domain
FROM godaddy.registration.suggestions
WHERE x_shopper_id = '{{ x_shopper_id }}'
AND query = '{{ query }}'
AND country = '{{ country }}'
AND city = '{{ city }}'
AND sources = '{{ sources }}'
AND tlds = '{{ tlds }}'
AND length_max = '{{ length_max }}'
AND length_min = '{{ length_min }}'
AND limit = '{{ limit }}'
AND wait_ms = '{{ wait_ms }}'
;