namecheap.domains.getList
Returns a list of domains for the particular user
Request Parameters
Global parameters are not shown here for clarity, but should be present in all requests
| Name | Type | MaxLength | Required? | Default | Description |
| ListType | String | 10 | No | ALL | Possible values are ALL/EXPIRING/EXPIRED |
| SearchTerm | String | 70 | No | | Keyword to look for on the domain list |
| Page | Number | 10 | No | 1 | Page to return |
| PageSize | Number | 10 | No | 20 | Number of domains to be listed in a page. Minimum value is 10 and
maximum value is 100. |
| SortBy | String | 50 | No | | Possible values are NAME, NAME_DESC, EXPIREDATE, EXPIREDATE_DESC,
CREATEDATE, CREATEDATE_DESC |
Example Request
https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&
UserName=apiexample&Command=namecheap.domains.getList&ClientIp=192.168.1.109
Example Response
<?xml version="1.0" encoding="utf-8"?>
<ApiResponse Status="OK" xmlns="http://api.namecheap.com/xml.response">
<Errors />
<RequestedCommand>namecheap.domains.getList</RequestedCommand>
<CommandResponse Type="namecheap.domains.getList">
<DomainGetListResult>
<Domain ID="127" Name="domain1.com" User="owner" Created="02/15/2005"
Expires="02/15/2008" IsExpired="false" IsLocked="false"
AutoRenew="false" WhoisGuard="ENABLED" />
<Domain ID="381" Name="domain2.com" User="owner" Created="04/28/2005"
Expires="04/28/2008" IsExpired="false" IsLocked="false"
AutoRenew="true" WhoisGuard="NOTPRESENT" />
</DomainGetListResult>
<Paging>
<TotalItems>2</TotalItems>
<CurrentPage>1</CurrentPage>
<PageSize>10</PageSize>
</Paging>
</CommandResponse>
<Server>SERVER-NAME</Server>
<GMTTimeDifference>+5</GMTTimeDifference>
<ExecutionTime>0.078</ExecutionTime>
</ApiResponse>Error Codes
Specifies the error codes that might be returned from this method
| Number | Description |
| 5019169 | Unknown exceptions while retriving Domain list |