Namecheap API

https://www.namecheap.com/support/api/
Admin
The Namecheap API allows developers to build applications that integrate with Namecheap accounts,...
Tokens:10,429
Snippets:44
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Create Nameserver Request Example

Source: https://www.namecheap.com/support/api/methods/domains-ns/create

An example of the HTTP GET request structure for creating a nameserver.

```http
  1. https://api.namecheap.com/xml.response?ApiUser=apiexmple&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.ns.create&ClientIp=192.168.1.109&SLD=domain&TLD=com&Nameserver=ns1.domain.com&IP=192.165.15.103
```

--------------------------------

### Example Request for namecheap.domains.ns.getInfo

Source: https://www.namecheap.com/support/api/methods/domains-ns/getinfo

A sample HTTP GET request to retrieve nameserver information.

```http
  1. https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.ns.getInfo&ClientIp=192.168.1.109&SLD=domain&TLD=com&Nameserver=ns1.domain.com
```

--------------------------------

### Example GET Request for GetStatus

Source: https://www.namecheap.com/support/api/methods/domains-transfer/get-status

This snippet shows a sample GET request to retrieve the status of a domain transfer. Ensure you replace 'apiexample' and '56b4c87ef4fd49cb96d915c0db68194' with your actual API credentials and '15' with the relevant TransferID.

```http
https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.transfer.getStatus&ClientIp=192.168.1.109&TransferID=15
```

--------------------------------

### GET Request for setHosts

Source: https://www.namecheap.com/support/api/methods/domains-dns/set-hosts

Example of a GET request to set DNS host records. Ensure all required parameters like SLD, TLD, and host record details are included.

```http
  1. https://api.namecheap.com/xml.response?apiuser=demo&apikey=d41474b94e7d4536baabb074a09c96bd&username=demo&Command=namecheap.domains.dns.setHosts&ClientIp=122.178.155.204&SLD=domain51&TLD=com&HostName1=@&RecordType1=URL&Address1=http://www.namecheap.com&TTL1=100&HostName2=mynewcomp&RecordType2=A&Address2=12.56.67.78&TTL2=1000
```

--------------------------------

### Example GET Request for Domain Transfers

Source: https://www.namecheap.com/support/api/methods/domains-transfer/get-list

This snippet shows a sample HTTP GET request to retrieve a list of domain transfers. It includes essential parameters like API user, key, command, client IP, list type, page number, and page size.

```http
http://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&command=namecheap.domains.Transfer.getlist&clientip=192.20.36.51&listtype=all&page=1&pagesize=10
```

--------------------------------

### Delete Nameserver Request Example

Source: https://www.namecheap.com/support/api/methods/domains-ns/delete

An example of the HTTP GET request structure for deleting a nameserver.

```http
  1. https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.ns.delete&ClientIp=192.168.1.109&SLD=domain&TLD=com&Nameserver=ns1.domain.com
```

--------------------------------

### Create Nameserver Response Example

Source: https://www.namecheap.com/support/api/methods/domains-ns/create

The XML response returned upon a successful nameserver creation request.

```xml
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  3.   <Errors />
  4.   <RequestedCommand>namecheap.domains.ns.create</RequestedCommand>
  5.   <CommandResponse Type="namecheap.domains.ns.create">
  6.     <DomainNSCreateResult Domain="domain.com" Nameserver="ns1.domain.com" IP="12.23.23.23" IsSuccess="true" />
  7.   </CommandResponse>
  8.   <Server>SERVER-NAME</Server>
  9.   <GMTTimeDifference>+5</GMTTimeDifference>
  10.   <ExecutionTime>32.76</ExecutionTime>
  11. </ApiResponse>
```

--------------------------------

### Example Response for namecheap.domains.ns.getInfo

Source: https://www.namecheap.com/support/api/methods/domains-ns/getinfo

The XML response structure returned by the API upon a successful request.

```xml
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  3.   <Errors />
  4.   <RequestedCommand>namecheap.domains.ns.getInfo</RequestedCommand>
  5.   <CommandResponse Type="namecheap.domains.ns.getInfo">
  6.     <DomainNSInfoResult Domain="domain.com" Nameserver="ns1.domain.com" IP="12.23.23.23">
  7.       <NameserverStatuses>
  8.         <Status>OK</Status>
  9.         <Status>Linked</Status>
  10.       </NameserverStatuses>
  11.     </DomainNSInfoResult>
  12.   </CommandResponse>
  13.   <Server>SERVER-NAME</Server>
  14.   <GMTTimeDifference>+5</GMTTimeDifference>
  15.   <ExecutionTime>32.76</ExecutionTime>
  16. </ApiResponse>
```

--------------------------------

### Example XML Response for Domain Transfers

