List availability

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.

GET /v1/domain/availability

Domain → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/domain/availability`
Method	`GET`
Operation	`get_domain_availability`
Auth	`Authorization: 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; 401 without one. Nothing is charged and nothing is held. A deployment with no registrar credentials answers 503.

Request

1 field.

Field	In	Type	Required	Description
`domain`	query	string	yes	Domain is one name, or several comma-separated, to check in one call.

Response

Status	Body	Meaning
`200`	domain.quoteList	ok
`default`	problem-details	refused

200 body — 8 fields.

Field	In	Type	Always	Description
`results`	body	domain.Offer[]	—	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[].available`	body	boolean	—	whether it can be bought right now
`results[].currency`	body	string	—	the currency both prices are in
`results[].domain`	body	string	—	the name this quote prices
`results[].premium`	body	boolean	—	whether the registry prices it above the standard rate
`results[].priceCents`	body	integer (int64)	—	sell (first-term registration)
`results[].renewalPriceCents`	body	integer (int64)	—	sell (renewal)
`results[].tld`	body	string	—	the top-level domain the name sits under

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo domain availability --domain <domain>

.ts

.py

.go

.rs

.java

import { Configuration, DomainApi } from 'hanzoai';

const api = new DomainApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDomainAvailability({ domain: 'domain' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import DomainApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DomainApi(client).get_domain_availability(domain='domain')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.DomainAPI.GetDomainAvailability(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, domain_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = domain_api::get_domain_availability(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DomainApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new DomainApi(client).getDomainAvailability();

curl https://api.hanzo.ai/v1/domain/availability?domain=%3Cdomain%3E \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool domain, op get_domain_availability — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "domain",
         "arguments": {
           "op": "get_domain_availability",
           "input": {
             "domain": "<domain>"
           }
         }
       }
     }'

Domain API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousReplace records NextList domains