API Documentation

Endpoint

Response schema

interface DomainLookup {
  // Registry-derived fields below are omitted when available is true.
  id?:               string;
  domain:            string;
  available:         boolean | null; // null: DNS-only check, see maybeAvailable
  checkMethod?:      "rdap" | "whois43" | "dns";
  maybeAvailable?:   boolean; // true when DNS found no delegation but availability is unconfirmed
  ldhName?:          string | null;
  unicodeName?:      string | null;
  handle?:           string | null;
  rdapServer?:       string | null;
  secureDNS?:        boolean | null;
  delegationSigned?: boolean | null;
  lookedUpAt?:       string; // ISO 8601
  registryBusy?:     { retryAt: string }; // last known answer, the registry was busy
  entities:          Entity[];
  nameservers:       Nameserver[];
  statuses:          string[];
  events:            Event[];
}

interface Entity {
  role:         string;
  handle:       string | null;
  name:         string | null;
  organization: string | null;
  ianaId:       string | null;
  abuseEmail:   string | null;
  abusePhone:   string | null;
}

interface Nameserver {
  ldhName: string;
  ipv4:    string[];
  ipv6:    string[];
}

interface Event {
  eventAction: string;
  eventDate:   string | null; // ISO 8601
}

When available is true (the domain is unregistered), the response contains only domain, available, and the four arrays. The registry-derived fields (id, ldhName, unicodeName, handle, rdapServer, secureDNS, delegationSigned, lookedUpAt) are omitted.

Code examples

# Anonymous (rate-limited)
curl https://api.domain-sentinel.com/v1/lookup/github.com

# With API key (monthly quota of your plan)
curl -H "Authorization: Bearer ds_your_api_key" \
  https://api.domain-sentinel.com/v1/lookup/github.com

OpenAPI specification (JSON)

Rate limiting

Anonymous requests are rate-limited by IP address. With an API key, calls count towards a monthly quota set by your plan.

The 429 response body includes a retryAfter timestamp (Unix ms). Every call made with a key returns X-Quota-Limit (the month's quota) and X-Quota-Remaining (calls left after this one). The quota resets on the 1st of each month, UTC.

HTTP status codes

Authentication

Create a free API key in your dashboard. Pass it in the Authorization header as a Bearer token. Keys can have an optional expiry date and can be revoked at any time.

FAQ