Source: https://www.namecheap.com/support/api/methods/domains-transfer/get-list

This snippet provides an example of the XML response structure when requesting a list of domain transfers. It includes details about each transfer, such as ID, domain name, transfer date, status, and order information, along with paging details.

```xml
<?xml version="1.0" encoding="utf-8"?>
<ApiResponse Status="OK">
  <Errors/>
  <Warnings/>
  <RequestedCommand>namecheap.domains.transfer.getList</RequestedCommand>
  <CommandResponse Type="namecheap.domains.transfer.getList">
    <TransferGetListResult>
      <Transfer ID="59" Domainname="domain1.com" User="apiexample" TransferDate="02/15/2010" OrderID="32060156"StatusID="20" Status="CANCELLED" StatusDate="03/27/2010" StatusDescription="Canceled - Domain is currently not registered and cannot be transferrred"/>
      <Transfer ID="75" Domainname="domain8.co.uk" User="apiexample" TransferDate="04/13/2010" OrderID="32060636" StatusID="4" Status="INPROGRESS" StatusDate="03/14/2010" StatusDescription="Canceled due to domain status"/>
      <Transfer ID="77" Domainname="domain18.com" User="apiexample" TransferDate="06/01/2010" OrderID="32061647" StatusID="15" Status="CANCELLED" StatusDate="07/05/2010" StatusDescription="Canceled - cannot obtain domain contacts from UWhois"/>
      <Transfer ID="78" Domainname="domain57.com" User="apiexample" TransferDate="06/05/2010" OrderID="32061629" StatusID="15" Status="CANCELLED" StatusDate="07/05/2010" StatusDescription="Canceled - cannot obtain domain contacts from UWhois"/>
    </TransferGetListResult>
    <Paging>
      <TotalItems>49</TotalItems>
      <CurrentPage>1</CurrentPage>
      <PageSize>10</PageSize>
    </Paging>
  </CommandResponse>
  <Server>SERVER-NAME</Server>
  <GMTTimeDifference>--7:00</GMTTimeDifference>
  <ExecutionTime>0.096</ExecutionTime>
</ApiResponse>
```

--------------------------------

### Example API Response for setHosts

Source: https://www.namecheap.com/support/api/methods/domains-dns/set-hosts

A sample XML response returned by the namecheap.domains.dns.setHosts method indicating a successful operation.

```xml
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <ApiResponse xmlns="https://api.namecheap.com/xml.response" Status="OK">
  3.   <Errors />
  4.   <RequestedCommand>namecheap.domains.dns.setHosts</RequestedCommand>
  5.   <CommandResponse Type="namecheap.domains.dns.setHosts">
  6.     <DomainDNSSetHostsResult Domain="domain51.com" IsSuccess="true" />
  7.   </CommandResponse>
  8.   <Server>SERVER-NAME</Server>
  9.   <GMTTimeDifference>+5</GMTTimeDifference>
  10.   <ExecutionTime>32.76</ExecutionTime>
  11. </ApiResponse>
```

--------------------------------

### POST Request for setHosts

Source: https://www.namecheap.com/support/api/methods/domains-dns/set-hosts

Example of a JSON-formatted POST request for setting multiple DNS host records. Substitute the placeholder keys and values with your specific domain configuration.

