API Documentation
Domain ¶
Overview
An API to purchase domains
Get some domain suggestions ¶
Get some domain suggestionsGET/domains/suggest?q={q}
Example URI
GET /domains/suggest?q=myname
URI Parameters
- q
string
(required) Example: myname
Response
200
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
}
}
Get legal agreements for a domain ¶
Get legal agreements for a domainGET/domains/agreements?domain={domain}
Example URI
GET /domains/agreements?domain=suggestion.com
URI Parameters
- domain
string
(required) Example: suggestion.com
Response
200
Body
{
"code": "OK",
"data": [
{
"url": "http://mock-nra-url",
"content": "Mock NRA Content",
"title": "Mock Domain Name Registration Agreement",
"agreementKey": "Mock DNRA"
}
],
"info": {
"count": 1,
"total": 0
}
}
Purchase a domain ¶
Purchase a domainPOST/domains
Example URI
POST /domains
Request
Body
{
"domain": "suggestion.com",
"stripe": "b4a29c7a-484e-4c93-8b70-e23d12b74caf",
"agreement": {
"ip": "127.0.0.1",
"keys": [
"Mock DNRA"
]
}
}
Response
200
Body
{
"code": "OK",
"data": {
"id": "a821567e-991a-4778-8a24-78c885d3ca8d",
"name": "suggestion.com",
"created_at": 1760470019.352379,
"updated_at": 1760470019.352379,
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"order": null,
"zone": null,
"charge": "76ab063b-7d37-4afa-8bb1-e1b8bfbdd878",
"expires_at": 1792006019.35,
"expiry_email_due_at": 1791142019.35,
"type": "domain"
}
}
Get domains ¶
Get domainsGET/domains
Example URI
GET /domains
Response
200
Body
{
"code": "OK",
"data": [
{
"id": "a821567e-991a-4778-8a24-78c885d3ca8d",
"name": "suggestion.com",
"created_at": 1760470019.352379,
"updated_at": 1760470019.129903,
"owner": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
"order": "841636",
"zone": null,
"charge": "8b8111ed-3adb-4f15-8a49-6ac4abec2057",
"expires_at": 1792006019.505,
"expiry_email_due_at": 1791142019.505,
"type": "domain"
}
],
"info": {
"count": 1,
"total": 0
}
}