Top Level Domain Knowledge Base API
domainAPI Datacube translates as a knowledge database around the Top Level Domain and provides you with meaningful information on Top Level Domain extensions. When requesting information about a specific TLD (gTLD or ccTLD), domainAPI Datacube retrieves information linked to the country associated with that TLD. It includes details of the Registry, restrictions applicable to that TLD (like for example the need for a local presence or the minimum and maximum number of characters a domain may hold). In addition it will display general information on the country (flag, map, name of the Region it belongs to, its capital, the size of its population and territory, its currency, etc.) and some data on its telecoms (number of landlines, mobile, broadcasting media, internet user base, etc). A great little API allowing you to retrieve useful information linked to TLDs.
Parameters of the Top Level Domain Knowledge Base API
| Name | required? | Description | Default | Authorized | Example |
| app |
no |
to allow to select specific data, if no app is set, only a part of data will be returned |
|
additionalData, attribute, countryinfo, countrycommunication, countrycommunication, countryflag, countrymap, countrylocation, restriction, tldinfo, |
app |
Response groups of the Top Level Domain Knowledge Base API
| Name | Description |
| name |
Name of the tld |
| countryCode |
Country code of the tld |
| country |
Country of the tld |
| region |
Region of the tld |
| attribute name |
Name of specific tld attributes |
| additionalData name |
Additional info required for a tld |
| additionalData linkedTo |
With which is connected the additioanl info (with domain or contact) |
| typeAction |
With which kind of action(new,update,renew,transfer...) the additionalData is required |
| validator |
What kind of validation must be done on the additionalData |
| restriction name |
Naming Conventions parameters name |
| restriction value |
Naming Conventions parameters value |
| whois port |
Whois port |
| whois server |
Whois server |
| whois type |
Whois type (ote,production...) |
| whois websiteUrl |
Url of the whois website |
Example of the Top Level Domain Knowledge Base API
JSON
Request
Show/Hidden apache code
GET /encrypted-area HTTP/1.1
Host: api.domainapi.com/v1/datacube/fr
Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
Response
Show/Hidden apache code
Server: Apache-Coyote/1.1
Content-Type: application/json
Transfer-Encoding: chunked
Date: Fri, 31 Mar 2010 11:15:01 GMT
Show/Hidden javascript code
{
"service":"datacube",
"domain":"eu",
"timestamp":1270026401,
"content":{
"tld":{
"name":"eu",
"whoisList":[
{
"port":43,
"server":"whois.eu",
"type":"production",
"websiteUrl":"http:\/\/www2.whois.eu\/whois\/GetDomainStatus.htm?domainName=%%domain%%"
}
],
"type":{
"name":"Country code",
"abbreviation":"CC"
},
"country":{
"region":{
"name":"Europe",
"abbr":"EUR"
},
"name":"European Union",
"countryCode":"EU"
}
}
}
}
XML
Request
Show/Hidden apache code
GET /encrypted-area HTTP/1.1
Host: api.domainapi.com/v1/datacube/xml/fr
Authorization: Basic YWtpcmF0ZXN0OmR0d3N0ZXN0
Response
Show/Hidden xml code
<response>
<service>datacube</service>
<domain>eu</domain>
<timestamp>1270026401</timestamp>
<content>
<tld>
<name>eu</name>
<whoisList>
<whoisserver>
<port>43</port>
<server>whois.eu</server>
<type>production</type>
<websiteUrl>http://www2.whois.eu/whois/GetDomainStatus.htm?domainName=%%domain%%</websiteUrl>
</whoisserver>
</whoisList>
<type>
<name>Country code</name>
<abbreviation>CC</abbreviation>
</type>
<country>
<region>
<name>Europe</name>
<abbr>EUR</abbr>
</region>
<name>European Union</name>
<countryCode>EU</countryCode>
</country>
</tld>
</content>
</response>