```json
  1. {
  2.   "authDetails":{
  3.     "ParentUserType":"",
  4.     "ParentUserId":0,
  5.     "UserId":"",
  6.     "UserName":"",
  7.     "ClientIp":"",
  8.     "EndUserIp":"",
  9.     "AdminUserName":"",
  10.     "DisableSecurityNotification":true,
  11.     "AllowWhenDomainLocked":true,
  12.     "ProceedWhenDomainLockedFlag":true,
  13.     "DefaultChargeForUserName":"",
  14.     "Roles":[
  15.       "User"
  16.     ]
  17.   },
  18.   "request":{
  19.     "RequestValues":[
  20.       {
  21.         "Key":"HostName1",
  22.         "Value":"@"
  23.       },
  24.       {
  25.         "Key":"RecordType1",
  26.         "Value":"A"
  27.       },
  28.       {
  29.         "Key":"Address1",
  30.         "Value":"213.87.128.103"
  31.       },
  32.       {
  33.         "Key":"TTL1",
  34.         "Value":"3600"
  35.       },
  36.       {
  37.         "Key":"HostName2",
  38.         "Value":"@"
  39.       },
  40.       {
  41.         "Key":"RecordType2",
  42.         "Value":"AAAA"
  43.       },
  44.       {
  45.         "Key":"Address2",
  46.         "Value":"8f1f:6f14:ca8e:e50c:6a3a:7f30:2814:5d70"
  47.       },
  48.       {
  49.         "Key":"TTL2",
  50.         "Value":"300"
  51.       },
  52.       {
  53.         "Key":"HostName3",
  54.         "Value":"@"
  55.       },
  56.       {
  57.         "Key":"RecordType3",
  58.         "Value":"CAA"
  59.       },
  60.       {
  61.         "Key":"Address3",
  62.         "Value":"0 issue \"iva.name\""
  63.       },
  64.       {
  65.         "Key":"TTL3",
  66.         "Value":"1800"
  67.       },
  68.       {
  69.         "Key":"HostName4",
  70.         "Value":"www"
  71.       },
  72.       {
  73.         "Key":"RecordType4",
  74.         "Value":"CNAME"
  75.       },
  76.       {
  77.         "Key":"Address4",
  78.         "Value":"chasity.biz."
  79.       },
  80.       {
  81.         "Key":"TTL4",
  82.         "Value":"1200"
  83.       },
  84.       {
  85.         "Key":"HostName5",
  86.         "Value":"dk1024-2012._domainkey.returnpath.com."
  87.       },
  88.       {
  89.         "Key":"RecordType5",
  90.         "Value":"TXT"
  91.       },
  92.       {
  93.         "Key":"Address5",
  94.         "Value":"Aut et sed sit quos aut harum omnis molestias asperiores."
  95.       },
  96.       {
  97.         "Key":"TTL5",
  98.         "Value":"1200"
  99.       },
  100.       {
  101.         "Key":"HostName6",
  102.         "Value":"ns"
  103.       },
  104.       {
  105.         "Key":"RecordType6",
  106.         "Value":"NS"
  107.       },
  108.       {
  109.         "Key":"Address6",
  110.         "Value":"gabriel.info."
  111.       },
  112.       {
  113.         "Key":"TTL6",
  114.         "Value":"3600"
  115.       }
  116.     ],
  117.     "SLD":"msvec1664270616687",
  118.     "TLD":"xyz"
  119.   }
  120. }
```

--------------------------------

### Delete Nameserver Response Example

Source: https://www.namecheap.com/support/api/methods/domains-ns/delete

The XML response returned upon a successful nameserver deletion.

```xml
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  3.   <Errors />
  4.   <RequestedCommand>namecheap.domains.ns.delete</RequestedCommand>
  5.   <CommandResponse Type="namecheap.domains.ns.delete">
  6.     <DomainNSDeleteResult Domain="domain.com" Nameserver="ns1.domain.com" IsSuccess="true" />
  7.   </CommandResponse>
  8.   <Server>SERVER-NAME</Server>
  9.   <GMTTimeDifference>+5</GMTTimeDifference>
  10.   <ExecutionTime>32.76</ExecutionTime>
  11. </ApiResponse>
```

--------------------------------

### Update Nameserver IP Request

Source: https://www.namecheap.com/support/api/methods/domains-ns/update

Example of an HTTP GET request to update a nameserver's IP address.

```http

  1. https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.ns.update&ClientIp=192.168.1.109&SLD=domain&TLD=com&Nameserver=ns1.domain.com&OldIP=192.165.15.103&IP=12.45.63.32


```

--------------------------------

### domains.transfer.getList

Source: https://www.namecheap.com/support/api/methods/domains-transfer

Gets the list of domain transfers.

```APIDOC
## domains.transfer.getList

### Description
Gets the list of domain transfers.

### Method
POST

### Endpoint
/xmlrpc

### Parameters
#### Request Body
- **AuthId** (string) - Required - Your authentication ID.
- **AuthUser** (string) - Required - Your authentication username.
- **ClientIp** (string) - Required - The IP address of the client making the request.
- **Password** (string) - Required - Your API password.
- **Filter** (string) - Optional - Filter criteria for the list (e.g., 'All', 'InProcess', 'Completed', 'Failed').
```

--------------------------------

### Update Nameserver IP Response

Source: https://www.namecheap.com/support/api/methods/domains-ns/update

Example of the XML response returned after a successful nameserver update.

```xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  3.   <Errors />
  4.   <RequestedCommand>namecheap.domains.ns.update</RequestedCommand>
  5.   <CommandResponse Type="namecheap.domains.ns.update">
  6.     <DomainNSUpdateResult Domain="domain.com" Nameserver="ns1.domain.com" IsSuccess="true" />
  7.   </CommandResponse>
  8.   <Server>SEVER-ONE</Server>
  9.   <GMTTimeDifference>+5</GMTTimeDifference>
  10.   <ExecutionTime>32.76</ExecutionTime>
  11. </ApiResponse>


```

--------------------------------

### Example XML Response for GetStatus

Source: https://www.namecheap.com/support/api/methods/domains-transfer/get-status

