Hanzo
OpenapiDomain

Checks exact names rather than searching for them, and answers the same quote…

Checks exact names rather than searching for them, and answers the same quote shape search does — purchasable, premium, first-term and renewal price in…

GET /v1/domain/availability

Addresshttps://api.hanzo.ai/v1/domain/availability
MethodGET
Operationget_domain_availability
AuthAuthorization: Bearer $HANZO_API_KEY

Checks exact names rather than searching for them, and answers the same quote shape search does — purchasable, premium, first-term and renewal price in cents.

It requires a validated principal; 403 without one. Nothing is charged and nothing is held. A deployment with no registrar credentials answers 503.

Request

1 field.

FieldInTypeRequiredDescription
domainquerystringyesDomain is one name, or several comma-separated, to check in one call.

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 availability --domain <domain>

Domain API · All Hanzo APIs · Interactive reference

How is this guide?

On this page