Discovery
View as MarkdownIndicative, non-committing operations for finding and checking domains. Use suggestDomains for natural-language queries and getDomainAvailability for specific domain verification. Both return indicative pricing; locked pricing is established only at quote time. The check-availability controller carries no persistent identity.
Authorization
bearerAuth Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.
In: header
Query Parameters
Natural-language query or keywords describing the desired domain, e.g. "sunrise bakery". Used to generate creative and keyword-spin suggestions.
length <= 100Top-level domains to be included in suggestions.
Maximum length of second-level domain.
1 <= valueMinimum length of second-level domain.
1 <= valueMaximum number of suggestions in the response. Defaults to 10 when omitted.
1 <= value <= 5010Suggestion source strategies to activate.
Header Parameters
Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.
uuidResponse Body
application/json
application/json
application/json
application/json
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 } ] } ]}Authorization
bearerAuth Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.
In: header
Query Parameters
The domain name to check, in punycode A-label form for IDNs.
Optional. When omitted, defaults to SPEED. Availability is always re-verified authoritatively at quote time regardless of this setting.
"SPEED"Value in
- "SPEED"
- "ACCURACY"
ISC (International Shopper Code) for pricing context. When provided, prices reflect the applicable rates for this ISC.
Header Parameters
Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/check-availability?domain=example.com&optimizeFor=SPEED&iscCode=ISC_PARTNER_001"{ "domain": "coffee24x7x365.com", "available": true, "definitive": false, "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 } }, { "term": "YEAR", "period": 3, "price": { "currencyCode": "USD", "value": 4599 }, "renewalPrice": { "currencyCode": "USD", "value": 6897 }, "firstTermPrice": { "currencyCode": "USD", "value": 499 }, "recommended": true }, { "term": "YEAR", "period": 5, "price": { "currencyCode": "USD", "value": 9197 }, "renewalPrice": { "currencyCode": "USD", "value": 11495 }, "firstTermPrice": { "currencyCode": "USD", "value": 100 } } ]}Authorization
bearerAuth Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.
In: header
Header Parameters
Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header.
uuidRequest Body
application/json
Request body for the POST /check-availability controller. Specifies the domain names to check and optional parameters that influence how the check is performed. The response returns one Availability result per requested domain in input order. This controller does not persist the check; there is no check identity or poll URL.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/check-availability" \ -H "Content-Type: application/json" \ -d '{ "domains": [ "example.com", "example.net" ] }'{ "items": [ { "domain": "example.com", "available": true, "definitive": false, "inventory": "REGISTRY", "prices": [ { "term": "YEAR", "period": 1, "price": { "currencyCode": "USD", "value": 1999 }, "renewalPrice": { "currencyCode": "USD", "value": 1999 } }, { "term": "YEAR", "period": 2, "price": { "currencyCode": "USD", "value": 3098 }, "renewalPrice": { "currencyCode": "USD", "value": 4598 }, "firstTermPrice": { "currencyCode": "USD", "value": 799 } }, { "term": "YEAR", "period": 3, "price": { "currencyCode": "USD", "value": 4599 }, "renewalPrice": { "currencyCode": "USD", "value": 6897 }, "firstTermPrice": { "currencyCode": "USD", "value": 499 }, "recommended": true } ] }, { "domain": "invalid..com", "error": { "name": "MISMATCH_FORMAT", "correlationId": "9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c", "message": "does not conform to the 'domain' format, based on pattern: /^[^.\\s]{1,63}(\\.[^.\\s]{1,63}){1,2}$/" } } ]}Agent & Automation Notes
domains.domain:read, domains.domain:create, domains.dns:update, domains.nameserver:updateRelated
Last updated on
How is this guide?