This is a sample XML response indicating the status of a domain transfer. The 'Status' attribute provides a human-readable description of the transfer's current state.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  <Errors />
  <RequestedCommand>namecheap.domains.transfer.getStatus</RequestedCommand>
  <CommandResponse Type="namecheap.domains.transfer.getstatus">
    <DomainTransferGetStatusResult TransferID="15" Status="Queued for submission" StatusID="-1" />
  </CommandResponse>
  <Server>EV1SERVE-3CQ3CC</Server>
  <GMTTimeDifference>+5</GMTTimeDifference>
  <ExecutionTime>0.031</ExecutionTime>
</ApiResponse>
```

--------------------------------

### domains.transfer.getStatus

Source: https://www.namecheap.com/support/api/methods/domains-transfer

Gets the status of a particular domain transfer.

```APIDOC
## domains.transfer.getStatus

### Description
Gets the status of a particular domain transfer.

### Method
POST

### Endpoint
/xmlrpc

### Parameters
#### Request Body
- **TransferId** (integer) - Required - The ID of the transfer.
- **AuthId** (string) - Required - Your authentication ID.
- **AuthUser** (string) - Required - Your authentication username.
- **ClientIp** (string) - Required - The IP address of the client making the request.
- **Password** (string) - Required - Your API password.
```

--------------------------------

### Example API Response for Domain Transfer

Source: https://www.namecheap.com/support/api/methods/domains-transfer/create

This XML structure represents a successful response from the domain transfer creation API call. It includes details like TransferID and ChargedAmount.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  <Errors />
  <RequestedCommand>namecheap.domains.transfer.create</RequestedCommand>
  <CommandResponse Type="namecheap.domains.transfer.create">
    <DomainTransferCreateResult Domainname="domain.com" Transfer="true" TransferID="15" StatusID="-1" OrderID="575" TransactionID="759" ChargedAmount="8.88" StatusCode="2" />
  </CommandResponse>
  <Server>EV1SERVE-3CQ3CC</Server>
  <GMTTimeDifference>+5</GMTTimeDifference>
  <ExecutionTime>0.25</ExecutionTime>
</ApiResponse>
```

--------------------------------

### namecheap.domains.transfer.getList

Source: https://www.namecheap.com/support/api/methods/domains-transfer/get-list

Gets the list of domain transfers. This method allows you to retrieve information about domain transfers, supporting various filters and pagination options.

```APIDOC
## namecheap.domains.transfer.getList

### Description
Gets the list of domain transfers. This method allows you to retrieve information about domain transfers, supporting various filters and pagination options.

### Method
GET

### Endpoint
http://api.namecheap.com/xml.response

### Parameters
#### Query Parameters
- **ApiUser** (string) - Required - Your Namecheap API username.
- **ApiKey** (string) - Required - Your Namecheap API key.
- **UserName** (string) - Required - The username with which you are logged.
- **command** (string) - Required - The command to be executed, which is 'namecheap.domains.Transfer.getlist'.
- **clientip** (string) - Required - The IP address of the client.
- **ListType** (string) - Optional - Possible values are ALL, INPROGRESS, CANCELLED, COMPLETED. Default Value: ALL.
- **SearchTerm** (string) - Optional - The keyword should be a domain name.
- **Page** (number) - Optional - Page to return. Default Value: 1.
- **PageSize** (number) - Optional - Number of transfers to be listed on a page. Minimum value: 10; Maximum value: 100. Default Value: 10.
- **SortBy** (string) - Optional - Possible values are DOMAINNAME, DOMAINNAME_DESC, TRANSFERDATE, TRANSFERDATE_DESC, STATUSDATE, STATUSDATE_DESC. Default Value: DOMAINNAME.

### Request Example
```
http://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&command=namecheap.domains.Transfer.getlist&clientip=192.20.36.51&listtype=all&page=1&pagesize=10
```

### Response
#### Success Response (200)
- **TransferID** (integer) - A unique integer value that represents the transfer.
- **Domainname** (string) - The domain name associated with the transferID.
- **User** (string) - The user account to which the domain is transferred.
- **TransferDate** (string) - Indicates the date at which transfer was initiated.
- **OrderID** (integer) - A unique integer value that represents the order.
- **StatusID** (integer) - An integer value that indicates the current transfer status.
- **Status** (string) - Transfer status.
- **StatusDate** (string) - The date at which the status was updated.
- **StatusDescription** (string) - Transfer status description.

#### Response Example
```xml
<?xml version="1.0" encoding="utf-8"?>
<ApiResponse Status="OK">
  <Errors/>
  <Warnings/>
  <RequestedCommand>namecheap.domains.transfer.getList</RequestedCommand>
  <CommandResponse Type="namecheap.domains.transfer.getList">
    <TransferGetListResult>
      <Transfer ID="59" Domainname="domain1.com" User="apiexample" TransferDate="02/15/2010" OrderID="32060156"StatusID="20" Status="CANCELLED" StatusDate="03/27/2010" StatusDescription="Canceled - Domain is currently not registered and cannot be transferrred"/>
      <Transfer ID="75" Domainname="domain8.co.uk" User="apiexample" TransferDate="04/13/2010" OrderID="32060636" StatusID="4" Status="INPROGRESS" StatusDate="03/14/2010" StatusDescription="Canceled due to domain status"/>
      <Transfer ID="77" Domainname="domain18.com" User="apiexample" TransferDate="06/01/2010" OrderID="32061647" StatusID="15" Status="CANCELLED" StatusDate="07/05/2010" StatusDescription="Canceled - cannot obtain domain contacts from UWhois"/>
      <Transfer ID="78" Domainname="domain57.com" User="apiexample" TransferDate="06/05/2010" OrderID="32061629" StatusID="15" Status="CANCELLED" StatusDate="07/05/2010" StatusDescription="Canceled - cannot obtain domain contacts from UWhois"/>
    </TransferGetListResult>
    <Paging>
      <TotalItems>49</TotalItems>
      <CurrentPage>1</CurrentPage>
      <PageSize>10</PageSize>
    </Paging>
  </CommandResponse>
  <Server>SERVER-NAME</Server>
  <GMTTimeDifference>--7:00</GMTTimeDifference>
  <ExecutionTime>0.096</ExecutionTime>
