PHPackages                             evilfreelancer/pihole-api-php - 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. evilfreelancer/pihole-api-php

ActiveLibrary[API Development](/categories/api)

evilfreelancer/pihole-api-php
=============================

Pi-Hole API PHP client

432PHPCI failing

Since Feb 29Pushed 6y ago1 watchersCompare

[ Source](https://github.com/EvilFreelancer/pihole-api-php)[ Packagist](https://packagist.org/packages/evilfreelancer/pihole-api-php)[ RSS](/packages/evilfreelancer-pihole-api-php/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

[![Latest Stable Version](https://camo.githubusercontent.com/fca172981fed8791844fd00779c0194e46bd2e95fa44518dbb919d601e97891e/68747470733a2f2f706f7365722e707567782e6f72672f6576696c667265656c616e6365722f7069686f6c652d6170692d7068702f762f737461626c65)](https://packagist.org/packages/evilfreelancer/pihole-api-php)[![Build Status](https://camo.githubusercontent.com/46f1e02af2cfb0ae5333f92e40bfcee0b4a16a0c8fa76f98f1fe1667b3b64b77/68747470733a2f2f7472617669732d63692e6f72672f4576696c467265656c616e6365722f7069686f6c652d6170692d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/EvilFreelancer/pihole-api-php)[![Total Downloads](https://camo.githubusercontent.com/bb5e68470b52d67369227732d8aaeabd84afdd347232eb50cc01ee2ae56fb3e4/68747470733a2f2f706f7365722e707567782e6f72672f6576696c667265656c616e6365722f7069686f6c652d6170692d7068702f646f776e6c6f616473)](https://packagist.org/packages/evilfreelancer/pihole-api-php)[![License](https://camo.githubusercontent.com/9690057998535f95ebf192307bb6e03604d0502071f380b2f07d54ba8cd80edf/68747470733a2f2f706f7365722e707567782e6f72672f6576696c667265656c616e6365722f7069686f6c652d6170692d7068702f6c6963656e7365)](https://packagist.org/packages/evilfreelancer/pihole-api-php)[![Code Climate](https://camo.githubusercontent.com/14f55a96fbc62c7f39a18cce05e87bffd17e1a432dfcb67c6cf82ea9eaa29ef6/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f4576696c467265656c616e6365722f7069686f6c652d6170692d7068702f6261646765732f6770612e737667)](https://codeclimate.com/github/EvilFreelancer/pihole-api-php)[![Code Coverage](https://camo.githubusercontent.com/2f95a8e936cfea4cd70c2e9c1dff65487d31c4425ec78d711eca2c5353473747/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f4576696c467265656c616e6365722f7069686f6c652d6170692d7068702f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/EvilFreelancer/pihole-api-php/?branch=master)[![Scrutinizer CQ](https://camo.githubusercontent.com/23c79c99c1e70d630c4ff25f3b0edf7d092c06a196a8cc820987f97b76af32e5/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6576696c667265656c616e6365722f7069686f6c652d6170692d7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/evilfreelancer/pihole-api-php/)

Pi-Hole API PHP client
======================

[](#pi-hole-api-php-client)

```
composer require evilfreelancer/pihole-api-php

```

How to use
----------

[](#how-to-use)

```
$config = new \PiHole\Config([
    'webpassword' => '6b600e5555af97b26ed51a5910a0b310d9da8e22a7aaf97ab0137bb4880ec55e',
    'base_url'    => 'http://192.168.1.10/admin/api.php'
]);

$client = new \PiHole\Client($config);

// Get all stats
$statistics = $client->statistics()->exec();
print_r($statistics);

// Get version of PiHole
$version = $client->version()->exec();
print_r($version);

// Enable ADBlocking on PiHole
$enable = $client->enable()->exec();
print_r($enable);

// Disable ADBlocking on PiHole
$disable = $client->disable()->exec();
print_r($disable);

// Logout from PiHole
$logout = $client->logout()->exec();
print_r($logout);
```

List of available configuration parameters
------------------------------------------

[](#list-of-available-configuration-parameters)

ParameterTypeDefaultDescriptionwebpasswordstring(required) Hash of passwordbase\_urlstring(required) Url with path to admin.phpproxystringHTTP proxy connection stringjson\_force\_objectbooltrueWill enable flag JSON\_FORCE\_OBJECT of json\_encodetimeoutint10Max timeout for answer from RouterOSattemptsint10Count of attempts to establish TCP sessiondelayint1Delay between attempts in secondsdebugbooltrueEnable full debug of all HTTP queriesLinks
=====

[](#links)

-

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/30aaf0db0441cada5c2d80127a9123e7f6f4091f7faf79d3f13001ef379373f4?d=identicon)[EvilFreelancer](/maintainers/EvilFreelancer)

---

Top Contributors

[![EvilFreelancer](https://avatars.githubusercontent.com/u/9089568?v=4)](https://github.com/EvilFreelancer "EvilFreelancer (2 commits)")

---

Tags

api-clientphp7pi-holepiholerest-api

### Embed Badge

![Health badge](/badges/evilfreelancer-pihole-api-php/health.svg)

```
[![Health](https://phpackages.com/badges/evilfreelancer-pihole-api-php/health.svg)](https://phpackages.com/packages/evilfreelancer-pihole-api-php)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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