- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Domain tasks
Domain info
Function
The DomainInfo task displays the data of a domain if the domain is registered and is in the user's database and access.
The additional parameter full_contact (XML) respectively fullContact (JSON) is available for querying the domain data, with which the data of all domain contacts can be displayed.
Description
Route: GET /domain/{name}
There is no need to send a body.
Further data can be obtained via the following parameters:
- expire
- domainCreated
- ownerc
- adminc
- techc
- zonec
{
}{
"stid": "20190628-app2-dev-23822",
"status": {
"code": "S0105",
"text": "Domain data has been inquired successfully.",
"type": "SUCCESS"
},
"object": {
"type": "Domain",
"value": "example.com"
},
"data": [
{
"created": "2019-06-28T15:12:51.000+0200",
"updated": "2019-06-28T15:13:09.000+0200",
"owner": {
"context": 4,
"user": "exampleuser"
},
"updater": {
"context": 4,
"user": "exampleuser"
},
"name": "example-domain-321.com",
"domainCreated": "2019-06-28T15:12:51.000+0200",
"registryStatus": "LOCK",
"nameServers": [
{
"name": "ns1.example-nameserver.com"
},
{
"name": "ns2.example-nameserver.com"
}
],
"period": {
"unit": "YEAR",
"period": 1
},
"trustee": false,
"privacy": false,
"authinfo": "5DnRg7+Facz9xXos",
"domainsafe": false,
"registrarStatus": "ACTIVE",
"rddsOptIn": "NOT_SET",
"ownerc": {
"id": 23142212
},
"adminc": {
"id": 23142212
},
"techc": {
"id": 23142212
},
"payable": "2020-06-28T15:12:51.000+0200",
"validCertificate": false,
"autoRenewStatus": "TRUE"
}
]
}Example of using the parameters
GET /domain/{name}?fullContact[]=ownerc&fullContact[]=adminc&keys[]=domainCreated?keys[]=expire
Task code: 0105
Uses Domain object
The data of the following keywords can be enquired with the keyword <key>:
- expire (only for some TLDs)
- domain_created
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0105</code>
<domain>
<name>example.com</name>
</domain>
</task>
</request><response>
<result>
<data>
<domain>
<name>example.com</name>
<domain_created>2017-02-28 23:59:59</domain_created>
<payable>2018-02-28 23:59:59</payable>
<ownerc>21653083</ownerc>
<adminc>21653083</adminc>
<techc>21653083</techc>
<zonec>21653083</zonec>
<registry_status>NONE</registry_status>
<nserver>
<name>ns1.example.com</name>
</nserver>
<nserver>
<name>ns2.example.com</name>
</nserver>
<period>1</period>
<status>SUCCESS</status>
<use_trustee>false</use_trustee>
<use_privacy>false</use_privacy>
<domainsafe>false</domainsafe>
<certificate>false</certificate>
<autorenew>true</autorenew>
<extension/>
<comment>my comment</comment>
<registrar_status>ACTIVE</registrar_status>
<owner>
<user>customer</user>
<context>4</context>
</owner>
<updater>
<user>customer</user>
<context>4</context>
</updater>
<created>2016-12-23 11:01:39</created>
<updated>2018-01-05 16:20:38</updated>
</domain>
</data>
<status>
<code>S0105</code>
<text>Domain data has been inquired successfully.</text>
<type>success</type>
<object>
<type>domain</type>
<value>example.com</value>
</object>
</status>
</result>
<ctid>customer-transaction-id</ctid>
<stid>20160204-app1-test-98130</stid>
</response>