</ApiResponse>
```

### Error Codes
- **4019329**: TransferStatus not available
- **2010293**: No Action Specified
- **5050900**: Unhandled exceptions
```

--------------------------------

### namecheap.domains.transfer.getStatus

Source: https://www.namecheap.com/support/api/methods/domains-transfer/get-status

Gets the status of a particular domain transfer. Requires the unique Transfer ID obtained after initiating the transfer.

```APIDOC
## GET namecheap.domains.transfer.getStatus

### Description
Retrieves the current status of a domain transfer using its unique Transfer ID.

### Method
GET

### Endpoint
https://api.namecheap.com/xml.response

### Parameters
#### Query Parameters
- **ApiUser** (string) - Required - Your Namecheap API username.
- **ApiKey** (string) - Required - Your Namecheap API key.
- **UserName** (string) - Required - Your Namecheap username (often the same as ApiUser).
- **Command** (string) - Required - The command to execute, which is 'namecheap.domains.transfer.getStatus'.
- **ClientIp** (string) - Required - The IP address of the client making the request.
- **TransferID** (Number) - Required - The unique ID of the transfer to check the status for.

### Request Example
```xml
https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.transfer.getStatus&ClientIp=192.168.1.109&TransferID=15
```

### Response
#### Success Response (200)
- **TransferID** (integer) - The unique ID of the transfer.
- **StatusID** (integer) - An integer representing the current status of the transfer.
- **Status** (string) - A human-readable description of the transfer status.

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  <Errors />
  <RequestedCommand>namecheap.domains.transfer.getStatus</RequestedCommand>
  <CommandResponse Type="namecheap.domains.transfer.getstatus">
    <DomainTransferGetStatusResult TransferID="15" Status="Queued for submission" StatusID="-1" />
  </CommandResponse>
  <Server>EV1SERVE-3CQ3CC</Server>
  <GMTTimeDifference>+5</GMTTimeDifference>
  <ExecutionTime>0.031</ExecutionTime>
</ApiResponse>
```

### Error Codes
- **4019329**: TransferStatus not available
- **5050900**: Unhandled exceptions
```

--------------------------------

### Domain Transfer Request with Base64 Encoded EPP Code

Source: https://www.namecheap.com/support/api/methods/domains-transfer/create

When an EPP code contains special characters, it must be base64 encoded and prefixed with 'base64:'. This example demonstrates the correct format.

```http
https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.transfer.create&ClientIp=192.168.1.109&DomainName=domain.com&Years=1&EPPCode=base64:cjY3OTBsJjg5ayQ2OD4=
```

--------------------------------

### domains.ns.create

Source: https://www.namecheap.com/support/api/methods/domains-ns

Creates a new nameserver associated with a domain.

```APIDOC
## domains.ns.create

### Description
Creates a new nameserver.

### Method
POST

### Endpoint
/domains.ns.create

### Parameters
#### Query Parameters
- **DomainName** (string) - Required - The domain name for which to create the nameserver.
- **Nameserver** (string) - Required - The hostname of the nameserver to create.
- **IP** (string) - Required - The IP address of the nameserver.

### Request Example
```json
{
  "DomainName": "example.com",
  "Nameserver": "ns1.example.com",
  "IP": "192.168.1.1"
}
```

