Documentation

Status

The status method checks the availability status of a single domain name. It accepts one argument: domain

The response will contain a JSON array of status objects with keys: domain and status*. The status key is a space-delimited list of status types for the given domain, in increasing order of precedence.

To prevent resource exhaustion, our platform limits API requests to a total runtime of 30 seconds. If an upstream provider fails to respond within this limit, requests to the status API will return a best-effort value, typically unknown or undelegated.

Arguments

Parameter	Description	Example
`domain`	Domain name you are checking (required).	`domain=acmecoffee.com`

Availability for Registration

The most common use-case of the status API is to determine if a domain is immediately registrable via registrars or resellers, e.g. not via the aftermarket.

For this usage, the inactive status means a domain is available for registration.

If you see the unknown status, this means the Domainr backend was unable to determine an authoritative status from its upstream sources. This is commonly due to a domain registry backend operator being offline due to scheduled maintenance. The OpenSRS service maintains an up-to-date log of scheduled registry maintenance.

Example

Request

/v2/status?domain=acmecoffee.shop

Response

{
 "status": [
  {
   "domain": "acmecoffee.shop",
   "zone": "shop",
   "status": "undelegated inactive",
   "summary": "inactive" // Deprecated
  }
 ]
}

Status Results

The API returns status as a space-separated list of status flags, in increasing order of priority.

The last (right-most) status can be considered the the most important status. e.g. the status for .com is active zone tld, meaning it is in active use (registered), a zone in our database, and a top-level domain (summarized as tld).

Note: Some of the new top-level domain registries sell a subset of their domains as “premium,” e.g. with special tiered pricing. The Status API will mark these with status premium.

These are the responses that appear for status queries:

Status	Example	Description
`unknown`	foobar.llp	Unknown status, usually resulting from an error or misconfiguration.
`undelegated`	hello.edu	The domain is not present in DNS.
`inactive`	nonexistent.xyz	Available for new registration.
`pending`	heartb.eat	TLD not yet in the root zone file.
`disallowed`	a.mobi	Disallowed by the registry, ICANN, or other (wrong script, etc.).
`claimed`	fedex.name	Claimed or reserved by some party (not available for new registration).
`reserved`	s.work	Explicitly reserved by ICANN, the registry, or another party.
`dpml`	google.bargains	Domains Protected Marks List, reserved for trademark holders.
`invalid`	A domain longer than 64 characters.	Technically invalid, e.g. too long or too short.
`active`	vertical.coffee	Registered, but possibly available via the aftermarket.
`parked`	wi.io	Active and parked, possibly available via the aftermarket.
`marketed`	wi.io	Explicitly marketed as for sale via the aftermarket.
`expiring`	An expiring domain.	e.g. in the Redemption Grace Period, and possibly available via a backorder service. Not guaranteed to be present for all `expiring` domains.
`deleting`	A expired domain pending removal from the registry.	e.g. in the Pending Delete phase, and possibly available via a backorder service. Not guaranteed to be present for all `deleting` domains.
`priced`	An aftermarket domain with an explicit price.	e.g. via the BuyDomains service.
`transferable`	An aftermarket domain available for fast-transfer.	e.g. in the Afternic inventory.
`premium`	ace.pizza	Premium domain name for sale by the registry.
`suffix`	blogspot.com	A public suffix according to publicsuffix.org.
`zone`	.co.uk	A zone (domain extension) in the Domainr database.
`tld`	.com	A top-level domain.

*Note: the summary field in API responses is deprecated. It is a developer-centric hint about the most significant status present, not the final availability status. The status values represent the actual availability status.