PHPackages                             squigg/ideal-postcodes-laravel - 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. squigg/ideal-postcodes-laravel

ActiveLibrary[API Development](/categories/api)

squigg/ideal-postcodes-laravel
==============================

Laravel package for using the Ideal Postcodes API at https://ideal-postcodes.co.uk/

0268PHP

Since Jan 28Pushed 9y ago1 watchersCompare

[ Source](https://github.com/squigg/ideal-postcodes-laravel)[ Packagist](https://packagist.org/packages/squigg/ideal-postcodes-laravel)[ RSS](/packages/squigg-ideal-postcodes-laravel/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

ideal-postcodes-laravel
=======================

[](#ideal-postcodes-laravel)

[![Build Status](https://camo.githubusercontent.com/a91dee7973127f037ad1c1a3cc8e626aa97bcaae25be847c1efa1108e06cd5c7/68747470733a2f2f7472617669732d63692e6f72672f7371756967672f696465616c2d706f7374636f6465732d6c61726176656c2e706e673f6272616e63683d6d6173746572)](https://travis-ci.org/squigg/ideal-postcodes-laravel)[![Coverage Status](https://camo.githubusercontent.com/41a568cad3d57f41f4d32b7a6fb714a789897fb6f96377c4700ff486b6e9ea10/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f7371756967672f696465616c2d706f7374636f6465732d6c61726176656c2f62616467652e706e673f6272616e63683d6d6173746572)](https://coveralls.io/r/squigg/ideal-postcodes-laravel)[![Dependency Status](https://camo.githubusercontent.com/93566b6cf2d611538513e6eb7d77e59c68c84eb914c0016c10d6365ab6177cfd/68747470733a2f2f7777772e76657273696f6e6579652e636f6d2f7061636b6167652f7068702d2d7371756967672d2d696465616c2d706f7374636f6465732d6c61726176656c2f62616467652e706e67)](https://www.versioneye.com/package/php--squigg--ideal-postcodes-laravel)

[![Latest Stable Version](https://camo.githubusercontent.com/e8df8c59cd73bb2b5e730f413972bbf31321925354e933a4e06799adbb321e35/68747470733a2f2f706f7365722e707567782e6f72672f7371756967672f696465616c2d706f7374636f6465732d6c61726176656c2f762f737461626c652e706e67)](https://packagist.org/packages/squigg/ideal-postcodes-laravel)[![Total Downloads](https://camo.githubusercontent.com/cd46f316f489316120c6577eca3e14141a9d3371680678052d31f570f7f39149/68747470733a2f2f706f7365722e707567782e6f72672f7371756967672f696465616c2d706f7374636f6465732d6c61726176656c2f646f776e6c6f6164732e706e67)](https://packagist.org/packages/squigg/ideal-postcodes-laravel)

PHP Laravel 5 package for the [Ideal Postcodes API](https://ideal-postcodes.co.uk).

Prerequisites
=============

[](#prerequisites)

- PHP 5.5+
- Laravel 5.x
- Ideal Postcodes Account and API Key

Installation
============

[](#installation)

Install by composer
-------------------

[](#install-by-composer)

You can find this library on [Packagist](https://packagist.org/packages/squigg/ideal-postcodes-laravel).

To install ideal-postcodes-laravel with Composer, run the following command:

```
$ composer require squigg/ideal-postcodes-laravel
```

Configuration
=============

[](#configuration)

The package publishes a configuration file to your config directory where you can update the configuration for your app.

```
$ php artisan vendor:publish --tag=config
```

Add the IdealPostcodesServiceProvider and (if desired) the Facade alias to your `app.php`:

```
'providers' => [

    ...

    'Squigg\IdealPostcodes\IdealPostcodesServiceProvider',

],

'aliases' => [

    ...

    'IdealPostcodes' => 'Squigg\IdealPostcodes\Facades\IdealPostcodesFacade',

],
```

Add an `IDEALPOSTCODES_API_KEY` to your `.env` file with your Ideal Postcodes API key

```
IDEALPOSTCODES_API_KEY=ak_abcdefghijklmnopqrstuvwxyz

```

Configuration File Settings
---------------------------

[](#configuration-file-settings)

All available settings are documented within the config/ideal-postcodes.php configuration file.

Usage
=====

[](#usage)

Simply call the `\IdealPostcodes` Facade, or add a dependency in any constructor to IdealPostcodes

Change log
==========

[](#change-log)

[See changelog](CHANGELOG.md)

Copyright © 2016 Steve Strugnell. Released under the `MIT License `\_.

###  Health Score

22

—

LowBetter than 21% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity41

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.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/4279310?v=4)[Squigg](/maintainers/squigg)[@squigg](https://github.com/squigg)

---

Top Contributors

[![squigg](https://avatars.githubusercontent.com/u/4279310?v=4)](https://github.com/squigg "squigg (9 commits)")

### Embed Badge

![Health badge](/badges/squigg-ideal-postcodes-laravel/health.svg)

```
[![Health](https://phpackages.com/badges/squigg-ideal-postcodes-laravel/health.svg)](https://phpackages.com/packages/squigg-ideal-postcodes-laravel)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35816.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

94452.6k6](/packages/botman-driver-telegram)

PHPackages © 2026

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