### Response
#### Success Response (200)
- **Status** (string) - Indicates the success of the operation.
- **Errors** (array) - A list of errors, if any.
- **RequestedID** (string) - The ID of the request.
- **CommandResponse** (object) - Contains details about the command execution.
  - **NameserverCreateResult** (object)
    - **Domain** (string) - The domain name.
    - **Nameserver** (string) - The created nameserver.
    - **IP** (string) - The IP address of the nameserver.

#### Response Example
```json
{
  "Status": "OK",
  "Errors": [],
  "RequestedID": "some-request-id",
  "CommandResponse": {
    "NameserverCreateResult": {
      "Domain": "example.com",
      "Nameserver": "ns1.example.com",
      "IP": "192.168.1.1"
    }
  }
}
```
```

--------------------------------

### domains.ns.getInfo

Source: https://www.namecheap.com/support/api/methods/domains-ns

Retrieves information about a registered nameserver.

```APIDOC
## domains.ns.getInfo

### Description
Retrieves information about a registered nameserver.

### Method
GET

### Endpoint
/domains.ns.getInfo

### Parameters
#### Query Parameters
- **DomainName** (string) - Required - The domain name.
- **Nameserver** (string) - Required - The hostname of the nameserver.

### Request Example
```json
{
  "DomainName": "example.com",
  "Nameserver": "ns1.example.com"
}
```

### Response
#### Success Response (200)
- **Status** (string) - Indicates the success of the operation.
- **Errors** (array) - A list of errors, if any.
- **RequestedID** (string) - The ID of the request.
- **CommandResponse** (object) - Contains details about the command execution.
  - **NameserverInfoResult** (object)
    - **Domain** (string) - The domain name.
    - **Nameserver** (string) - The nameserver hostname.
    - **IP** (string) - The IP address of the nameserver.

#### Response Example
```json
{
  "Status": "OK",
  "Errors": [],
  "RequestedID": "some-request-id",
  "CommandResponse": {
    "NameserverInfoResult": {
      "Domain": "example.com",
      "Nameserver": "ns1.example.com",
      "IP": "192.168.1.1"
    }
  }
}
```
```

--------------------------------

### domains.transfer.create

Source: https://www.namecheap.com/support/api/methods/domains-transfer

Transfers a domain to Namecheap. Supports a specific list of TLDs including .biz, .ca, .cc, .co, .co.uk, .com, .com.es, .com.pe, .es, .in, .info, .me, .me.uk, .mobi, .net, .net.pe, .nom.es, .org, .org.es, .org.pe, .org.uk, .pe, .tv, .us.

```APIDOC
## domains.transfer.create

### Description
Transfers a domain to Namecheap. Supports a specific list of TLDs including .biz, .ca, .cc, .co, .co.uk, .com, .com.es, .com.pe, .es, .in, .info, .me, .me.uk, .mobi, .net, .net.pe, .nom.es, .org, .org.es, .org.pe, .org.uk, .pe, .tv, .us.

### Method
POST

### Endpoint
/xmlrpc

### Parameters
#### Request Body
- **DomainName** (string) - Required - The domain name to transfer.
- **AuthId** (string) - Required - Your authentication ID.
- **AuthUser** (string) - Required - Your authentication username.
- **ClientIp** (string) - Required - The IP address of the client making the request.
- **Password** (string) - Required - Your API password.
- **TransferProtection** (boolean) - Optional - Whether to enable transfer protection.
```

--------------------------------

### namecheap.domains.transfer.create

Source: https://www.namecheap.com/support/api/methods/domains-transfer/create

Initiates the transfer of a domain to Namecheap. Supports various TLDs and includes options for promotion codes and domain privacy.

```APIDOC
## namecheap.domains.transfer.create

### Description
Initiates the transfer of a domain to Namecheap. Supports various TLDs and includes options for promotion codes and domain privacy.

### Method
POST

### Endpoint
https://api.namecheap.com/xml.response

### Parameters
#### Query Parameters
- **ApiUser** (String) - Required - Your Namecheap API username.
- **ApiKey** (String) - Required - Your Namecheap API key.
- **UserName** (String) - Required - Your Namecheap username.
- **Command** (String) - Required - The command to execute, which is `namecheap.domains.transfer.create`.
- **ClientIp** (String) - Required - The IP address of the client making the request.
- **DomainName** (String) - Required - Domain name to transfer (Max Length: 70).
- **Years** (String) - Required - Duration of the transfer in years. Should be set to 1.
- **EPPCode** (String) - Required - The EPPCode for the domain transfer (Max Length: 20). Special characters must be base64 encoded.
- **PromotionCode** (String) - Optional - Promotional (coupon) code for transfer (Max Length: 20).
- **AddFreeWhoisguard** (String) - Optional - Adds free domain privacy for the domain (Default: Yes, Max Length: 3).
- **WGenable** (String) - Optional - Enables free domain privacy for the domain (Default: No, Max Length: 3).

