Domain Availability API

 

Parameters of the Domain Availability API

Name required? Description Default Authorized Example
type no Choose the type of the availability request : region or advanced. Region, allow you to search the availability of a domain on a list of regions. Advanced allow you to choose a list of TLD. region region, normal type=region
regions no List of regions wanted, if you choose the type 'region'. eu, gen eu (Europe), aeu (Oceania), gen (Generic), asia, americas, africa regions=eu&regions=gen
tlds no List of tlds wanted, if you choose the type 'advanced'. com, be
tlds=com&tlds=be

Example of the Domain Availability API

JSON

Request on "freedomain.com"
Request

Show/Hidden apache code

View source
 
 
  GET /encrypted-area HTTP/1.1
  Host: api.domainapi.com/v1/availability/freedomain.com
  Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
 
Response

Show/Hidden apache code

View source
 
 
  Server: Apache-Coyote/1.1
  Content-Type: application/json
  Transfer-Encoding: chunked
  Date: Tue, 03 Feb 2009 14:54:59 GMT
 


Show/Hidden javascript code
View source
 
 
  {
    "service":"availability",
    "domain":"freedomain.com",
    "timestamp":1234567890,
    "content":{
      "domainList":[
        {
          "status":"free",
          "name":"freedomain.com"
        }
      ]
    }
  }
 
Request on "takendomain.com"
Query
Show/Hidden apache code
View source
 
  GET /encrypted-area HTTP/1.1
  Host: api.domainapi.com/v1/availability/takendomain.com
  Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
 
Response

Show/Hidden apache code

View source
 
 
  Server: Apache-Coyote/1.1
  Content-Type: application/json
  Transfer-Encoding: chunked
  Date: Tue, 03 Feb 2009 15:09:07 GMT
 

Show/Hidden javascript code
View source
 
 
  {
    "service":"availability",
    "domain":"takendomain.com",
    "timestamp":1234567890,
    "content":{
      "domainList":[
        {
          "status":"taken",
          "name":"takendomain.com"
        }
      ]
    }
  }
 

XML

Request on "freedomain.com"
Query

Show/Hidden apache code

View source
 
 
  GET /encrypted-area HTTP/1.1
  Host: api.domainapi.com/v1/availability/xml/freedomain.com
  Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
 
Response

Show/Hidden xml code

View source
 
 
  <response>
    <service>availability</service>
    <domain>freedomain.com</domain>
    <timestamp>1234567890</timestamp>
    <content>
      <domainList>
        <domain>
          <status>free</status><
          <name>freedomain.com</name>
        </domain>
      </domainList>
    </content>
  </response>
 
  
Request on "taken.com"
Query

Show/Hidden apache code

View source
 
 
  GET /encrypted-area HTTP/1.1
  Host: api.domainapi.com/v1/availability/xml/takendomain.com
  Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
 

 
Response

Show/Hidden xml code

View source
 
 
  <response>
    <service>availability</service>
    <domain>takendomain.com</domain>
    <timestamp>1234567890</timestamp>
    <content>
      <domainList>
        <domain>
          <status>taken</status>
          <name>takendomain.com</name>
        </domain>
      </domainList>
    </content>
  </response>
 
 

Additional information