Suggest available domains for a query

Returns available domain name suggestions for a natural-language query or keyword set.

Full description

| 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.

Authorization

bearerAuth

AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.

In: header

Query Parameters

query?string

Natural-language query or keywords describing the desired domain, e.g. "sunrise bakery". Used to generate creative and keyword-spin suggestions.

Lengthlength <= 100

tlds?array<string>

Top-level domains to be included in suggestions.

lengthMax?integer

Maximum length of second-level domain.

Range1 <= value

lengthMin?integer

Minimum length of second-level domain.

Range1 <= value

pageSize?integer

Maximum number of suggestions in the response. Defaults to 10 when omitted.

Range1 <= value <= 50

Default10

sources?array<>

Suggestion source strategies to activate.

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/suggestions?query=sunrise+bakery&tlds=com%2Cnet%2Cshop&sources=EXTENSION%2CKEYWORD_SPIN"

{  "items": [    {      "domain": "sunrisebakery.com",      "inventory": "REGISTRY",      "prices": [        {          "term": "YEAR",          "period": 1,          "price": {            "currencyCode": "USD",            "value": 1199          },          "renewalPrice": {            "currencyCode": "USD",            "value": 2299          }        },        {          "term": "YEAR",          "period": 2,          "price": {            "currencyCode": "USD",            "value": 3098          },          "renewalPrice": {            "currencyCode": "USD",            "value": 4598          },          "firstTermPrice": {            "currencyCode": "USD",            "value": 799          },          "recommended": true        }      ]    },    {      "domain": "sunrisebakery.shop",      "inventory": "REGISTRY",      "prices": [        {          "term": "YEAR",          "period": 1,          "price": {            "currencyCode": "USD",            "value": 299          },          "renewalPrice": {            "currencyCode": "USD",            "value": 599          }        },        {          "term": "YEAR",          "period": 2,          "price": {            "currencyCode": "USD",            "value": 798          },          "renewalPrice": {            "currencyCode": "USD",            "value": 1198          },          "firstTermPrice": {            "currencyCode": "USD",            "value": 199          },          "recommended": true        }      ]    }  ]}

Agent & Automation Notes

Scopesdomains.domain:read, domains.domain:create, domains.dns:update, domains.nameserver:update

Rate limit60 req/min per credential

On failureGET operations are safe to retry. POST registrations use Idempotency-Key. Poll async operations — do not resubmit.

Guides

Concepts

Last updated on

Suggest available domains for a query

Authorization

Query Parameters

Header Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`