### Request Example
```json
{
  "ApiUser": "apiexample",
  "ApiKey": "56b4c87ef4fd49cb96d915c0db68194",
  "UserName": "apiexample",
  "Command": "namecheap.domains.transfer.create",
  "ClientIp": "192.168.1.109",
  "DomainName": "domain.com",
  "Years": "1",
  "EPPCode": "213456234554454453"
}
```

### Response
#### Success Response (200)
- **DomainName** (String) - The domain name that you are trying to transfer to Namecheap.
- **Transfer** (Boolean) - Indicates whether the transfer order was placed successfully.
- **TransferID** (Integer) - A unique integer value that represents the transfer.
- **StatusID** (Integer) - An integer value that indicates the current transfer status.
- **ChargedAmount** (Float) - The total amount charged for the transfer.
- **OrderID** (Integer) - A unique integer value that represents the order.
- **TransactionID** (Integer) - A unique integer value that represents the transaction.
- **StatusCode** (Integer) - Indicates the current transfer status.

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<ApiResponse xmlns="http://api.namecheap.com/xml.response" Status="OK">
  <Errors />
  <RequestedCommand>namecheap.domains.transfer.create</RequestedCommand>
  <CommandResponse Type="namecheap.domains.transfer.create">
    <DomainTransferCreateResult Domainname="domain.com" Transfer="true" TransferID="15" StatusID="-1" OrderID="575" TransactionID="759" ChargedAmount="8.88" StatusCode="2" />
  </CommandResponse>
  <Server>EV1SERVE-3CQ3CC</Server>
  <GMTTimeDifference>+5</GMTTimeDifference>
  <ExecutionTime>0.25</ExecutionTime>
</ApiResponse>
```

### Error Codes
- **2033409**: Possibly a logical error in authentication phase. Order chargeable for Username is not found.
- **2011170**: Validation error from promotion code.
- **2011280**: TLD is not valid.
- **2030280**: TLD is not supported for API.
- **2528166**: Order creation failed.
- **5050900**: Unhandled exceptions.
```

--------------------------------

### namecheap.domains.dns.setHosts

Source: https://www.namecheap.com/support/api/methods/domains-dns/set-hosts

Sets DNS host records settings for the requested domain. It is recommended to use HTTP POST when setting more than 10 hostnames.

```APIDOC
## GET namecheap.domains.dns.setHosts

### Description
Sets DNS host records for a domain using query parameters. All host records not included in the call will be deleted.

### Method
GET

### Endpoint
https://api.namecheap.com/xml.response

### Parameters
#### Query Parameters
- **Command** (string) - Required - Must be set to "namecheap.domains.dns.setHosts"
- **SLD** (string) - Required - Second Level Domain
- **TLD** (string) - Required - Top Level Domain
- **HostName[1...n]** (string) - Required - Hostname for the record
- **RecordType[1...n]** (string) - Required - Type of DNS record (e.g., A, AAAA, CNAME, TXT, NS, URL)
- **Address[1...n]** (string) - Required - The value for the record
- **TTL[1...n]** (integer) - Required - Time to live value

### Request Example
https://api.namecheap.com/xml.response?apiuser=demo&apikey=d41474b94e7d4536baabb074a09c96bd&username=demo&Command=namecheap.domains.dns.setHosts&ClientIp=122.178.155.204&SLD=domain51&TLD=com&HostName1=@&RecordType1=URL&Address1=http://www.namecheap.com&TTL1=100
```

--------------------------------

### namecheap.domains.dns.setHosts

Source: https://www.namecheap.com/support/api/methods/domains-dns/set-hosts

Sets the DNS host records for a specified domain.

```APIDOC
## namecheap.domains.dns.setHosts

### Description
Sets the DNS host records for a specified domain.

### Parameters
- **SLD** (String) - Required - SLD of the domain to setHosts
- **TLD** (String) - Required - TLD of the domain to setHosts
- **HostName[1..n]** (String) - Required - Sub-domain/hostname to create the record for
- **RecordType[1..n]** (String) - Required - Possible values: A, AAAA, ALIAS, CAA, CNAME, MX, MXE, NS, TXT, URL, URL301, FRAME
- **Address[1..n]** (String) - Required - URL or IP address based on RecordType
- **MXPref[1..n]** (String) - Required - MX preference for host (applicable for MX records only)
- **EmailType** (String) - Required - Possible values: MXE, MX, FWD, OX
- **TTL[1..n]** (String) - Optional - Time to live (60 to 60000, default 1800)
- **Flag** (String) - Optional - Unsigned integer between 0 and 255
- **Tag** (String) - Optional - US-ASCII letters and numbers (issue, issuewild, iodef)

### Response
#### Success Response
- **Domain** (String) - The domain name for which you are trying to set host records.
- **IsSuccess** (Boolean) - Indicates whether host records were set successfully.

### Error Codes
- **2019166**: Domain not found
- **2016166**: Domain is not associated with your account
- **2030166**: Edit permission for domain is not supported
- **3013288, 4013288**: Too many records
- **3031510**: Error From Enom when Errorcount <> 0
- **3050900**: Unknown error from Enom
- **4022288**: Unable to get nameserver list
```

