Ir al contenido

API Reference

Esta página aún no está disponible en tu idioma.

Check whether a domain name is currently available for registration.

GET /v1/domains/check

Query parameters

ParameterTypeRequiredDescription
domainstringFully qualified domain name, e.g. example.com

Example request

Terminal window
curl -G https://api.domchekr.com/v1/domains/check \
-H "Authorization: Bearer $API_KEY" \
--data-urlencode "domain=example.com"

Response

{
"domain": "example.com",
"available": false,
"status": "registered",
"expires_at": "2026-01-15T00:00:00Z",
"checked_at": "2025-03-11T12:34:56Z"
}

Return all domains in the authenticated account’s watchlist.

GET /v1/watchlist

Query parameters

ParameterTypeDefaultDescription
statusstringFilter by status: available, registered, expiring, pending_delete
pageinteger1Page number
per_pageinteger20Results per page (max 100)

Response

{
"data": [
{
"id": "wl_01HX...",
"domain": "mystore.io",
"status": "registered",
"interval_minutes": 60,
"last_checked_at": "2025-03-11T12:00:00Z",
"created_at": "2025-01-01T09:00:00Z"
}
],
"meta": {
"page": 1,
"per_page": 20,
"total": 1
}
}

POST /v1/watchlist

Request body

{
"domain": "mystore.io",
"interval_minutes": 60
}
FieldTypeRequiredDescription
domainstringDomain name to monitor
interval_minutesintegerCheck interval. Must match a value allowed by your plan.

Response201 Created

{
"id": "wl_01HX...",
"domain": "mystore.io",
"status": "registered",
"interval_minutes": 60,
"created_at": "2025-03-11T13:00:00Z"
}

DELETE /v1/watchlist/{id}

Response204 No Content


GET /v1/notifications

Response

{
"data": [
{ "id": "nc_abc", "type": "email", "target": "you@example.com", "active": true },
{ "id": "nc_def", "type": "webhook", "target": "https://hooks.example.com/domchekr", "active": true }
]
}
POST /v1/notifications

Request body

{
"type": "webhook",
"target": "https://hooks.example.com/domchekr"
}
FieldAllowed values
typeemail, webhook
targetEmail address or a valid HTTPS URL

Response201 Created