Back to top

API Documentation

Domain

Overview

An API to purchase domains

Get some domain suggestions

Get some domain suggestions
GET/domains/suggest?q={q}

Example URI

GET /domains/suggest?q=myname
URI Parameters
HideShow
q
string (required) Example: myname
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "available": true,
      "domain": "suggestion.com",
      "definitive": true,
      "price": 47990000,
      "currency": "USD",
      "period": 1
    },
    {
      "available": true,
      "domain": "suggestion.org",
      "definitive": true,
      "price": 47990000,
      "currency": "USD",
      "period": 1
    },
    {
      "available": true,
      "domain": "suggestion.net",
      "definitive": true,
      "price": 47990000,
      "currency": "USD",
      "period": 1
    }
  ],
  "info": {
    "count": 3,
    "total": 0
  }
}

Purchase a domain

Purchase a domain
POST/domains

Example URI

POST /domains
Request
HideShow
Body
{
  "domain": "suggestion.com",
  "stripe": "209236ba-5930-4a93-9ad3-74d78a0af7c9",
  "agreement": {
    "ip": "127.0.0.1",
    "keys": [
      "Mock DNRA"
    ]
  }
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "24df2ae7-3576-417b-9beb-1ee36261a075",
    "name": "suggestion.com",
    "created_at": 1769132517.839199,
    "updated_at": 1769132517.839199,
    "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "order": null,
    "zone": null,
    "charge": "926fc272-ba1e-42f9-9ec7-167e9ee60059",
    "expires_at": 1800668517.837,
    "expiry_email_due_at": 1799804517.837,
    "type": "domain"
  }
}

Get domains

Get domains
GET/domains

Example URI

GET /domains
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "24df2ae7-3576-417b-9beb-1ee36261a075",
      "name": "suggestion.com",
      "created_at": 1769132517.839199,
      "updated_at": 1769132517.699106,
      "owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "order": "841636",
      "zone": null,
      "charge": "2a605c73-c39f-49fb-bd28-6259084d91c0",
      "expires_at": 1800668517.954,
      "expiry_email_due_at": 1799804517.954,
      "type": "domain"
    }
  ],
  "info": {
    "count": 1,
    "total": 0
  }
}

Get a domain

Get a domain
GET/domains/:id

Example URI

GET /domains/:id
URI Parameters
HideShow
id
string (required) Example: 24df2ae7-3576-417b-9beb-1ee36261a075
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "domain": "suggestion.com",
    "renewal": {
      "renewable": true,
      "price": 10000
    }
  }
}

Renew a domain

Renew a domain
POST/domains/:id/renew

Example URI

POST /domains/:id/renew
URI Parameters
HideShow
id
string (required) Example: 24df2ae7-3576-417b-9beb-1ee36261a075
Request
HideShow
Body
{
  "stripe": "209236ba-5930-4a93-9ad3-74d78a0af7c9"
}
Response  204

Generated by aglio on 23 Jan 2026