PHPackages dnsimple/dnsimple - 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. dnsimple/dnsimple ActiveLibrary[API Development](/categories/api) dnsimple/dnsimple ================= The DNSimple API client for PHP. v6.2.0(1mo ago)11190.9k↑80.6%5[1 PRs](https://github.com/dnsimple/dnsimple-php/pulls)1MITPHPPHP ^8.3CI passing Since Sep 14Pushed 1mo ago9 watchersCompare [ Source](https://github.com/dnsimple/dnsimple-php)[ Packagist](https://packagist.org/packages/dnsimple/dnsimple)[ Docs](https://github.com/dnsimple/dnsimple-php)[ RSS](/packages/dnsimple-dnsimple/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (6)Versions (31)Used By (1) DNSimple PHP Client =================== [](#dnsimple-php-client) A PHP client for the [DNSimple API v2](https://developer.dnsimple.com/v2/). [![Build Status](https://github.com/dnsimple/dnsimple-php/actions/workflows/ci.yml/badge.svg)](https://github.com/dnsimple/dnsimple-php/actions/workflows/ci.yml) Requirements ------------ [](#requirements) - PHP ^8.3 - An activated DNSimple account Installation ------------ [](#installation) Using [Composer](https://getcomposer.org/) is the recommended way to install. The PHP client is available via [Packagist](https://packagist.org/) under the [`dnsimple/dnsimple`](https://packagist.org/packages/dnsimple/dnsimple) package. If Composer is installed globally on your system, you can run the following in the base directory of your project to add the package as a dependency: ``` composer require dnsimple/dnsimple ``` Usage ----- [](#usage) This library is a PHP client you can use to interact with the [DNSimple API v2](https://developer.dnsimple.com/v2/). Here are some examples. ``` use Dnsimple\Client; $client = new Client("API_TOKEN"); $response = $client->identity->whoami(); $whoami = $response->getData(); $account_id = $whoami->account->id; $response = $client->domains->listDomains($account_id); $domains = $response->getData(); ``` ### Research a domain [](#research-a-domain) > **Note:** This endpoint is part of a Private Beta. During the beta period, changes to the endpoint may occur at any time. If interested in using this endpoint, reach out to [DNSimple support](support@dnsimple.com). Research a domain name for availability and registration status information: ``` use Dnsimple\Client; $client = new Client("API_TOKEN"); $response = $client->domains->domainResearchStatus($account_id, "example.com"); $research = $response->getData(); echo $research->domain; // "example.com" echo $research->availability; // "unavailable" echo $research->request_id; // "f453dabc-a27e-4bf1-a93e-f263577ffaae" print_r($research->errors); // [] ``` Configuration ------------- [](#configuration) ### Sandbox Environment [](#sandbox-environment) We highly recommend testing against our [sandbox environment](https://developer.dnsimple.com/sandbox/) before using our production environment. This will allow you to avoid real purchases, live charges on your credit card, and reduce the chance of your running up against rate limits. The client supports both the production and sandbox environment. To switch to sandbox pass the sandbox API host using the `base_uri` option when you construct the client: ``` use Dnsimple\Client; $client = new Client("API_TOKEN", ["base_uri" => 'https://api.sandbox.dnsimple.com']); ``` You will need to ensure that you are using an access token created in the sandbox environment. Production tokens will *not* work in the sandbox environment. ### Setting a custom `User-Agent` header [](#setting-a-custom-user-agent-header) You can customize the `User-Agent` header for the calls made to the DNSimple API: ``` use Dnsimple\Client; $client = new Client("API_TOKEN", ["user_agent" => "my-app/1.0"]); ``` The value you provide will be appended to the default `User-Agent` the client uses. For example, if you use `my-app/1.0`, the final header value will be `dnsimple-php/x.x.x my-app/1.0` (note that it will vary depending on the client version). Documentation ------------- [](#documentation) - [dnsimple-php Packagist](https://packagist.org/packages/dnsimple/dnsimple) - [DNSimple API documentation](https://developer.dnsimple.com/) - [DNSimple API examples repository](https://github.com/dnsimple/dnsimple-api-examples) - [DNSimple support documentation](https://support.dnsimple.com/) Contributing ------------ [](#contributing) Contributions are welcome! Please feel free to submit issues and pull requests. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. Changelog --------- [](#changelog) See [CHANGELOG.md](CHANGELOG.md) for details. License ------- [](#license) Copyright (c) 2015-2026 DNSimple Corporation. This is Free Software distributed under the [MIT License](LICENSE.txt). ### Health Score 63 — FairBetter than 99% of packages Maintenance90 Actively maintained with recent releases Popularity43 Moderate usage in the ecosystem Community27 Small or concentrated contributor base Maturity80 Battle-tested with a long release history Bus Factor2 2 contributors hold 50%+ of commits 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 ~118 days Recently: every ~78 days Total 18 Last Release 56d ago Major Versions v1.4.0 → v2.0.02024-03-12 v2.0.0 → v3.0.02024-12-12 v3.0.0 → v4.0.02025-05-14 v4.0.0 → v5.0.02025-08-20 v5.0.0 → v6.0.02026-01-22 PHP version history (6 changes)v0.1.0PHP >=7.2 v0.2.0PHP >=7.2.5 v0.2.1PHP ^7.3 v1.0.0PHP ^7.3 || ^8.0 v2.0.0PHP ^8.2 v4.0.0PHP ^8.3 ### Community Maintainers ![](https://www.gravatar.com/avatar/3a143483b152de4d9a56b0d3aa2733937c227077e31ed9e537b83959527ec191?d=identicon)[weppos](/maintainers/weppos) ![](https://www.gravatar.com/avatar/14b03ece41dc5e0126bfef0d5337935f8efab882404c73aef5d7685f1af9c8ce?d=identicon)[dnsimple-release](/maintainers/dnsimple-release) --- Top Contributors [![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (79 commits)")[![weppos](https://avatars.githubusercontent.com/u/5387?v=4)](https://github.com/weppos "weppos (63 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (12 commits)")[![DXTimer](https://avatars.githubusercontent.com/u/17004703?v=4)](https://github.com/DXTimer "DXTimer (11 commits)")[![AGS4NO](https://avatars.githubusercontent.com/u/47795400?v=4)](https://github.com/AGS4NO "AGS4NO (10 commits)")[![ecomba](https://avatars.githubusercontent.com/u/55259?v=4)](https://github.com/ecomba "ecomba (9 commits)")[![OleMchls](https://avatars.githubusercontent.com/u/584259?v=4)](https://github.com/OleMchls "OleMchls (8 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (6 commits)")[![dallasread](https://avatars.githubusercontent.com/u/900449?v=4)](https://github.com/dallasread "dallasread (6 commits)")[![juankuquintana](https://avatars.githubusercontent.com/u/4212649?v=4)](https://github.com/juankuquintana "juankuquintana (5 commits)")[![lokst](https://avatars.githubusercontent.com/u/2923526?v=4)](https://github.com/lokst "lokst (5 commits)")[![ggalmazor](https://avatars.githubusercontent.com/u/205913?v=4)](https://github.com/ggalmazor "ggalmazor (4 commits)")[![duduribeiro](https://avatars.githubusercontent.com/u/771411?v=4)](https://github.com/duduribeiro "duduribeiro (3 commits)")[![jacegu](https://avatars.githubusercontent.com/u/381143?v=4)](https://github.com/jacegu "jacegu (2 commits)")[![nestorsalceda](https://avatars.githubusercontent.com/u/310141?v=4)](https://github.com/nestorsalceda "nestorsalceda (1 commits)")[![deanlj](https://avatars.githubusercontent.com/u/4245429?v=4)](https://github.com/deanlj "deanlj (1 commits)") --- Tags apiapi-clientdnsimplednsimple-apidnsimple-policy-engdnsimple-policy-group-apiclientdnsimple-policy-triage-applicationphpdnsimple ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/dnsimple-dnsimple/health.svg) ``` [![Health](https://phpackages.com/badges/dnsimple-dnsimple/health.svg)](https://phpackages.com/packages/dnsimple-dnsimple) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[hardcastle/xrpl_php PHP SDK / Client for the XRP Ledger 129.7k5](/packages/hardcastle-xrpl-php)[convertkit/convertkitapi Kit PHP SDK for the Kit API 2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk Rest Client SDK for hydra API 1125.9k2](/packages/mapado-rest-client-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)