Hanzo
OpenapiDomain

Finds names built from the keyword q, plus the registrar's alternate-TLD…

Finds names built from the keyword q, plus the registrar's alternate-TLD suggestions, and answers a quote for each: the name, whether it is purchasable,…

GET /v1/domain/search

Addresshttps://api.hanzo.ai/v1/domain/search
MethodGET
Operationget_domain_search
AuthAuthorization: Bearer $HANZO_API_KEY

Finds names built from the keyword q, plus the registrar's alternate-TLD suggestions, and answers a quote for each: the name, whether it is purchasable, whether it is premium, the first-term and renewal price in cents, and the TLD.

Prices are RETAIL — this deployment's markup is already applied and the wholesale cost is never on the wire.

It requires a validated principal; 403 without one. Nothing is charged and nothing is held — a quote is not a reservation, and the price is re-quoted at purchase, so a name quoted here can be gone or dearer by the time you buy it. A deployment with no registrar credentials answers 503.

Request

2 fields.

FieldInTypeRequiredDescription
qquerystringyesQ is the keyword to build names from.
tldquerystringTLD narrows the search to a comma-separated set of top-level domains.

Response

StatusBodyMeaning
200quoteListok

200 body — 8 fields.

FieldInTypeAlwaysDescription
resultsbodyOffer[]Results is one quote per name, priced RETAIL — this deployment's markup is already applied and the wholesale cost is never on the wire.
results[].availablebodybooleanwhether it can be bought right now
results[].currencybodystringthe currency both prices are in
results[].domainbodystringthe name this quote prices
results[].premiumbodybooleanwhether the registry prices it above the standard rate
results[].priceCentsbodyintegersell (first-term registration)
results[].renewalPriceCentsbodyintegersell (renewal)
results[].tldbodystringthe top-level domain the name sits under

Failure carries the platform error shape — see Errors.

Examples

hanzo domain search --q <q>

Domain API · All Hanzo APIs · Interactive reference

How is this guide?

On this page