suggestions_v3
GoDaddy Domains v3 API (Personal Access Token only). Mutations are asynchronous and return an operation to poll via domains.operations_v3.
Overview
| Name | suggestions_v3 |
| Type | Resource |
| Id | godaddy.registration.suggestions_v3 |
Fields
The following fields are returned by SELECT queries:
- list
Suggested available domains sorted by relevance.
| Name | Datatype | Description |
|---|---|---|
domain | string | The suggested domain name in punycode A-label form. (example: sunrisebakery.com) |
inventory | string | The inventory source for a domain name. REGISTRY — standard registry price inventory. REGISTRY_PREMIUM — registry premium tier pricing. PREMIUM — third-party premium domain marketplace. (REGISTRY, REGISTRY_PREMIUM, PREMIUM) (title: Inventory Type, example: REGISTRY) |
prices | array | Multi-term pricing for this suggestion. Each entry represents a different registration period. Indicative only — the locked price is established at quote time. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | x_request_id, query, tlds, length_max, length_min, page_size, sources | Returns available domain name suggestions for a natural-language query or keyword set. All results are available (available-only contract). Prices are indicative; the authoritative price and availability check is at quote time. |
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 |
|---|---|---|
length_max | integer | Maximum length of second-level domain. (wire: lengthMax) |
length_min | integer | Minimum length of second-level domain. (wire: lengthMin) |
page_size | integer | Maximum number of suggestions in the response. Defaults to 10 when omitted. (wire: pageSize) |
query | string | Natural-language query or keywords describing the desired domain, e.g. "sunrise bakery". Used to generate creative and keyword-spin suggestions. (example: sunrise bakery) |
sources | array | Suggestion source strategies to activate. (example: [EXTENSION, KEYWORD_SPIN]) |
tlds | array | Top-level domains to be included in suggestions. (example: [com, net, shop]) |
x_request_id | string (uuid) | Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. (wire: X-Request-Id) |
SELECT examples
- list
Returns available domain name suggestions for a natural-language query
or keyword set. All results are available (available-only contract).
Prices are indicative; the authoritative price and availability check
is at quote time.
SELECT
domain,
inventory,
prices
FROM godaddy.registration.suggestions_v3
WHERE x_request_id = '{{ x_request_id }}'
AND query = '{{ query }}'
AND tlds = '{{ tlds }}'
AND length_max = '{{ length_max }}'
AND length_min = '{{ length_min }}'
AND page_size = '{{ page_size }}'
AND sources = '{{ sources }}'
;