PHPackages                             kregel/namecheap-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kregel/namecheap-sdk

ActiveLibrary[API Development](/categories/api)

kregel/namecheap-sdk
====================

Namecheap API

v0.2.0(11y ago)018Apache-2.0PHPPHP &gt;=5.3.0

Since Jun 30Pushed 6y ago1 watchersCompare

[ Source](https://github.com/austinkregel/namecheap-php-sdk)[ Packagist](https://packagist.org/packages/kregel/namecheap-sdk)[ Docs](https://github.com/speedster-kiev/namecheap-php-sdk)[ RSS](/packages/kregel-namecheap-sdk/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)DependenciesVersions (4)Used By (0)

Namecheap PHP SDK
=================

[](#namecheap-php-sdk)

Currently underdevelopment, and open to new PRs and issues.

### Installation

[](#installation)

You can install the package via composer:

```
composer require kregel/namecheap-sdk

```

### Usage

[](#usage)

```
use Kregel\Namecheap\Api;
use Kregel\Namecheap\Config;

$config = new Config($apiUser, $apiKey, $username, $clientIp);

$client = new Guzzlehttp\Client([
    'base_uri' => Api::ENV_SANDBOX
]);

$api = new Api($config, $client)

$myDomains = $api->domains()
    ->getList();
// Do stuff with my domains.
```

### Testing

[](#testing)

```
composer test

```

That will also generate code coverage which you can see in the `build/coverage` directory.

---

Planned or available features. Right now I will only be adding in features that I need personally. If there is something that you need, please make a PR for it.

*Note:* Due to Namecheaps... Odd way of naming and doing things for their docs this feature/roadmap list will follow the format \[Command - description\]

### Domain Features

[](#domain-features)

- domains.getList - A list of domains for the authenticated user
- domains.getContacts - The contact information of a domain, usually the information discovered through Whois.
- domains.create - Register a new domain name
- domains.getTldList - A list of all TLDS that can be registered on Namecheap
- domains.setContacts - Sets the whois information for a domain
- domains.check - Checks to see if a domain is available.
- domains.reactivate - Reactivates an expired domain
- domains.renew - Renews an expiring domain
- domains.getRegistrarLock - Gets the RegistrarLock status of a domain (used for transferring domains out of/to a registrar)
- domains.setRegistrarLock - Sets the status of a domain
- domains.getInfo - Returns information about a requested domain.

##### DNS

[](#dns)

- domains.dns.setDefault - Sets the domain servers to the Namecheap default DNS servers. (Which is required for using their DNS editing interface)
- domains.dns.setCustom - Sets the domain servers
- domains.dns.getList - Gets the DNS servers for a domain
- domains.dns.getHosts - Gets the DNS host record settings for a domain
- domains.dns.getEmailForwarding - Gets the email forward settings
- domains.dns.setEmailForwarding - sets the email forward settings
- domains.dns.setHosts - Set the host records for a domain

##### NS

[](#ns)

- domains.ns.create - Creates a new nameserver
- domains.ns.delete - deletes a nameserver
- domains.ns.getInfo - Gets the info about a nameserver
- domains.ns.update - Updates the IP of a nameserver

##### Transfer

[](#transfer)

- domains.transfer.create - 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
- domains.transfer.getStatus - Get the status of a transfer
- domains.transfer.updateStatus - Update the status of a transfer
- domains.transfer.getList - get the list of domain transfers.

##### SSL

[](#ssl)

As of this moment I am not supporting SSL through NC because of projects like LetsEncrypt, where you can get free SSL certs.

### Users

[](#users)

- users.getPricing - Returns the pricing info for a requested product
- users.getBalances - Get information about funds on a users account.
- users.changePassword - Changes the password for a user
- users.update - Updates user account information
- users.createaddfundrequest - Creates a request to add funds for a user through a credit card
- users.getAddFundsStatus - Gets the status of a funds transfer
- users.create - Create a new namecheap account under the APIUser
- users.login - validates a username/password
- users.resetPassword - Sends a reset password link to the users email.

##### Address

[](#address)

- users.address.create - creates a new address for a user
- users.address.delete - deletes an address for a user
- users.address.getInfo - gets information about an address
- users.address.getlist - gets a list of address for the user
- users.address.setDefault - Set the default address
- users.address.update - Updates a particular address

### WhoIsGuard

[](#whoisguard)

- whoisguard.changeemailaddress - Change the WhoIsGuard email address
- whoisguard.enable - enable whois guard
- whoisguard.disable - disable whoisguard
- whoisguard.unallot - unallot whoisguard
- whoisguard.discard - discards whoisguard
- whoisguard.allot - allots whoisguard
- whoisguard.getList - Gets a list of WhoisGuard privacy protection
- whoisguard.renew - Renews WhoisGuard privacy protection

License The MIT License (MIT). Please see License File for more information.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 53.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~775 days

Total

3

Last Release

2783d ago

PHP version history (2 changes)v0.1PHP &gt;=5.3.0

v0.0.1PHP &gt;=7.1.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/2c5c1ee0adf552aec8a54c1760dd99c4d1b90c0360dccafeef849a14ff37f706?d=identicon)[austinkregel](/maintainers/austinkregel)

---

Top Contributors

[![speedster-kiev](https://avatars.githubusercontent.com/u/1425964?v=4)](https://github.com/speedster-kiev "speedster-kiev (15 commits)")[![aaronhuisinga](https://avatars.githubusercontent.com/u/2423844?v=4)](https://github.com/aaronhuisinga "aaronhuisinga (5 commits)")[![austinkregel](https://avatars.githubusercontent.com/u/5355937?v=4)](https://github.com/austinkregel "austinkregel (4 commits)")[![dani3l](https://avatars.githubusercontent.com/u/1437502?v=4)](https://github.com/dani3l "dani3l (2 commits)")[![nonetallt](https://avatars.githubusercontent.com/u/22174322?v=4)](https://github.com/nonetallt "nonetallt (2 commits)")

---

Tags

hacktoberhacktoberfestnamecheapapinamecheap

### Embed Badge

![Health badge](/badges/kregel-namecheap-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/kregel-namecheap-sdk/health.svg)](https://phpackages.com/packages/kregel-namecheap-sdk)
```

###  Alternatives

[m165437/laravel-blueprint-docs

API Blueprint Renderer for Laravel

22779.0k](/packages/m165437-laravel-blueprint-docs)[naturalbuild/namecheap-sdk

SDK library for Namecheap APIs

1623.6k1](/packages/naturalbuild-namecheap-sdk)[karazieiev/namecheap-php-sdk

Namecheap API

1810.3k](/packages/karazieiev-namecheap-php-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
