Skip to main content

Sandbox

Base URL: https://dev.namify.host
Purpose: Testing and development in a safe environment with no real charges.

Production

Base URL: https://namify.host
Purpose: Live domain purchases, renewals and domain management
AI-Ready DocumentationCopy any endpoint and use ChatGPT or Claude to generate production-ready code — or use the
“Ask a question…” for instant answers inside the docs.

​
Versioning

The version is embedded in the URL path (/v1/). Breaking changes increment the major version with at least 6 months of parallel support. Non-breaking changes (new fields, new endpoints) ship continuously.

​
Request format

All request bodies must be JSON with Content-Type: application/json. Query parameters are used for filtering and pagination on GET requests.

​
Response structure

Response shapes vary by endpoint. Most successful responses return a flat JSON object: 
// Action response (e.g. register, renew, DNS)
{ "status": "SUCCESS", "message": "Domain registered successfully", "order_id": 124680932 }

// Creation response (e.g. customer signup)
{ "message": "Customer created", "customer_id": 85384231 }

// List response (e.g. domain orders)
{ "total_orders": 42, "orders_on_page": 10, "orders": [ ... ] }
Error responses return a message field. Errors originating from the upstream registrar also include a status field: 
// Validation or auth error
{ "message": "The search term field is required." }

// Upstream registrar error
{ "status": "ERROR", "message": "Invalid order ID" }

​
Pagination

The /api/v1/domains/orders endpoint is the only paginated endpoint. It uses page-based pagination via the page query parameter (defaults to 1). The response includes total_orders (total matching records) and orders_on_page (count on the current page).

​
Common headers

TypeDescription
AuthorizationBearer nk_live_ or Bearer nk_test_
Content-TypeApplication/json (required on POST PUT PATCH)
X-RateLimit-RemainingRequests remaining in the current window.
X-RateLimit-ResetUnix timestamp when the window resets.

​
HTTP status codes

CodeDescription
200Success.
201Resource created (e.g. customer signup).
400Upstream request error.
401Unauthorized. API key is missing or invalid.
422Unprocessable. Validation failed or the registrar rejected the request.
500Unexpected server error.
502Upstream registrar returned an unexpected or unparseable response.