PHPackages                             icuk/broadband-availability-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. [Utility & Helpers](/categories/utility)
4. /
5. icuk/broadband-availability-php

ActiveLibrary[Utility & Helpers](/categories/utility)

icuk/broadband-availability-php
===============================

Integrate the ICUK broadband availability checker into your PHP application

v1.3(2mo ago)5131MITPHPPHP ^7.4 || ^8.0CI passing

Since Jan 5Pushed 2mo ago3 watchersCompare

[ Source](https://github.com/ICUK-Net/icuk-broadband-checker-php)[ Packagist](https://packagist.org/packages/icuk/broadband-availability-php)[ RSS](/packages/icuk-broadband-availability-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (3)Versions (8)Used By (0)

ICUK Broadband Availability Checker
===================================

[](#icuk-broadband-availability-checker)

[![Latest Build](https://github.com/ICUK-Net/icuk-broadband-checker-php/actions/workflows/php.yml/badge.svg)](https://github.com/ICUK-Net/icuk-broadband-checker-php/actions/workflows/php.yml)

Integrate the ICUK broadband availability checker into your PHP application

Installation
------------

[](#installation)

The PECL [mbstring](http://php.net/mbstring), zip and ext-curl extensions are required

Download and extract the latest release

Windows

```
curl -o icuk-broadband-checker.tar.gz https://github.com/ICUK-Net/icuk-broadband-checker-php/releases/latest/download/icuk-broadband-checker.tar.gz
tar -xvf icuk-broadband-checker.tar.gz
```

Linux

```
wget https://github.com/ICUK-Net/icuk-broadband-checker-php/releases/latest/download/icuk-broadband-checker.tar.gz
tar -xvf icuk-broadband-checker.tar.gz
```

That is is all that is needed to install the availability checker, if this fails then try installing from source below At this point you should read the usage section which will show you how to configure the library

Installation with Composer
--------------------------

[](#installation-with-composer)

Download composer.phar (if not already installed)

```
wget https://getcomposer.org/download/latest-stable/composer.phar
```

Create a composer.json file with this data (if you already have a composer.json file add the data from the require)

```
{
    "name": "root/html",
    "type": "project",
    "minimum-stability": "dev",
    "require": {
        "icukcomputingservices/broadband-availability-php": "dev-master"
    }
}
```

Install with all dependencies

```
php composer.phar install
```

Usage
-----

[](#usage)

### api.php

[](#apiphp)

This file will allow the user to make requests to the broadband availability api. You should in this format but substitute the credentials with your own and you can and should use your own method of authentication beforehand to prevent unauthorised access to the endpoint.

```