--------------------------------

### Basic Domain Transfer Request

Source: https://www.namecheap.com/support/api/methods/domains-transfer/create

This is a standard request to initiate a domain transfer. Ensure all parameters are correctly provided.

```http
https://api.namecheap.com/xml.response?ApiUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&UserName=apiexample&Command=namecheap.domains.transfer.create&ClientIp=192.168.1.109&DomainName=domain.com&Years=1&EPPCode=213456234554454453
```

--------------------------------

### domains.ns.update

Source: https://www.namecheap.com/support/api/methods/domains-ns

Updates the IP address of a registered nameserver.

```APIDOC
## domains.ns.update

### Description
Updates the IP address of a registered nameserver.

### Method
POST

### Endpoint
/domains.ns.update

### Parameters
#### Query Parameters
- **DomainName** (string) - Required - The domain name.
- **Nameserver** (string) - Required - The hostname of the nameserver to update.
- **NewIP** (string) - Required - The new IP address for the nameserver.

### Request Example
```json
{
  "DomainName": "example.com",
  "Nameserver": "ns1.example.com",
  "NewIP": "192.168.1.2"
}
```

### Response
#### Success Response (200)
- **Status** (string) - Indicates the success of the operation.
- **Errors** (array) - A list of errors, if any.
- **RequestedID** (string) - The ID of the request.
- **CommandResponse** (object) - Contains details about the command execution.
  - **NameserverUpdateResult** (object)
    - **Domain** (string) - The domain name.
    - **Nameserver** (string) - The updated nameserver.
    - **IP** (string) - The new IP address of the nameserver.

#### Response Example
```json
{
  "Status": "OK",
  "Errors": [],
  "RequestedID": "some-request-id",
  "CommandResponse": {
    "NameserverUpdateResult": {
      "Domain": "example.com",
      "Nameserver": "ns1.example.com",
      "IP": "192.168.1.2"
    }
  }
}
```
```

--------------------------------

### domains.ns.delete

Source: https://www.namecheap.com/support/api/methods/domains-ns

Deletes a nameserver associated with the requested domain.

```APIDOC
## domains.ns.delete

### Description
Deletes a nameserver associated with the requested domain.

### Method
POST

### Endpoint
/domains.ns.delete

### Parameters
#### Query Parameters
- **DomainName** (string) - Required - The domain name.
- **Nameserver** (string) - Required - The hostname of the nameserver to delete.

### Request Example
```json
{
  "DomainName": "example.com",
  "Nameserver": "ns1.example.com"
}
```

### Response
#### Success Response (200)
- **Status** (string) - Indicates the success of the operation.
- **Errors** (array) - A list of errors, if any.
- **RequestedID** (string) - The ID of the request.
- **CommandResponse** (object) - Contains details about the command execution.
  - **NameserverDeleteResult** (object)
    - **Domain** (string) - The domain name.
    - **Nameserver** (string) - The deleted nameserver.

#### Response Example
```json
{
  "Status": "OK",
  "Errors": [],
  "RequestedID": "some-request-id",
  "CommandResponse": {
    "NameserverDeleteResult": {
      "Domain": "example.com",
      "Nameserver": "ns1.example.com"
    }
  }
}
```
```

--------------------------------

### domains.transfer.updateStatus

Source: https://www.namecheap.com/support/api/methods/domains-transfer

Updates the status of a particular domain transfer. Allows re-submission after registry lock release.

```APIDOC
## domains.transfer.updateStatus

### Description
Updates the status of a particular domain transfer. Allows you to re-submit the transfer after releasing the registry lock.

### Method
POST

### Endpoint
/xmlrpc

### Parameters
#### Request Body
- **TransferId** (integer) - Required - The ID of the transfer.
- **Status** (string) - Required - The new status for the transfer (e.g., 'Resubmit').
- **AuthId** (string) - Required - Your authentication ID.
- **AuthUser** (string) - Required - Your authentication username.
- **ClientIp** (string) - Required - The IP address of the client making the request.
- **Password** (string) - Required - Your API password.
```
Tokens:
Raw