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
200Body
{
"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
200Body
{
"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": "8add4195-c5cb-4ce1-9e1d-2a57d01f085d",
"agreement": {
"ip": "127.0.0.1",
"keys": [
"Mock DNRA"
]
}
}Response
200Body
{
"code": "OK",
"data": {
"id": "222538a2-1eee-45f0-baeb-cfa0bf4a97cb",
"name": "suggestion.com",
"created_at": 1791656468.817227,
"updated_at": 1791656468.817227,
"owner": "8e0a8d41-b5a0-49df-9904-2f5736373764",
"order": null,
"zone": null,
"charge": "0b2abed2-de22-4fb5-bb09-33e5c52de15a",
"expires_at": 1823192468.816,
"expiry_email_due_at": 1822328468.816,
"type": "domain"
}
}Get domains ¶
Get domainsGET/domains
Example URI
GET /domains
Response
200Body
{
"code": "OK",
"data": [
{
"id": "222538a2-1eee-45f0-baeb-cfa0bf4a97cb",
"name": "suggestion.com",
"created_at": 1791656468.817227,
"updated_at": 1791656468.705169,
"owner": "8e0a8d41-b5a0-49df-9904-2f5736373764",
"order": "841636",
"zone": null,
"charge": "f6851a47-acae-4269-9f31-8d106bff1bb8",
"expires_at": 1823192468.895,
"expiry_email_due_at": 1822328468.895,
"type": "domain"
}
],
"info": {
"count": 1,
"total": 0
}
}