CustomDomain Docs
Registrar

Search domain availability and pricing

Search domain availability and pricing: CustomDomain™ API reference in the registrar group. Covers parameters, request body, responses and error codes.

GET
/registrar/search

Availability and retail prices for the typed name. With suggest=1 it also returns the same name on other TLDs and close variants, each result carrying a kind (exact, tld or variant). A widget token of either scope, a tenant API key of any role, or a delegated agent token with domains:read may search.

Authorization

AuthorizationBearer <token>

Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).

In: header

Query Parameters

q*string
suggest?"1"

Send 1 for the shop style search: the typed name, the same name on other TLDs and close variants, each with a kind.

Value in

  • "1"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/registrar/search?q=string"
Empty
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}