Domain Availability Check API
==============================

The Domain Availability Check API will return the status of domains submitted via the API. 

There are 2 versions avaialble. One for a single domain which will return just the status of the specific domain and one for multiple domains which will return the status of each domain and each version of the domain.


**API address**

https://api.irs.net.nz

**Single domain input parameter**

Domain name (a-label or u-label):

* /api/domain/validate?domain=<domain-name>

**Output parameters**

* Domain name
* Status

.. Note:: Multiple statuses can be displayed for a single availability check. All relevant statuses will be listed in the response.

Possible status options:

* Available
* Registered
* Premium
* Blocked
* Blocked Override
* Bundle
* Invalid -- possible reasons for an invalid response are:

    * TLD: the TLD does not match the Registry TLD
    * Length: the length of the domain name is not within the configuration bounds
    * Levels: the domain does not have a zone or a level tag that allows its creation
    * Level length: the subdomain levels are not within the configuration bounds
    * Syntax: the domain did not pass the syntax check
    * IDN: the IDN domain name contains an invalid character

**Sample output:**

.. code-block:: xml

    {
        "domainName" : "testdomain.nz",
        "statuses" : [ "REGISTERED" ]
    }


To display the status for one or more domains and their availability at all possible additional levels, use the following:

**Multiple domain input parameters**

Domain name (a-label or u-label):

* /api/domains/validate?domains=<DOMAIN-NAME>[&domains=<DOMAIN-NAME2>,...]

**Example:**

* /api/domains/validate?domains=test.nz&domains=test2.nz


**Output parameters**

* Domain names and their availability at all the possible additional levels
* Status

**Sample output:**

.. code-block:: xml

 [ {
  "domain" : "test",
  "results" : [ {
    "domainName" : "test.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.ac.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.co.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.geek.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.gen.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.kiwi.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.maori.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.net.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.org.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.school.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.iwi.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.govt.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.health.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.cri.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.mil.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test.parliament.nz",
    "statuses" : [ "AVAILABLE" ]
  } ]
 }, {
  "domain" : "test2",
  "results" : [ {
    "domainName" : "test2.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.ac.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.co.nz",
    "statuses" : [ "REGISTERED" ]
  }, {
    "domainName" : "test2.geek.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.gen.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.kiwi.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.maori.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.net.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.org.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.school.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.iwi.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.govt.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.health.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.cri.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.mil.nz",
    "statuses" : [ "AVAILABLE" ]
  }, {
    "domainName" : "test2.parliament.nz",
    "statuses" : [ "AVAILABLE" ]
  } ]
 } ]