API REFERENCE

Поиск доменов

POST/api/v1/domains/search

Работает только с данными вашего аккаунта. Передавайте API-ключ в заголовке Authorization. Ответы возвращаются в JSON.

Запрос

В BASE_URL укажите HTTPS-адрес этого сайта, в API_KEY — свой секретный ключ. RESOURCE_ID замените идентификатором из ответа 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"}'

Заголовки и параметры

Authorizationобязательно

Bearer YOUR_API_KEY

JSON body

JSON

querystringобязательно

Имя или домен для проверки доступности.

categorystring

Категория цены: basic или protected.

enum: ["basic", "protected"]

Ответ

202 означает «принято», а не «выполнено». Проверяйте состояние заказа или операции. При неизвестном результате не создавайте повторную покупку. Суммы — десятичные строки в USD, даты — ISO 8601.

request_idstringобязательно

Идентификатор для восстановления результата после сетевого сбоя.

currencyobject

const: "USD"

indicativeobjectобязательно

const: true

itemsarrayобязательно

items[].namestringобязательно

@ — корень, * — wildcard, либо имя записи.

items[].pricestringобязательно

Десятичная строка в USD; не используйте float для расчётов.

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

Пример структуры ответа · условные значения

JSON

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

Ошибки и статусы

error.code · error.message · request_id

401

Ключ неверен или отозван.

404

Ресурс не найден в вашем аккаунте.

409

Конфликт ключа повтора или запрос ещё выполняется.

422

Неверные параметры или условия операции, включая баланс.

500

Результат может быть неизвестен. Проверьте запрос.

503

Временно недоступно. Учитывайте Retry-After.