v1 REST API

API Документація

Базовий URL

Production:https://api.quickname.tech

Ліміти запитів

  • Максимум 3 запити на годину з однієї IP-адреси. Якщо потрібно більше, напишіть нам.
  • Опис проєкту: від 5 до 1024 символів
POST/v1/request/Створити запит

Створює новий запит на пошук доменів. Після створення запит ставиться в чергу на обробку.

Тіло запиту

ПолеТипОпис
user_description*stringОпис проєкту (5-1024 символів). Чим детальніше, тим кращі результати.
zonesstring[]Список бажаних доменних зон (наприклад, ["com", "io"]). Опціонально.
domain_max_priceintegerМаксимальна ціна домену в USD. Опціонально.

Приклад запиту

curl -X POST https://api.quickname.tech/v1/request/ \
  -H "Content-Type: application/json" \
  -d '{
    "user_description": "Онлайн-маркетплейс вінтажних годинників",
    "zones": ["com", "io", "tech"],
    "domain_max_price": 100
  }'

Відповідь 201 Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_description": "Онлайн-маркетплейс вінтажних годинників",
  "zones": ["com", "io", "tech"],
  "domain_max_price": 100,
  "status": "created",
  "results": [],
  "is_valid": true
}
GET/v1/request/{'{'}request_id{'}'}/Отримати статус запиту

Повертає поточний стан запиту на пошук доменів, включаючи статус обробки та результати.

Статуси

created
processing
finished
error

Приклад запиту

curl https://api.quickname.tech/v1/request/123e4567-e89b-12d3-a456-426614174000/

Відповідь 200 OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_description": "Онлайн-маркетплейс вінтажних годинників",
  "zones": ["com", "io", "tech"],
  "status": "finished",
  "results": [
    {
      "domain": "techmarket.io",
      "price": 45,
      "availability": "available",
      "reasoning": "Поєднання 'tech' та 'market' для технологічного маркетплейсу"
    }
  ],
  "is_valid": true
}

Поля відповіді

Об'єкт Domain

ПолеТипОпис
domainstringПовне доменне ім'я (наприклад, example.com)
priceinteger | nullЦіна домену в USD. Може бути null.
availabilitystringСтатус: available, unavailable або unknown
reasoningstring | nullПояснення AI чому запропоновано цей домен

Коди помилок

КодОпис
400Помилка валідації — перевірте тіло запиту
404Запит не знайдено або закінчився термін дії (24 години)
422Невірний формат UUID
429Перевищено ліміт запитів (3 запити/година)
500Внутрішня помилка сервера