API REFERENCE

Search available domains (read-only)

POST/api/v1/domains/search

Operates on your account only. Send your API key in the Authorization header. Responses use JSON.

Request

Set BASE_URL to this website’s HTTPS origin and API_KEY to your private key. Replace RESOURCE_ID with the ID returned by the API.

cURL

curl --request POST "${BASE_URL}/api/v1/domains/search" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"query": "my-project", "category": "basic"}'

Headers & parameters

Authorizationrequired

Bearer YOUR_API_KEY

JSON body

JSON

querystringrequired

Name or domain to check for availability.

categorystring

Pricing category: basic or protected.

enum: ["basic", "protected"]

Response

202 means accepted, not completed. Poll the order or operation. If the outcome is unknown, do not issue another purchase. Amounts are decimal strings in USD; dates use ISO 8601.

request_idstringrequired

Identifier used to recover an outcome after a network failure.

currencyobject

const: "USD"

indicativeobjectrequired

const: true

itemsarrayrequired

items[].namestringrequired

@ for the apex, * for wildcard, or a record name.

items[].pricestringrequired

Decimal USD amount; never floating point.

pattern: "^\\d+(\\.\\d+)?$"

Response structure example · illustrative values

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "currency": "USD",
  "indicative": true,
  "items": [
    {
      "name": "example.com",
      "price": "0.00"
    }
  ]
}

Errors & statuses

error.code · error.message · request_id

401

Invalid or revoked key.

404

Resource not found in your account.

409

Idempotency conflict or request in progress.

422

Invalid parameters or business rule, including balance.

500

Outcome may be uncertain. Poll the request.

503

Temporarily unavailable. Respect Retry-After.