PHPackages                             api-clients/pi-hole - 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. api-clients/pi-hole

ActiveLibrary[API Development](/categories/api)

api-clients/pi-hole
===================

Async first Pi-Hole API Client for PHP 7

1.0.0(8y ago)3451[1 PRs](https://github.com/php-api-clients/pi-hole/pulls)MITPHPPHP ^7.0

Since Aug 28Pushed 2y ago1 watchersCompare

[ Source](https://github.com/php-api-clients/pi-hole)[ Packagist](https://packagist.org/packages/api-clients/pi-hole)[ RSS](/packages/api-clients-pi-hole/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependencies (10)Versions (3)Used By (0)

Async first Pi-Hole API Client for PHP 7
========================================

[](#async-first-pi-hole-api-client-for-php-7)

[![Build Status](https://camo.githubusercontent.com/0cfbb8f2d1599607133bb880144bef2537f7e3765e060cfc8a1e621228017dd3/68747470733a2f2f7472617669732d63692e6f72672f7068702d6170692d636c69656e74732f70692d686f6c652e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/php-api-clients/pi-hole)[![Latest Stable Version](https://camo.githubusercontent.com/1ca4451d78f803e757e2586eb8598a79fa1db9e3480be48b1f59ecf8d042c8b9/68747470733a2f2f706f7365722e707567782e6f72672f6170692d636c69656e74732f70692d686f6c652f762f737461626c652e706e67)](https://packagist.org/packages/api-clients/pi-hole)[![Total Downloads](https://camo.githubusercontent.com/a1775ba8ffcaaeb0918606e14bc7799d33b8f04eb1ff52ec7f921cd12181f27e/68747470733a2f2f706f7365722e707567782e6f72672f6170692d636c69656e74732f70692d686f6c652f646f776e6c6f6164732e706e67)](https://packagist.org/packages/api-clients/pi-hole)[![Code Coverage](https://camo.githubusercontent.com/e1541257d9a8fe344a5f0112363275159ba4302b2815a69ed69634e2151048bb/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f7068702d6170692d636c69656e74732f70692d686f6c652f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/php-api-clients/pi-hole/?branch=master)[![License](https://camo.githubusercontent.com/e74872533d25af04f5d10c22f6b1d2c42e07728669a6576a877b310e0a65d4e8/68747470733a2f2f706f7365722e707567782e6f72672f6170692d636c69656e74732f70692d686f6c652f6c6963656e73652e706e67)](https://packagist.org/packages/api-clients/pi-hole)[![PHP 7 ready](https://camo.githubusercontent.com/ef99728ff8e9b1fae48a4f003230f16fd2022fc49661bcfe9eb7c01f04c9ff44/687474703a2f2f7068703772656164792e74696d6573706c696e7465722e63682f7068702d6170692d636c69656e74732f70692d686f6c652f62616467652e737667)](https://pi-hole-ci.org/php-api-clients/pi-hole)

Install
=======

[](#install)

To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.

```
composer require api-clients/pi-hole

```

Usage
=====

[](#usage)

The client needs two things, the ReactPHP event loop, and your PI Hole's hostname. Once you created the client you can call the `overview` method to get to stats as shown on the dashboard.

```
use ApiClients\Client\PiHole\AsyncClient;
use ApiClients\Client\PiHole\Resource\OverviewInterface;
use React\EventLoop\Factory;
use function ApiClients\Foundation\resource_pretty_print;

require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor/autoload.php';

$loop = Factory::create();
$client = AsyncClient::create($loop, 'pi-hole.local');

$client->overview()->done(function (OverviewInterface $overview) {
    resource_pretty_print($overview);
});

$loop->run();
```

Examples
========

[](#examples)

The [`examples`](https://github.com/php-api-clients/pi-hole/tree/master/examples) directory is filled with all kinds of examples for this package.

License
=======

[](#license)

The MIT License (MIT)

Copyright (c) 2017 Cees-Jan Kiewiet

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

28

—

LowBetter than 51% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

3273d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/147145?v=4)[Cees-Jan Kiewiet](/maintainers/WyriHaximus)[@WyriHaximus](https://github.com/WyriHaximus)

---

Top Contributors

[![WyriHaximus](https://avatars.githubusercontent.com/u/147145?v=4)](https://github.com/WyriHaximus "WyriHaximus (8 commits)")

---

Tags

apiapi-clienthacktoberfestphpphp7pi-holepi-hole-clientreactphp

### Embed Badge

![Health badge](/badges/api-clients-pi-hole/health.svg)

```
[![Health](https://phpackages.com/badges/api-clients-pi-hole/health.svg)](https://phpackages.com/packages/api-clients-pi-hole)
```

###  Alternatives

[api-clients/github

Async first Github client

1680.2k](/packages/api-clients-github)[exsyst/swagger

A php library to manipulate Swagger specifications

35816.5M7](/packages/exsyst-swagger)[lucasdotvin/laravel-soulbscription

A straightforward interface to handle subscriptions and features consumption.

709209.3k](/packages/lucasdotvin-laravel-soulbscription)[pimax/fb-messenger-php

Facebook Messenger Bot PHP API

313188.5k2](/packages/pimax-fb-messenger-php)[api-clients/supervisord

Async first Supervisord XML-RPC client

163.5k](/packages/api-clients-supervisord)

PHPackages © 2026

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