API Documentation

Base URL

Production:https://api.quickname.tech

Rate Limits

Maximum 3 requests per hour per IP address. If you need more, please contact us.
Project description: 5 to 1024 characters

POST/v1/request/Create request

Creates a new domain search request. After creation, the request is queued for processing.

Request Body

Field	Type	Description
user_description*	string	Project description (5-1024 characters). The more detailed, the better suggestions.
zones	string[]	List of preferred domain zones (e.g., ["com", "io"]). Optional.
domain_max_price	integer	Maximum domain price in USD. Optional.

Example Request

curl -X POST https://api.quickname.tech/v1/request/ \
  -H "Content-Type: application/json" \
  -d '{
    "user_description": "Online marketplace for vintage watches",
    "zones": ["com", "io", "tech"],
    "domain_max_price": 100
  }'

Response 201 Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_description": "Online marketplace for vintage watches",
  "zones": ["com", "io", "tech"],
  "domain_max_price": 100,
  "status": "created",
  "results": [],
  "is_valid": true
}

GET/v1/request/{'{'}request_id{'}'}/Get request status

Returns the current state of a domain search request, including processing status and results.

Statuses

created

processing

finished

error

Example Request

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

Response 200 OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "user_description": "Online marketplace for vintage watches",
  "zones": ["com", "io", "tech"],
  "status": "finished",
  "results": [
    {
      "domain": "techmarket.io",
      "price": 45,
      "availability": "available",
      "reasoning": "Combines 'tech' with 'market' for a technology marketplace"
    }
  ],
  "is_valid": true
}

Response Fields

Domain Object

Field	Type	Description
domain	string	Full domain name (e.g., example.com)
price	integer \| null	Domain price in USD. May be null.
availability	string	Status: available, unavailable, or unknown
reasoning	string \| null	AI explanation for this suggestion

Error Codes

Code	Description
400	Validation error — check request body
404	Request not found or expired (24 hours)
422	Invalid UUID format
429	Rate limit exceeded (3 requests/hour)
500	Internal server error

Back to home