# Namecheap Integration via LowCodeAPI
## Overview
Domain registration and hosting
## Base Endpoint
```
https://api.lowcodeapi.com/namecheap/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Namecheap](https://www.namecheap.com/)
2. **Get your credentials** from [credential page](https://ap.www.namecheap.com/settings/tools/apiaccess/)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
**Auth Type**: TOKEN
## API Categories
- **Address** - 6 endpoints
- **Domain Privacy** - 5 endpoints
- **Domains** - 11 endpoints
- **Domains DNS** - 7 endpoints
- **Domains NS** - 4 endpoints
- **Domains Transfer** - 4 endpoints
- **SSL** - 13 endpoints
- **Users** - 9 endpoints
## Common Endpoints
### Category: Address
#### Creates a new address for the user
**Method**: `GET` | **LowCodeAPI Path**: `/users.address.create`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.address.create?AddressName={AddressName}&DefaultYN={DefaultYN}&EmailAddress={EmailAddress}&FirstName={FirstName}&LastName={LastName}&JobTitle={JobTitle}&Organization={Organization}&Address1={Address1}&Address2={Address2}&City={City}&StateProvince={StateProvince}&StateProvinceChoice={StateProvinceChoice}&Zip={Zip}&Country={Country}&Phone={Phone}&PhoneExt={PhoneExt}&Fax={Fax}&api_token={api_token}
```
**Description**: Creates a new address for the user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`AddressName` | string | Yes | Address name to create. MaxLength- 20 |
|`DefaultYN` | number | No | Possible values are 0 and 1. If the value of this parameter is set to 1 the address is set as default address for the user. MaxLength- 128 |
|`EmailAddress` | string | Yes | Email address of the user. MaxLength- 128 |
|`FirstName` | string | Yes | First name of the user. MaxLength- 60 |
|`LastName` | string | Yes | Last name of the user. MaxLength- 60 |
|`JobTitle` | string | No | Job designation of the user. MaxLength- 60 |
|`Organization` | string | No | Organization of the user. MaxLength- 60 |
|`Address1` | string | Yes | StreetAddress1 of the user. MaxLength- 60 |
|`Address2` | string | No | StreetAddress2 of the user. MaxLength- 60 |
|`City` | string | Yes | City of the user. MaxLength- 60 |
|`StateProvince` | string | Yes | State/Province of the user. MaxLength- 60 |
|`StateProvinceChoice` | string | Yes | State/Province choice of the user. MaxLength- 60 |
|`Zip` | string | Yes | Zip/Postal code of the user. MaxLength- 15 |
|`Country` | string | Yes | Two letter country code of the user. MaxLength- 2 |
|`Phone` | string | No | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
|`PhoneExt` | string | No | PhoneExt of the user. MaxLength- 10 |
|`Fax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
---
#### Deletes the particular address for the user
**Method**: `GET` | **LowCodeAPI Path**: `/users.address.delete`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.address.delete?AddressId={AddressId}&api_token={api_token}
```
**Description**: Deletes the particular address for the user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`AddressId` | number | Yes | The unique AddressID to delete. MaxLength- 20 |
---
#### Gets information for the requested addressID
**Method**: `GET` | **LowCodeAPI Path**: `/users.address.getinfo`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.address.getinfo?AddressId={AddressId}&api_token={api_token}
```
**Description**: Gets information for the requested addressID
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`AddressId` | number | Yes | The unique AddressID. MaxLength- 20 |
---
#### Retrieve user account's addressIDs and names
**Method**: `GET` | **LowCodeAPI Path**: `/users.address.getlist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.address.getlist?api_token={api_token}
```
**Description**: Gets a list of addressIDs and addressnames associated with the user account.
---
#### Sets default address for the user
**Method**: `GET` | **LowCodeAPI Path**: `/users.address.setdefault`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.address.setdefault?AddressId={AddressId}&api_token={api_token}
```
**Description**: Sets default address for the user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`AddressId` | number | Yes | The unique addressID to set default. MaxLength- 20 |
---
#### Updates the particular address of the user
**Method**: `GET` | **LowCodeAPI Path**: `/users.address.update`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.address.update?AddressId={AddressId}&AddressName={AddressName}&DefaultYN={DefaultYN}&EmailAddress={EmailAddress}&FirstName={FirstName}&LastName={LastName}&JobTitle={JobTitle}&Organization={Organization}&Address1={Address1}&Address2={Address2}&City={City}&StateProvince={StateProvince}&StateProvinceChoice={StateProvinceChoice}&Zip={Zip}&Country={Country}&Phone={Phone}&PhoneExt={PhoneExt}&Fax={Fax}&api_token={api_token}
```
**Description**: Updates the particular address of the user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`AddressId` | number | Yes | The unique address ID to update. MaxLength- 20 |
|`AddressName` | string | Yes | The AddressName to update. MaxLength- 20 |
|`DefaultYN` | number | No | Possible values are 0 and 1. If the value of this parameter is set to 1 the updated address is also set as default address for the user. MaxLength- 128 |
|`EmailAddress` | string | Yes | Email address of the user. MaxLength- 128 |
|`FirstName` | string | Yes | First name of the user. MaxLength- 60 |
|`LastName` | string | Yes | Last name of the user. MaxLength- 60 |
|`JobTitle` | string | No | Job designation of the user. MaxLength- 60 |
|`Organization` | string | No | Organization of the user. MaxLength- 60 |
|`Address1` | string | Yes | StreetAddress1 of the user. MaxLength- 60 |
|`Address2` | string | No | StreetAddress2 of the user. MaxLength- 60 |
|`City` | string | Yes | City of the user. MaxLength- 60 |
|`StateProvince` | string | Yes | State/Province of the user. MaxLength- 60 |
|`StateProvinceChoice` | string | Yes | State/Province choice of the user. MaxLength- 60 |
|`Zip` | string | Yes | Zip/Postal code of the user. MaxLength- 15 |
|`Country` | string | Yes | Two letter country code of the user. MaxLength- 2 |
|`Phone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
|`PhoneExt` | string | No | PhoneExt of the user. MaxLength- 10 |
|`Fax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
---
### Category: Domain Privacy
#### Changes domain privacy email address
**Method**: `GET` | **LowCodeAPI Path**: `/whoisguard.changeemailaddress`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/whoisguard.changeemailaddress?WhoisguardID={WhoisguardID}&api_token={api_token}
```
**Description**: Changes domain privacy email address
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`WhoisguardID` | number | Yes | The unique domain privacy ID that you wish to change. MaxLength- 10 |
---
#### Enables domain privacy protection
**Method**: `GET` | **LowCodeAPI Path**: `/whoisguard.enable`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/whoisguard.enable?WhoisguardID={WhoisguardID}&ForwardedToEmail={ForwardedToEmail}&api_token={api_token}
```
**Description**: Enables domain privacy protection.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`WhoisguardID` | number | Yes | The unique domain privacy ID which you get. MaxLength- 10 |
|`ForwardedToEmail` | string | Yes | The email address to which domain privacy emails are to be forwarded. MaxLength- 70 |
---
#### Disables domain privacy protection
**Method**: `GET` | **LowCodeAPI Path**: `/whoisguard.disable`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/whoisguard.disable?WhoisguardID={WhoisguardID}&api_token={api_token}
```
**Description**: Disables domain privacy protection.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`WhoisguardID` | number | Yes | The unique domain privacy ID which has to be disabled. MaxLength- 10 |
---
#### Gets the list of domain privacy protection
**Method**: `GET` | **LowCodeAPI Path**: `/whoisguard.getlist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/whoisguard.getlist?ListType={ListType}&Page={Page}&PageSize={PageSize}&api_token={api_token}
```
**Description**: Gets the list of domain privacy protection.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ListType` | string | No | Possible values are ALL/ ALLOTED/ FREE/ DISCARD. Default Value- ALL . MaxLength- 10 |
|`Page` | number | No | Page to return. Default Value- 1 . MaxLength- 10 |
|`PageSize` | number | No | Number of domain privacy subscriptions to be listed on a page. Minimum value- 2; Maximum value- 100 MaxLength- 20 |
---
#### Renews domain privacy protection
**Method**: `GET` | **LowCodeAPI Path**: `/whoisguard.renew`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/whoisguard.renew?WhoisguardID={WhoisguardID}&Years={Years}&PromotionCode={PromotionCode}&api_token={api_token}
```
**Description**: Renews domain privacy protection.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`WhoisguardID` | string | Yes | Domain privacy ID to renew. MaxLength- 10 |
|`Years` | number | Yes | Number of years to renew. Default Value- 1 MaxLength- 9 |
|`PromotionCode` | number | No | Promotional (coupon) code for renewing the domain privacy. MaxLength- 20 |
---
### Category: Domains
#### Get user's domains as a list
**Method**: `GET` | **LowCodeAPI Path**: `/domains.getlist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.getlist?ListType={ListType}&SearchTerm={SearchTerm}&Page={Page}&PageSize={PageSize}&SortBy={SortBy}&api_token={api_token}
```
**Description**: Returns a list of domains for the particular user.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ListType` | string | No | Possible values- ALL/ EXPIRING/ EXPIRED. Default Value- ALL MaxLength- 10 |
|`SearchTerm` | string | No | Keyword to look for in the domain list. MaxLength- 70 |
|`Page` | number | No | Page to return. Default Value- 1 MaxLength- 10 |
|`PageSize` | number | No | Number of domains to be listed on a page. Minimum value is 10 and maximum value is 100. Default Value- 20 MaxLength- 10 |
|`SortBy` | string | No | Possible values are NAME/ NAME_DESC/ EXPIREDATE/ EXPIREDATE_DESC/ CREATEDATE/ CREATEDATE_DESC. MaxLength- 50 |
---
#### Gets contact info for requested domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.getcontacts`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.getcontacts?DomainName={DomainName}&api_token={api_token}
```
**Description**: Gets contact information of the requested domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain to get contacts. MaxLength- 70 |
---
#### Registers a new domain name
**Method**: `GET` | **LowCodeAPI Path**: `/domains.create`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.create?DomainName={DomainName}&Years={Years}&PromotionCode={PromotionCode}&RegistrantOrganizationName={RegistrantOrganizationName}&RegistrantJobTitle={RegistrantJobTitle}&RegistrantFirstName={RegistrantFirstName}&RegistrantLastName={RegistrantLastName}&RegistrantAddress1={RegistrantAddress1}&RegistrantAddress2={RegistrantAddress2}&RegistrantCity={RegistrantCity}&RegistrantStateProvince={RegistrantStateProvince}&RegistrantStateProvinceChoice={RegistrantStateProvinceChoice}&RegistrantPostalCode={RegistrantPostalCode}&RegistrantCountry={RegistrantCountry}&RegistrantPhone={RegistrantPhone}&RegistrantPhoneExt={RegistrantPhoneExt}&RegistrantFax={RegistrantFax}&RegistrantEmailAddress={RegistrantEmailAddress}&TechOrganizationName={TechOrganizationName}&TechJobTitle={TechJobTitle}&TechFirstName={TechFirstName}&TechLastName={TechLastName}&TechAddress1={TechAddress1}&TechAddress2={TechAddress2}&TechCity={TechCity}&TechStateProvince={TechStateProvince}&TechStateProvinceChoice={TechStateProvinceChoice}&TechPostalCode={TechPostalCode}&TechCountry={TechCountry}&TechPhone={TechPhone}&TechPhoneExt={TechPhoneExt}&TechFax={TechFax}&TechEmailAddress={TechEmailAddress}&AdminOrganizationName={AdminOrganizationName}&AdminJobTitle={AdminJobTitle}&AdminFirstName={AdminFirstName}&AdminLastName={AdminLastName}&AdminAddress1={AdminAddress1}&AdminAddress2={AdminAddress2}&AdminCity={AdminCity}&AdminStateProvince={AdminStateProvince}&AdminStateProvinceChoice={AdminStateProvinceChoice}&AdminPostalCode={AdminPostalCode}&AdminCountry={AdminCountry}&AdminPhone={AdminPhone}&AdminPhoneExt={AdminPhoneExt}&AdminFax={AdminFax}&AdminEmailAddress={AdminEmailAddress}&AuxBillingOrganizationName={AuxBillingOrganizationName}&AuxBillingJobTitle={AuxBillingJobTitle}&AuxBillingFirstName={AuxBillingFirstName}&AuxBillingLastName={AuxBillingLastName}&AuxBillingAddress1={AuxBillingAddress1}&AuxBillingAddress2={AuxBillingAddress2}&AuxBillingCity={AuxBillingCity}&AuxBillingStateProvince={AuxBillingStateProvince}&AuxBillingStateProvinceChoice={AuxBillingStateProvinceChoice}&AuxBillingPostalCode={AuxBillingPostalCode}&AuxBillingCountry={AuxBillingCountry}&AuxBillingPhone={AuxBillingPhone}&AuxBillingPhoneExt={AuxBillingPhoneExt}&AuxBillingFax={AuxBillingFax}&AuxBillingEmailAddress={AuxBillingEmailAddress}&BillingFirstName={BillingFirstName}&BillingLastName={BillingLastName}&BillingAddress1={BillingAddress1}&BillingAddress2={BillingAddress2}&BillingCity={BillingCity}&BillingStateProvince={BillingStateProvince}&BillingStateProvinceChoice={BillingStateProvinceChoice}&BillingPostalCode={BillingPostalCode}&BillingCountry={BillingCountry}&BillingPhone={BillingPhone}&BillingPhoneExt={BillingPhoneExt}&BillingFax={BillingFax}&BillingEmailAddress={BillingEmailAddress}&IdnCode={IdnCode}&Extended attributes={Extended attributes}&Nameservers={Nameservers}&AddFreeWhoisguard={AddFreeWhoisguard}&WGEnabled={WGEnabled}&IsPremiumDomain={IsPremiumDomain}&PremiumPrice={PremiumPrice}&EapFee={EapFee}&api_token={api_token}
```
**Description**: Registers a new domain name.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to register. MaxLength- 70 |
|`Years` | number | Yes | Number of years to register. MaxLength- 2 Default Value- 2 |
|`PromotionCode` | string | No | Promotional (coupon) code for the domain. MaxLength- 20 |
|`RegistrantOrganizationName` | string | No | Organization of the Registrant user. MaxLength- 255 |
|`RegistrantJobTitle` | string | No | Job title of the Registrant user. MaxLength- 255 |
|`RegistrantFirstName` | string | Yes | First name of the Registrant user. MaxLength- 255 |
|`RegistrantLastName` | string | Yes | Second name of the Registrant user. MaxLength- 255 |
|`RegistrantAddress1` | string | Yes | Address1 of the Registrant user. MaxLength- 255 |
|`RegistrantAddress2` | string | No | Address2 of the Registrant user. MaxLength- 255 |
|`RegistrantCity` | string | Yes | City of the Registrant user. MaxLength- 50 |
|`RegistrantStateProvince` | string | Yes | State/Province of the Registrant user. MaxLength- 50 |
|`RegistrantStateProvinceChoice` | string | No | StateProvinceChoice of the Registrant user. MaxLength- 50 |
|`RegistrantPostalCode` | string | Yes | PostalCode of the Registrant user. MaxLength- 50 |
|`RegistrantCountry` | string | Yes | Country of the Registrant user. MaxLength- 50 |
|`RegistrantPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`RegistrantPhoneExt` | string | No | PhoneExt of the Registrant user. MaxLength- 50 |
|`RegistrantFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`RegistrantEmailAddress` | string | Yes | Email address of the Registrant user. MaxLength- 255 |
|`TechOrganizationName` | string | No | Organization of the Tech user. MaxLength- 255 |
|`TechJobTitle` | string | No | Job title of the Tech user. MaxLength- 255 |
|`TechFirstName` | string | Yes | First name of the Tech user. MaxLength- 255 |
|`TechLastName` | string | Yes | Second name of the Tech user. MaxLength- 255 |
|`TechAddress1` | string | Yes | Address1 of the Tech user. MaxLength- 255 |
|`TechAddress2` | string | No | Address2 of the Tech user. MaxLength- 255 |
|`TechCity` | string | Yes | City of the Tech user. MaxLength- 50 |
|`TechStateProvince` | string | Yes | State/Province of the Tech user. MaxLength- 50 |
|`TechStateProvinceChoice` | string | No | StateProvinceChoice of the Tech user. MaxLength- 50 |
|`TechPostalCode` | string | Yes | PostalCode of the Tech user. MaxLength- 50 |
|`TechCountry` | string | Yes | Country of the Tech user. MaxLength- 50 |
|`TechPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`TechPhoneExt` | string | No | PhoneExt of the Tech user. MaxLength- 50 |
|`TechFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`TechEmailAddress` | string | Yes | Email address of the Tech user. MaxLength- 255 |
|`AdminOrganizationName` | string | No | Organization of the Admin user. MaxLength- 255 |
|`AdminJobTitle` | string | No | Job title of the Admin user. MaxLength- 255 |
|`AdminFirstName` | string | Yes | First name of the Admin user. MaxLength- 255 |
|`AdminLastName` | string | Yes | Second name of the Admin user. MaxLength- 255 |
|`AdminAddress1` | string | Yes | Address1 of the Admin user. MaxLength- 255 |
|`AdminAddress2` | string | No | Address2 of the Admin user. MaxLength- 255 |
|`AdminCity` | string | Yes | City of the Admin user. MaxLength- 50 |
|`AdminStateProvince` | string | Yes | State/Province of the Admin user. MaxLength- 50 |
|`AdminStateProvinceChoice` | string | No | StateProvinceChoice of the Admin user. MaxLength- 50 |
|`AdminPostalCode` | string | Yes | PostalCode of the Admin user. MaxLength- 50 |
|`AdminCountry` | string | Yes | Country of the Admin user. MaxLength- 50 |
|`AdminPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AdminPhoneExt` | string | No | PhoneExt of the Admin user. MaxLength- 50 |
|`AdminFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AdminEmailAddress` | string | Yes | Email address of the Admin user. MaxLength- 255 |
|`AuxBillingOrganizationName` | string | No | Organization of the AuxBilling user. MaxLength- 255 |
|`AuxBillingJobTitle` | string | No | Job title of the AuxBilling user. MaxLength- 255 |
|`AuxBillingFirstName` | string | Yes | First name of the AuxBilling user. MaxLength- 255 |
|`AuxBillingLastName` | string | Yes | Second name of the AuxBilling user. MaxLength- 255 |
|`AuxBillingAddress1` | string | Yes | Address1 of the AuxBilling user. MaxLength- 255 |
|`AuxBillingAddress2` | string | No | Address2 of the AuxBilling user. MaxLength- 255 |
|`AuxBillingCity` | string | Yes | City of the AuxBilling user. MaxLength- 50 |
|`AuxBillingStateProvince` | string | Yes | State/Province of the AuxBilling user. MaxLength- 50 |
|`AuxBillingStateProvinceChoice` | string | No | StateProvinceChoice of the AuxBilling user. MaxLength- 50 |
|`AuxBillingPostalCode` | string | Yes | PostalCode of the AuxBilling user. MaxLength- 50 |
|`AuxBillingCountry` | string | Yes | Country of the AuxBilling user. MaxLength- 50 |
|`AuxBillingPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AuxBillingPhoneExt` | string | No | PhoneExt of the AuxBilling user. MaxLength- 50 |
|`AuxBillingFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AuxBillingEmailAddress` | string | Yes | Email address of the AuxBilling user. MaxLength- 255 |
|`BillingFirstName` | string | No | First name of the Billing user. MaxLength- 255 |
|`BillingLastName` | string | No | Second name of the Billing user. MaxLength- 255 |
|`BillingAddress1` | string | No | Address1 of the Billing user. MaxLength- 255 |
|`BillingAddress2` | string | No | Address2 of the Billing user. MaxLength- 255 |
|`BillingCity` | string | No | City of the Billing user. MaxLength- 50 |
|`BillingStateProvince` | string | No | State/Province of the Billing user. MaxLength- 50 |
|`BillingStateProvinceChoice` | string | No | StateProvinceChoice of the Billing user. MaxLength- 50 |
|`BillingPostalCode` | string | No | PostalCode of the Billing user. MaxLength- 50 |
|`BillingCountry` | string | No | Country of the Billing user. MaxLength- 50 |
|`BillingPhone` | string | No | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`BillingPhoneExt` | string | No | PhoneExt of the Billing user. MaxLength- 50 |
|`BillingFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`BillingEmailAddress` | string | No | Email address of the Billing user. MaxLength- 255 |
|`IdnCode` | string | No | Code of Internationalized Domain Name (please refer to the note below). MaxLength- 100 |
|`Extended attributes` | string | Yes | Required for .us/ .eu/ .ca/ .co.uk/ .org.uk/ .me.uk/ .nu / .com.au/ .net.au/ .org.au/ .es/ .nom.es/ .com.es/ .org.es/ .de/ .fr TLDs only |
|`Nameservers` | string | No | Comma-separated list of custom nameservers to be associated with the domain name |
|`AddFreeWhoisguard` | string | No | Adds free domain privacy for the domain. MaxLength- 10 Default Value- no |
|`WGEnabled` | string | No | Enables free domain privacy for the domain. MaxLength- 10 Default Value- no |
|`IsPremiumDomain` | boolean | No | Indication if the domain name is premium. MaxLength- 10 |
|`PremiumPrice` | string | No | Registration price for the premium domain. MaxLength- 20 |
|`EapFee` | string | No | Purchase fee for the premium domain during Early Access Program (EAP)*. MaxLength- 20 |
---
#### Returns a list of tlds
**Method**: `GET` | **LowCodeAPI Path**: `/domains.gettldlist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.gettldlist?api_token={api_token}
```
**Description**: Returns a list of tlds
---
#### Sets contact information for the domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.setcontacts`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.setcontacts?DomainName={DomainName}&RegistrantOrganizationName={RegistrantOrganizationName}&RegistrantJobTitle={RegistrantJobTitle}&RegistrantFirstName={RegistrantFirstName}&RegistrantLastName={RegistrantLastName}&RegistrantAddress1={RegistrantAddress1}&RegistrantAddress2={RegistrantAddress2}&RegistrantCity={RegistrantCity}&RegistrantStateProvince={RegistrantStateProvince}&RegistrantStateProvinceChoice={RegistrantStateProvinceChoice}&RegistrantPostalCode={RegistrantPostalCode}&RegistrantCountry={RegistrantCountry}&RegistrantPhone={RegistrantPhone}&RegistrantPhoneExt={RegistrantPhoneExt}&RegistrantFax={RegistrantFax}&RegistrantEmailAddress={RegistrantEmailAddress}&TechOrganizationName={TechOrganizationName}&TechJobTitle={TechJobTitle}&TechFirstName={TechFirstName}&TechLastName={TechLastName}&TechAddress1={TechAddress1}&TechAddress2={TechAddress2}&TechCity={TechCity}&TechStateProvince={TechStateProvince}&TechStateProvinceChoice={TechStateProvinceChoice}&TechPostalCode={TechPostalCode}&TechCountry={TechCountry}&TechPhone={TechPhone}&TechPhoneExt={TechPhoneExt}&TechFax={TechFax}&TechEmailAddress={TechEmailAddress}&AdminOrganizationName={AdminOrganizationName}&AdminJobTitle={AdminJobTitle}&AdminFirstName={AdminFirstName}&AdminLastName={AdminLastName}&AdminAddress1={AdminAddress1}&AdminAddress2={AdminAddress2}&AdminCity={AdminCity}&AdminStateProvince={AdminStateProvince}&AdminStateProvinceChoice={AdminStateProvinceChoice}&AdminPostalCode={AdminPostalCode}&AdminCountry={AdminCountry}&AdminPhone={AdminPhone}&AdminPhoneExt={AdminPhoneExt}&AdminFax={AdminFax}&AdminEmailAddress={AdminEmailAddress}&AuxBillingOrganizationName={AuxBillingOrganizationName}&AuxBillingJobTitle={AuxBillingJobTitle}&AuxBillingFirstName={AuxBillingFirstName}&AuxBillingLastName={AuxBillingLastName}&AuxBillingAddress1={AuxBillingAddress1}&AuxBillingAddress2={AuxBillingAddress2}&AuxBillingCity={AuxBillingCity}&AuxBillingStateProvince={AuxBillingStateProvince}&AuxBillingStateProvinceChoice={AuxBillingStateProvinceChoice}&AuxBillingPostalCode={AuxBillingPostalCode}&AuxBillingCountry={AuxBillingCountry}&AuxBillingPhone={AuxBillingPhone}&AuxBillingPhoneExt={AuxBillingPhoneExt}&AuxBillingFax={AuxBillingFax}&AuxBillingEmailAddress={AuxBillingEmailAddress}&Extended attributes={Extended attributes}&api_token={api_token}
```
**Description**: Sets contact information for the domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | The domain name to register. MaxLength- 70 |
|`RegistrantOrganizationName` | string | No | Organization of the Registrant user. MaxLength- 255 |
|`RegistrantJobTitle` | string | No | Job title of the Registrant user. MaxLength- 255 |
|`RegistrantFirstName` | string | Yes | First name of the Registrant user. MaxLength- 255 |
|`RegistrantLastName` | string | Yes | Second name of the Registrant user. MaxLength- 255 |
|`RegistrantAddress1` | string | Yes | Address1 of the Registrant user. MaxLength- 255 |
|`RegistrantAddress2` | string | No | Address2 of the Registrant user. MaxLength- 255 |
|`RegistrantCity` | string | Yes | City of the Registrant user.MaxLength- 50 |
|`RegistrantStateProvince` | string | Yes | State/Province of the Registrant user.MaxLength- 50 |
|`RegistrantStateProvinceChoice` | string | No | StateProvinceChoice of the Registrant user.MaxLength- 50 |
|`RegistrantPostalCode` | string | Yes | PostalCode of the Registrant user.MaxLength- 50 |
|`RegistrantCountry` | string | Yes | Country of the Registrant user.MaxLength- 50 |
|`RegistrantPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`RegistrantPhoneExt` | string | No | PhoneExt of the Registrant user.MaxLength- 50 |
|`RegistrantFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`RegistrantEmailAddress` | string | Yes | Email address of the Registrant user. MaxLength- 255 |
|`TechOrganizationName` | string | No | Organization of the Tech user. MaxLength- 255 |
|`TechJobTitle` | string | No | Job title of the Tech user. MaxLength- 255 |
|`TechFirstName` | string | Yes | First name of the Tech user. MaxLength- 255 |
|`TechLastName` | string | Yes | Second name of the Tech user. MaxLength- 255 |
|`TechAddress1` | string | Yes | Address1 of the Tech user. MaxLength- 255 |
|`TechAddress2` | string | No | Address2 of the Tech user. MaxLength- 255 |
|`TechCity` | string | Yes | City of the Tech user. MaxLength- 50 |
|`TechStateProvince` | string | Yes | State/Province of the Tech user. MaxLength- 50 |
|`TechStateProvinceChoice` | string | No | StateProvinceChoice of the Tech user. MaxLength- 50 |
|`TechPostalCode` | string | Yes | PostalCode of the Tech user. MaxLength- 50 |
|`TechCountry` | string | Yes | Country of the Tech user. MaxLength- 50 |
|`TechPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`TechPhoneExt` | string | No | PhoneExt of the Tech user. MaxLength- 50 |
|`TechFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`TechEmailAddress` | string | Yes | Email address of the Tech user. MaxLength- 255 |
|`AdminOrganizationName` | string | No | Organization of the Admin user. MaxLength- 255 |
|`AdminJobTitle` | string | No | Job title of the Admin user. MaxLength- 255 |
|`AdminFirstName` | string | Yes | First name of the Admin user. MaxLength- 255 |
|`AdminLastName` | string | Yes | Second name of the Admin user. MaxLength- 255 |
|`AdminAddress1` | string | Yes | Address1 of the Admin user. MaxLength- 255 |
|`AdminAddress2` | string | No | Address2 of the Admin user. MaxLength- 255 |
|`AdminCity` | string | Yes | City of the Admin . MaxLength- 50 |
|`AdminStateProvince` | string | Yes | State/Province of the Admin . MaxLength- 50 |
|`AdminStateProvinceChoice` | string | No | StateProvinceChoice of the Admin . MaxLength- 50 |
|`AdminPostalCode` | string | Yes | PostalCode of the Admin . MaxLength- 50 |
|`AdminCountry` | string | Yes | Country of the Admin . MaxLength- 50 |
|`AdminPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AdminPhoneExt` | string | No | PhoneExt of the Admin . MaxLength- 50 |
|`AdminFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AdminEmailAddress` | string | Yes | Email address of the Admin user. MaxLength- 255 |
|`AuxBillingOrganizationName` | string | No | Organization of the AuxBilling user. MaxLength- 255 |
|`AuxBillingJobTitle` | string | No | Job title of the AuxBilling user. MaxLength- 255 |
|`AuxBillingFirstName` | string | Yes | First name of the AuxBilling user. MaxLength- 255 |
|`AuxBillingLastName` | string | Yes | Second name of the AuxBilling user. MaxLength- 255 |
|`AuxBillingAddress1` | string | Yes | Address1 of the AuxBilling user. MaxLength- 255 |
|`AuxBillingAddress2` | string | No | Address2 of the AuxBilling user. MaxLength- 255 |
|`AuxBillingCity` | string | Yes | City of the AuxBilling user. MaxLength- 50 |
|`AuxBillingStateProvince` | string | Yes | State/Province of the AuxBilling user. MaxLength- 50 |
|`AuxBillingStateProvinceChoice` | string | No | StateProvinceChoice of the AuxBilling user. MaxLength- 50 |
|`AuxBillingPostalCode` | string | Yes | PostalCode of the AuxBilling user. MaxLength- 50 |
|`AuxBillingCountry` | string | Yes | Country of the AuxBilling user. MaxLength- 50 |
|`AuxBillingPhone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AuxBillingPhoneExt` | string | No | PhoneExt of the AuxBilling user. MaxLength- 50 |
|`AuxBillingFax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 50 |
|`AuxBillingEmailAddress` | string | Yes | Email address of the AuxBilling user. MaxLength- 255 |
|`Extended attributes` | string | Yes | Required for .us/ .eu/ .ca/ .co.uk/ .org.uk/ .me.uk/ .nu / .asia/ .com.au/ .net.au/ .org.au/ .es/ .nom.es/ .com.es/ .org.es/ .de/ .fr TLDs only |
---
#### Checks the availability of domains
**Method**: `GET` | **LowCodeAPI Path**: `/domains.check`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.check?DomainList={DomainList}&api_token={api_token}
```
**Description**: Checks the availability of domains.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainList` | string | Yes | Comma-separated list of domains to check |
---
#### Reactivates an expired domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.reactivate`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.reactivate?DomainName={DomainName}&PromotionCode={PromotionCode}&YearsToAdd={YearsToAdd}&IsPremiumDomain={IsPremiumDomain}&PremiumPrice={PremiumPrice}&api_token={api_token}
```
**Description**: Reactivates an expired domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to reactivate. MaxLength- 70 |
|`PromotionCode` | string | No | Promotional (coupon) code for reactivating the domain. MaxLength- 70 |
|`YearsToAdd` | number | No | Number of years after expiry. MaxLength- 2 |
|`IsPremiumDomain` | boolean | No | Indication if the domain name is premium. MaxLength- 10 |
|`PremiumPrice` | string | No | Reactivation price for the premium domain. MaxLength- 20 |
---
#### Renews an expiring domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.renew`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.renew?DomainName={DomainName}&Years={Years}&PromotionCode={PromotionCode}&IsPremiumDomain={IsPremiumDomain}&PremiumPrice={PremiumPrice}&api_token={api_token}
```
**Description**: Renews an expiring domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to renew. MaxLength- 70 |
|`Years` | number | Yes | Number of years to renew. MaxLength- 2 |
|`PromotionCode` | string | No | Promotional (coupon) code for renewing the domain. MaxLength- 20 |
|`IsPremiumDomain` | boolean | No | Indication if the domain name is premium. MaxLength- 10 |
|`PremiumPrice` | string | No | Renewal price for the premium domain. MaxLength- 20 |
---
#### Check domain lock status with RegistrarLock API
**Method**: `GET` | **LowCodeAPI Path**: `/domains.getregistrarlock`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.getregistrarlock?DomainName={DomainName}&api_token={api_token}
```
**Description**: Gets the RegistrarLock status of the requested domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to get status for. MaxLength- 70 |
---
#### Sets the RegistrarLock status for a domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.setregistrarlock`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.setregistrarlock?DomainName={DomainName}&LockAction={LockAction}&api_token={api_token}
```
**Description**: Sets the RegistrarLock status for a domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to set status for. MaxLength- 70 |
|`LockAction` | string | No | Possible values- LOCK/ UNLOCK. Default Value- LOCK. MaxLength- 70 |
---
#### Returns information about the requested domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.getinfo`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.getinfo?DomainName={DomainName}&HostName={HostName}&api_token={api_token}
```
**Description**: Returns information about the requested domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name for which domain information needs to be requested. MaxLength- 70 |
|`HostName` | string | No | Hosted domain name for which domain information needs to be requested. MaxLength- 255 |
---
### Category: Domains DNS
#### Set default DNS for free services: host management, URL forwarding, email forwarding, dynamic DNS
**Method**: `GET` | **LowCodeAPI Path**: `/domains.dns.setdefault`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.dns.setdefault?SLD={SLD}&TLD={TLD}&api_token={api_token}
```
**Description**: Sets domain to use our default DNS servers. Required for free services like Host record management, URL forwarding, email forwarding, dynamic dns and other value added services.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the DomainName. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the DomainName. MaxLength- 10 |
---
#### Use custom DNS servers for domain; disable URL/email forwarding, Dynamic DNS won't work
**Method**: `GET` | **LowCodeAPI Path**: `/domains.dns.setcustom`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.dns.setcustom?SLD={SLD}&TLD={TLD}&Nameservers={Nameservers}&api_token={api_token}
```
**Description**: Sets domain to use custom DNS servers. NOTE: Services like URL forwarding, Email forwarding, Dynamic DNS will not work for domains using custom nameservers.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the DomainName. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the DomainName. MaxLength- 10 |
|`Nameservers` | string | Yes | A comma-separated list of name servers to be associated with this domain. MaxLength- 1200 |
---
#### Retrieve DNS servers for requested domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.dns.getlist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.dns.getlist?SLD={SLD}&TLD={TLD}&api_token={api_token}
```
**Description**: Gets a list of DNS servers associated with the requested domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the DomainName. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the DomainName. MaxLength- 10 |
---
#### Get DNS host records for domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.dns.gethosts`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.dns.gethosts?SLD={SLD}&TLD={TLD}&api_token={api_token}
```
**Description**: Retrieves DNS host record settings for the requested domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the domain to getHosts. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the domain to getHosts. MaxLength- 10 |
---
#### Retrieve domain's email forwarding settings
**Method**: `GET` | **LowCodeAPI Path**: `/domains.dns.getemailforwarding`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.dns.getemailforwarding?DomainName={DomainName}&api_token={api_token}
```
**Description**: Gets email forwarding settings for the requested domain
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to get settings. MaxLength- 70 |
---
#### Enable email forwarding for a domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.dns.setemailforwarding`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.dns.setemailforwarding?DomainName={DomainName}&MailBox[1..n]={MailBox[1..n]}&ForwardTo[1..n]={ForwardTo[1..n]}&api_token={api_token}
```
**Description**: Sets email forwarding for a domain name.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to set settings. MaxLength- 70 |
|`MailBox[1..n]` | string | No | required |
|`ForwardTo[1..n]` | string | Yes | Email address to forwardto.For example- [email protected] |
---
#### Sets DNS host records settings for the requested domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.dns.sethosts`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.dns.sethosts?SLD={SLD}&TLD={TLD}&HostName[1..n]={HostName[1..n]}&RecordType[1..n]={RecordType[1..n]}&Address[1..n]={Address[1..n]}&MXPref[1..n]={MXPref[1..n]}&EmailType={EmailType}&TTL[1..n]={TTL[1..n]}&Flag={Flag}&Tag={Tag}&api_token={api_token}
```
**Description**: Sets DNS host records settings for the requested domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the domain to setHosts. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the domain to setHosts. MaxLength- 10 |
|`HostName[1..n]` | string | Yes | Sub-domain/hostname to create the record for |
|`RecordType[1..n]` | string | Yes | Possible values- A/ AAAA/ ALIAS/ CAA/ CNAME/ MX/ MXE/ NS/ TXT/ URL/ URL301/ FRAME |
|`Address[1..n]` | string | Yes | Possible values are URL or IP address. The value for this parameter is based on RecordType. |
|`MXPref[1..n]` | string | Yes | MX preference for host. Applicable for MX records only. |
|`EmailType` | string | Yes | Possible values are-
MXE - to set up your custom MXE record.
MX - to set up custom MX records of your mail provider.
FWD - to set up MX records for our Free Email Forwarding service.
OX - to set up MX records for our Private Email service. |
|`TTL[1..n]` | string | No | Time to live for all record types.Possible values- any value between 60 to 60000
Default Value- 1800 |
|`Flag` | string | No | Is an unsigned integer between 0 and 255. The flag value is an 8-bit number the most significant bit of which indicates the criticality of understanding of a record by a CA. It's recommended to use '0' |
|`Tag` | string | No | A non-zero sequence of US-ASCII letters and numbers in lower case. The tag value can be one of the following values-
issue — specifies the certification authority that is authorized to issue a certificate for the domain name or subdomain record used in the title.
issuewild — specifies the certification authority that is allowed to issue a wildcard certificate for the domain name or subdomain record used in the title. The certificate applies to the domain name or subdomain directly and to all its subdomains.
iodef — specifies the e-mail address or URL (compliant with RFC 5070) a CA should use to notify a client if any issuance policy violation spotted by this CA. |
---
### Category: Domains NS
#### Creates a new nameserver
**Method**: `GET` | **LowCodeAPI Path**: `/domains.ns.create`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.ns.create?SLD={SLD}&TLD={TLD}&Nameserver={Nameserver}&IP={IP}&api_token={api_token}
```
**Description**: Creates a new nameserver.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the DomainName. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the DomainName. MaxLength- 10 |
|`Nameserver` | string | Yes | Nameserver to create. MaxLength- 150 |
|`IP` | string | Yes | Nameserver IP address. MaxLength- 15 |
---
#### Deletes a nameserver associated with the requested domain
**Method**: `GET` | **LowCodeAPI Path**: `/domains.ns.delete`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.ns.delete?SLD={SLD}&TLD={TLD}&Nameserver={Nameserver}&api_token={api_token}
```
**Description**: Deletes a nameserver associated with the requested domain.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the DomainName. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the DomainName. MaxLength- 10 |
|`Nameserver` | string | Yes | Nameserver to delete. MaxLength- 150 |
---
#### Retrieves information about a registered nameserver
**Method**: `GET` | **LowCodeAPI Path**: `/domains.ns.getinfo`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.ns.getinfo?SLD={SLD}&TLD={TLD}&Nameserver={Nameserver}&api_token={api_token}
```
**Description**: Retrieves information about a registered nameserver.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the DomainName. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the DomainName. MaxLength- 10 |
|`Nameserver` | string | Yes | Nameserver. MaxLength- 150 |
---
#### Updates the IP address of a registered nameserver
**Method**: `GET` | **LowCodeAPI Path**: `/domains.ns.update`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.ns.update?SLD={SLD}&TLD={TLD}&Nameserver={Nameserver}&OldIP={OldIP}&IP={IP}&api_token={api_token}
```
**Description**: Updates the IP address of a registered nameserver.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`SLD` | string | Yes | SLD of the DomainName. MaxLength- 70 |
|`TLD` | string | Yes | TLD of the DomainName. MaxLength- 10 |
|`Nameserver` | string | Yes | Nameserver. MaxLength- 150 |
|`OldIP` | string | Yes | Existing IP address. MaxLength- 15 |
|`IP` | string | Yes | New IP address. MaxLength- 15 |
---
### Category: Domains Transfer
#### Transfers a domain to Namecheap
**Method**: `GET` | **LowCodeAPI Path**: `/domains.transfer.create`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.transfer.create?DomainName={DomainName}&Years={Years}&EPPCode={EPPCode}&PromotionCode={PromotionCode}&AddFreeWhoisguard={AddFreeWhoisguard}&WGenable={WGenable}&api_token={api_token}
```
**Description**: Transfers a domain to Namecheap. You can only transfer .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 domains through API at this time.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to transfer. MaxLength- 70 |
|`Years` | string | Yes | Though it is possible to configure a transfer price up to 10 years the duration should be set to 1 year only. MaxLength- 1 |
|`EPPCode` | string | Yes | The EPPCode is required for transferring .biz; .ca; .cc; .co; .com; .com.pe; .in; .info; .me; .mobi; .net; net.pe; .org; .org.pe; .pe; .tv; .us domains only. MaxLength- 20 |
|`PromotionCode` | string | No | Promotional (coupon) code for transfer. MaxLength- 20 |
|`AddFreeWhoisguard` | string | No | Adds free domain privacy for the domain. MaxLength- 3 Default Value- Yes |
|`WGenable` | string | No | Enables free domain privacy for the domain. MaxLength- 3 Default Value- No |
---
#### Gets the status of a particular transfer
**Method**: `GET` | **LowCodeAPI Path**: `/domains.transfer.getstatus`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.transfer.getstatus?TransferID={TransferID}&api_token={api_token}
```
**Description**: Gets the status of a particular transfer.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`TransferID` | number | Yes | The unique Transfer ID which you get after placing a transfer request. MaxLength- 10 |
---
#### Updates the status of a particular transfer
**Method**: `GET` | **LowCodeAPI Path**: `/domains.transfer.updatestatus`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.transfer.updatestatus?TransferID={TransferID}&Resubmit={Resubmit}&api_token={api_token}
```
**Description**: Updates the status of a particular transfer. Allows you to re-submit the transfer after releasing the registry lock.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`TransferID` | number | Yes | The unique Transfer ID which you get after placing a transfer request. MaxLength- 10 |
|`Resubmit` | string | Yes | The value 'true' resubmits the transfer. MaxLength- 5 |
---
#### Gets the list of domain transfers
**Method**: `GET` | **LowCodeAPI Path**: `/domains.transfer.getlist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/domains.transfer.getlist?ListType={ListType}&SearchTerm={SearchTerm}&Page={Page}&PageSize={PageSize}&SortBy={SortBy}&api_token={api_token}
```
**Description**: Gets the list of domain transfers.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ListType` | string | No | Possible values are ALL/INPROGRESS/ CANCELLED/COMPLETED. Default Value- ALL MaxLength- 10 |
|`SearchTerm` | string | No | The keyword should be a domain name. MaxLength- 70 |
|`Page` | number | No | Page to return. Default Value- 1 MaxLength- 10 |
|`PageSize` | number | No | Number of transfer to be listed on a page. Minimum value- 10; Maximum value- 100
Default Value- 10 MaxLength- 10 |
|`SortBy` | string | No | Possible values are DOMAINNAME/ DOMAINNAME_DESC/TRANSFERDATE/ TRANSFERDATE_DESC/STATUSDATE/ STATUSDATE_DESC. Default Value- DOMAINNAME MaxLength- 50 |
---
### Category: SSL
#### Creates a new SSL certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.create`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.create?Years={Years}&Type={Type}&SANStoADD={SANStoADD}&PromotionCode={PromotionCode}&api_token={api_token}
```
**Description**: Creates a new SSL certificate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`Years` | number | Yes | Number of years SSL will be issued for. Allowed values- 1/2/3/4/5. MaxLength- 1 |
|`Type` | string | Yes | SSL product name. See "Possible values for Type parameter" below this table. MaxLength- 50 |
|`SANStoADD` | number | No | Defines number of add-on domains to be purchased in addition to the default number of domains included into a multi-domain certificate. MaxLength- 2 |
|`PromotionCode` | string | No | Promotional (coupon) code for the certificate. MaxLength- 20 |
---
#### Returns a list of SSL certificates for the particular user
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.getlist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.getlist?ListType={ListType}&SearchTerm={SearchTerm}&Page={Page}&PageSize={PageSize}&SortBy={SortBy}&api_token={api_token}
```
**Description**: Returns a list of SSL certificates for the particular user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ListType` | string | No | Possible values are ALL/Processing/EmailSent/TechnicalProblem/InProgress/ Completed/Deactivated/Active/Cancelled/NewPurchase/ NewRenewal. Default Value- All. MaxLength- 50 |
|`SearchTerm` | string | No | Keyword to look for on the SSL list. MaxLength- 70 |
|`Page` | number | No | Page to return. Default Value- 1. MaxLength- 10 |
|`PageSize` | number | No | Total number of SSL certificates to display in a page. Minimum value is 10 and maximum value is 100. Default Value- 20. MaxLength- 100 |
|`SortBy` | string | No | Possible values are PURCHASEDATE/ PURCHASEDATE_DESC/ SSLTYPE/ SSLTYPE_DESC/ EXPIREDATETIME/ EXPIREDATETIME_DESC/Host_Name/ Host_Name_DESC. MaxLength- 20 |
---
#### Parsers the CSR
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.parsecsr`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.parsecsr?csr={csr}&CertificateType={CertificateType}&api_token={api_token}
```
**Description**: Parsers the CSR
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`csr` | string | Yes | Certificate Signing Request. MaxLength- 2000 |
|`CertificateType` | string | No | Type of SSL Certificate. MaxLength- 50 |
---
#### Gets approver email list for the requested certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.getapproveremaillist`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.getapproveremaillist?DomainName={DomainName}&CertificateType={CertificateType}&api_token={api_token}
```
**Description**: Gets approver email list for the requested certificate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`DomainName` | string | Yes | Domain name to get the list. MaxLength- 70 |
|`CertificateType` | string | Yes | Type of SSL certificate. MaxLength- 50 |
---
#### Activates a newly purchased SSL certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.activate`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.activate?api_token={api_token}
```
**Description**: Activates a newly purchased SSL certificate
---
#### Resends the approver email
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.resendapproveremail`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.resendapproveremail?CertificateID={CertificateID}&api_token={api_token}
```
**Description**: Resends the approver email
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`CertificateID` | string | Yes | The unique certificate ID that you get after calling ssl.create command. MaxLength- 10 |
---
#### Retrieves information about the requested SSL certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.getinfo`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.getinfo?CertificateID={CertificateID}&api_token={api_token}
```
**Description**: Retrieves information about the requested SSL certificate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`CertificateID` | number | Yes | Unique ID of the SSL certificate. MaxLength- 10 |
---
#### Renews an SSL certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.renew`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.renew?CertificateID={CertificateID}&Years={Years}&SSLType={SSLType}&PromotionCode={PromotionCode}&api_token={api_token}
```
**Description**: Renews an SSL certificate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`CertificateID` | number | Yes | Unique ID of the SSL certificate you wish to renew. MaxLength- 9 |
|`Years` | number | Yes | Number of years renewal SSL will be issued for. Allowed values- 1/2/3/4/5. MaxLength- 1 |
|`SSLType` | string | Yes | SSL product name. See "Possible values for SSLType parameter" below this table. MaxLength- 50 |
|`PromotionCode` | string | No | Promotional (coupon) code for the certificate. MaxLength- 20 |
---
#### Reissues an SSL certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.reissue`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.reissue?api_token={api_token}
```
**Description**: Reissues an SSL certificate
---
#### Resends the fulfilment email containing the certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.resendfulfillmentemail`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.resendfulfillmentemail?CertificateID={CertificateID}&api_token={api_token}
```
**Description**: Resends the fulfilment email containing the certificate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`CertificateID` | string | Yes | The unique certificate ID that you get after calling ssl.create command. MaxLength- 10 |
---
#### Buy additional domains for existing certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.purchasemoresans`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.purchasemoresans?CertificateID={CertificateID}&NumberOfSANSToAdd={NumberOfSANSToAdd}&api_token={api_token}
```
**Description**: Purchases more add-on domains for already purchased certificate.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`CertificateID` | number | Yes | ID of the certificate for which you wish to purchase more add-on domains. MaxLength-10 |
|`NumberOfSANSToAdd` | number | Yes | Number of add-on domains to be ordered. MaxLength- 2 |
---
#### Revokes a re-issued SSL certificate
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.revokecertificate`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.revokecertificate?CertificateID={CertificateID}&CertificateType={CertificateType}&api_token={api_token}
```
**Description**: Revokes a re-issued SSL certificate
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`CertificateID` | number | Yes | ID of the certificate for you wish to revoke. Default Value- 1. MaxLength- 10 |
|`CertificateType` | string | Yes | Type of SSL Certificate. MaxLength- 50 |
---
#### Update certificate validation method or retry mechanism
**Method**: `GET` | **LowCodeAPI Path**: `/ssl.editdcvmethod`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/ssl.editdcvmethod?CertificateID={CertificateID}&DCVMethod*={DCVMethod*}&DNSNames**={DNSNames**}&DCVMethods**={DCVMethods**}&api_token={api_token}
```
**Description**: Sets new domain control validation (DCV) method for a certificate or serves as 'retry' mechanism
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`CertificateID` | number | Yes | Unique ID of the SSL certificate to set new DCV method for. MaxLength- 10 |
|`DCVMethod*` | string | Yes | DCV method to validate domain control with. MaxLength- 255 |
|`DNSNames**` | string | Yes | Comma-separated list of domain names to set new DCV method for. MaxLength- 3500 |
|`DCVMethods**` | string | Yes | Comma-separated list of DCV methods to validate domain control with. MaxLength- 3500 |
---
### Category: Users
#### Returns pricing information for a requested product type
**Method**: `GET` | **LowCodeAPI Path**: `/users.getpricing`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.getpricing?ProductType={ProductType}&ProductCategory={ProductCategory}&PromotionCode={PromotionCode}&ActionName={ActionName}&ProductName={ProductName}&api_token={api_token}
```
**Description**: Returns pricing information for a requested product type.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`ProductType` | string | Yes | Product Type to get pricing information. MaxLength- 20 |
|`ProductCategory` | string | No | Specific category within a product type. MaxLength- 20 |
|`PromotionCode` | string | No | Promotional (coupon) code for the user. MaxLength- 20 |
|`ActionName` | string | No | Specific action within a product type. MaxLength- 20 |
|`ProductName` | string | No | The name of the product within a product type. MaxLength- 20 |
---
#### Get account fund details: balances, earnings, withdrawals
**Method**: `GET` | **LowCodeAPI Path**: `/users.getbalances`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.getbalances?api_token={api_token}
```
**Description**: Gets information about fund in the user's account.This method returns the following information: Available Balance, Account Balance, Earned Amount, Withdrawable Amount and Funds Required for AutoRenew.
---
#### Changes password of the particular user's account
**Method**: `GET` | **LowCodeAPI Path**: `/users.changepassword`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.changepassword?OldPassword={OldPassword}&NewPassword={NewPassword}&api_token={api_token}
```
**Description**: Changes password of the particular user's account
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`OldPassword` | string | Yes | Old password of the user. MaxLength- 20 |
|`NewPassword` | string | Yes | New password of the user. MaxLength- 20 |
---
#### Updates user account information for the particular user
**Method**: `GET` | **LowCodeAPI Path**: `/users.update`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.update?FirstName={FirstName}&LastName={LastName}&JobTitle={JobTitle}&Organization={Organization}&Address1={Address1}&Address2={Address2}&City={City}&StateProvince={StateProvince}&Zip={Zip}&Country={Country}&EmailAddress={EmailAddress}&Phone={Phone}&PhoneExt={PhoneExt}&Fax={Fax}&api_token={api_token}
```
**Description**: Updates user account information for the particular user
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`FirstName` | string | Yes | First name of the user. MaxLength- 70 |
|`LastName` | string | Yes | Last name of the user. MaxLength- 70 |
|`JobTitle` | string | No | Job designation of the user. MaxLength- 60 |
|`Organization` | string | No | Organization of the user. MaxLength- 60 |
|`Address1` | string | Yes | StreetAddress1 of the user. MaxLength- 60 |
|`Address2` | string | No | StreetAddress2 of the user. MaxLength- 60 |
|`City` | string | Yes | City of the user. MaxLength- 60 |
|`StateProvince` | string | Yes | State/Province of the user. MaxLength- 60 |
|`Zip` | string | Yes | Zip/Postal code of the user. MaxLength- 15 |
|`Country` | string | Yes | Two letter country code of the user. MaxLength- 2 |
|`EmailAddress` | string | Yes | Email address of the user. MaxLength- 255 |
|`Phone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
|`PhoneExt` | string | No | PhoneExt of the user. MaxLength- 10 |
|`Fax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
---
#### Creates a request to add funds through a credit card
**Method**: `GET` | **LowCodeAPI Path**: `/users.createaddfundsrequest`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.createaddfundsrequest?Username={Username}&PaymentType={PaymentType}&Amount={Amount}&ReturnUrl={ReturnUrl}&api_token={api_token}
```
**Description**: Creates a request to add funds through a credit card
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`Username` | string | Yes | Username to add funds to. MaxLength- 20 |
|`PaymentType` | string | Yes | Allowed payment value- Creditcard. MaxLength- 30 |
|`Amount` | number | Yes | Amount to add. MaxLength- 10 |
|`ReturnUrl` | string | Yes | A valid URL to which the user should be redirected once payment is complete. MaxLength- 300 |
---
#### Gets the status of add funds request
**Method**: `GET` | **LowCodeAPI Path**: `/users.getaddfundsstatus`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.getaddfundsstatus?TokenId={TokenId}&api_token={api_token}
```
**Description**: Gets the status of add funds request
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`TokenId` | string | Yes | The Unique ID that you received after calling namecheap.users.createaddfundsrequest method. MaxLength- 100 |
---
#### Creates a new account at NameCheap under this ApiUser
**Method**: `GET` | **LowCodeAPI Path**: `/users.create`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.create?NewUserName={NewUserName}&NewUserPassword={NewUserPassword}&EmailAddress={EmailAddress}&IgnoreDuplicateEmailAddress={IgnoreDuplicateEmailAddress}&FirstName={FirstName}&LastName={LastName}&AcceptTerms={AcceptTerms}&AcceptNews={AcceptNews}&JobTitle={JobTitle}&Organization={Organization}&Address1={Address1}&Address2={Address2}&City={City}&StateProvince={StateProvince}&Zip={Zip}&Country={Country}&Phone={Phone}&PhoneExt={PhoneExt}&Fax={Fax}&api_token={api_token}
```
**Description**: Creates a new account at NameCheap under this ApiUser
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`NewUserName` | string | Yes | Username for the new user account. MaxLength- 20 |
|`NewUserPassword` | string | Yes | Password for the new user account. MaxLength- 20 |
|`EmailAddress` | string | Yes | Email address of the user. MaxLength- 128 |
|`IgnoreDuplicateEmailAddress` | string | No | By default it ignores to check if the email address is already in use. Default Value- Yes. MaxLength- 10 |
|`FirstName` | string | Yes | First name of the user. MaxLength- 60 |
|`LastName` | string | Yes | Last name of the user. MaxLength- 60 |
|`AcceptTerms` | number | Yes | Terms of agreement. The Value should be 1 for user account creation.
Default Value- 1. MaxLength- 1 |
|`AcceptNews` | number | No | Possible values are 0 and 1. Value should be 1 if the user wants to recieve newsletters else it should be 0. MaxLength- 1 |
|`JobTitle` | string | No | Job designation of the user. MaxLength- 60 |
|`Organization` | string | No | Organization of the user. MaxLength- 60 |
|`Address1` | string | Yes | StreetAddress1 of the user. MaxLength- 60 |
|`Address2` | string | No | StreetAddress2 of the user. MaxLength- 60 |
|`City` | string | Yes | City of the user. MaxLength- 60 |
|`StateProvince` | string | Yes | State/Province of the user. MaxLength- 60 |
|`Zip` | string | Yes | Zip/Postal code of the user. MaxLength- 15 |
|`Country` | string | Yes | Two letter country code of the user. MaxLength- 2 |
|`Phone` | string | Yes | Phone number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
|`PhoneExt` | string | No | PhoneExt of the user. MaxLength- 10 |
|`Fax` | string | No | Fax number in the format +NNN.NNNNNNNNNN. MaxLength- 20 |
---
#### Verify user account credentials with namecheap.users.create API
**Method**: `GET` | **LowCodeAPI Path**: `/users.login`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.login?Password={Password}&api_token={api_token}
```
**Description**: Validates the username and password of user accounts you have created using the API command namecheap.users.create.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`Password` | string | Yes | Password of the user account. MaxLength- 20 |
---
#### API sends password reset link via email
**Method**: `GET` | **LowCodeAPI Path**: `/users.resetpassword`
**Full URL**:
```
https://api.lowcodeapi.com/namecheap/users.resetpassword?FindBy={FindBy}&FindByValue={FindByValue}&EmailFromName={EmailFromName}&EmailFrom={EmailFrom}&URLPattern={URLPattern}&api_token={api_token}
```
**Description**: When you call this API, a link to reset password will be emailed to the end user's profile email id.The end user needs to click on the link to reset password.
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`FindBy` | string | Yes | Possible values-EMAILADDRESS/ DOMAINNAME/USERNAME. MaxLength- 20 |
|`FindByValue` | string | Yes | The username/email address/domain of the user. MaxLength- 20 |
|`EmailFromName` | string | No | Enter a different value to overwrite the default value. Default Value- namecheap.com MaxLength- 20 |
|`EmailFrom` | string | No | Enter a different value to overwrite the default value. Default Value- [email protected] MaxLength- 20 |
|`URLPattern` | string | No | Enter a different URL to overwrite namecheap.com. Refer Example Request#2
MaxLength- 20 Default Value- http |
---
## Complete Endpoint Reference
For a complete list of all 59 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/namecheap/definition`
- **Official Provider Documentation**: https://www.namecheap.com/support/api/intro/