Domain List

Description

ApiKey

The API key that we provided to you when you requested API access for your account

Password

The password we provided when you requested API access for your account

ExpiringOnly
(optional)

You can set a value X expressed in days and the returned list will include all the domains expiring during the X next days accordingly to the X value you set. By example ExpiringOnly=45 will return the domains expiring during the next 45 days. The list may also include expired domains prior to the date of execution not yet removed from the system.

PendingTransferOnly
(optional)

No value required, if present only domains in Pending Transfer status will be listed. Note you cannot use PendingTransfersOnly and ExpiringOnly at the same time otherwise an error message will be generated.

rangeFrom
(optional)

and
rangeTo
(optional)

By default we only show all domains in your account. If you want the listing to be paginated use these two parameters.
Tip: you can count the domains in your account using the command /Domain/Count

searchTermFilter
(optional)

To get the list of domains that contains a specific text. If you need to get only domains of a specific extension you need to start this parameter with a dot followed by the extension. Ex. If this parameter value is .eu only .eu domains will be returned. Default is empty string. If you wish multiple extensions returned see extension Filter parameter.

CompactList
(optional)

By default we only return the list of domains separated by ;. However you may obtain extra information such as expiration date and registry status if you set CompactList=no. The default value is ComptactList=yes.
Example list with CompactList=yes:
Domain1=example.com
Domain2=example2.com
Domain3=example3.info
Domain4=example4.biz
Example list with CompactList=no:
DomainCount=3
Domain1=example.com
Domain1_Expiration=2009/12/31
Domain1_RegistrarLock=enabled
Domain1_ transferAuthInfo=SWS232DS
Domain2=example2.con
Domain2_Expiration=2010/11/25
Domain2_RegistrarLock=enabled
Domain2_transferAuthInfo=DSF33432D
Domain3=example3.fr
Domain3_Expiration=2009/09/22
Domain3_RegistrarLock=NOTADMITTED
Domain3_transferAuthInfo=

SortBy
(optional)

To specify a sorting criteria. Possible values are: DOMAIN_NAME, DOMAIN_NAME_DESC, EXPIRATION, EXPIRATION_DESC.
Default is SortBy=DOMAIN_NAME.

extensionFilter
(optional)

List of domain extensions which have to be returned. If several extensions needed then comma have to be used as separator, ex.: "com,co.uk" or "eu,asia"

ResponseFormat
(optional)

This specifies how the response will be returned. Possible values are TEXT, JSON and XML.
The default value is TEXT however we encourage you to use JSON for easier result parsing (please refer to http://www.json.org for more details about JSON).