V1 API

Notice: Usage of this API subject to the Domainr API Terms of Use.

Introduction

The base URL for all V1 requests: https://api.domainr.com/v1

The Domainr V1 API has two methods: Search and Info. Each responds to a GET request. When called with the optional callback parameter, the return value will be wrapped with your callback function:

https://api.domainr.com/v1/info?callback=foobar&client_id=example&q=domai.nr

foobar({"query":"domainr", "results":[]})

Methods

Search

Responds to a GET request with the arguments specified in the query string:

https://api.domainr.com/v1/search?client_id=example&q=domai.nr

The server will respond with a JSON object:

{
  "query": "domai.nr",
  "results": [{
    "domain": "domai.nr",
    "register_url": "http://domai.nr/domai.nr/register",
    "host": "",
    "path": "",
    "subdomain": "domai.nr",
    "availability": "taken"
  },
  {
    "domain": "dom.ai",
    "register_url": "https://domainr.com/dom.ai/register",
    "host": "",
    "path": "/nr",
    "subdomain": "dom.ai",
    "availability": "available"
  },
  {
    "domain": "doma.in",
    "register_url": "https://domainr.com/doma.in/register",
    "host": "",
    "path": "/r",
    "subdomain": "doma.in",
    "availability": "taken"
  },
  {
    "domain": "do.ma",
    "register_url": "https://domainr.com/do.ma/register",
    "host": "",
    "path": "/i.nr",
    "subdomain": "do.ma",
    "availability": "maybe"
  },
  {
    "domain": "d.om",
    "register_url": "https://domainr.com/d.om/register",
    "host": "",
    "path": "/ai.nr",
    "subdomain": "d.om",
    "availability": "unavailable"
  },
  {
    "domain": "do",
    "register_url": "https://domainr.com/do/register",
    "host": "",
    "path": "/mai.nr",
    "subdomain": "do",
    "availability": "tld"
  }]
}

Availability status:

• available: the domain has not yet been registered.
• taken: the domain is registered or reserved.
• unavailable: registration of the domain isn’t permitted. Example: foo.ck
• maybe: the domain may or may not be registered, caused by a TLD with flaky or wildcard DNS.
• known: the result is a known second-level domain or registrar. Examples: .co.jp, godaddy.com
• tld: the result is a TLD. Examples: .com, .io
• unknown: Domainr cannot determine the status or availability of the domain.

The server will return errors, if any, in a top level key in the response object:

{
  "query": "",
  "results": [],
  "error": {
    "status": 404,
    "message": "No results found."
  }
}

Info

Responds to a GET request with the arguments specified in the query string:

https://api.domainr.com/v1/info?client_id=example&q=domai.nr

The response will be a JSON object:

{
  "domain": "domai.nr",
  "whois_url": "https://domainr.com/domai.nr/whois",
  "register_url": "https://domainr.com/domai.nr/register",
  "tld": {
    "domain": "nr",
    "domain_idna": "nr",
    "wikipedia_url": "http://wikipedia.org/wiki/.nr",
    "iana_url": "http://www.iana.org/domains/root/db/nr.html"
  },
  "registrars": [{
    "registrar": "cenpac.net.nr",
    "name": "CenpacNET",
    "register_url": "https://domainr.com/domai.nr/register/cenpac.net.nr"
  }],
  "host": "",
  "path": "",
  "www_url": "https://domainr.com/domai.nr/www",
  "query": "domai.nr",
  "subdomain": "domai.nr",
  "domain_idna": "domai.nr",
  "availability": "taken"
}