PHPackages                             spikkl/spikkl-php-client - 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. spikkl/spikkl-php-client

ActiveLibrary[API Development](/categories/api)

spikkl/spikkl-php-client
========================

Spikkl API client library for PHP

v1.3(3y ago)020.0k↓10.7%[1 PRs](https://github.com/spikkl/spikkl-php-client/pulls)1BSD-2-ClausePHPPHP ^7.2 | ^8.0CI failing

Since Feb 16Pushed 3y ago1 watchersCompare

[ Source](https://github.com/spikkl/spikkl-php-client)[ Packagist](https://packagist.org/packages/spikkl/spikkl-php-client)[ Docs](https://www.spikkl.nl/documentation)[ RSS](/packages/spikkl-spikkl-php-client/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (6)Dependencies (2)Versions (11)Used By (1)

 [![](https://camo.githubusercontent.com/51e5f4368cf6e0360664f2ed87c480f9a7e6848d4567630cbf079a97413156df/68747470733a2f2f7370696b6b6c2e6e6c2f696d616765732f6875622f6769746875622f7068702e706e67)](https://camo.githubusercontent.com/51e5f4368cf6e0360664f2ed87c480f9a7e6848d4567630cbf079a97413156df/68747470733a2f2f7370696b6b6c2e6e6c2f696d616765732f6875622f6769746875622f7068702e706e67)

Spikkl API client for PHP
=========================

[](#spikkl-api-client-for-php)

[![Build Status](https://camo.githubusercontent.com/0b7399e7b37e1a3237de30a77a7d7a44f6c5384e478e45025e66a31fbff2d371/68747470733a2f2f7472617669732d63692e6f72672f7370696b6b6c2f7370696b6b6c2d7068702d636c69656e742e706e67)](https://travis-ci.org/spikkl/spikkl-php-client)

Requirements
------------

[](#requirements)

To use the Spikkl API client, the following things are required:

- Get yourself a free [Spikkl account](https://www.spikkl.nl/signup). No sign up costs.
- Follow [a few steps](https://www.spikkl.nl/account/billing) to enable a suitable subscription to talk to the API.
- A valid API key which can be generated from your [Spikkl dashboard](https://www.spikkl.nl/account/credentials).
- PHP >= 5.6.

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

[](#installation)

The easiest way to install the Spikkl API client is to require it with [Composer](https://getcomposer.org/doc/00-intro.md).

```
$ composer require spikkl/spikkl-php-client:^1.2
```

```
{
  "require": {
    "spikkl/spikkl-php-client": "^1.2"
  }
}
```

### Manual

[](#manual)

If you are not familiar with using composer, we have added a ZIP file to the release containing the API client and all the package normally installed by composer. Download `spikkl-php-client.zip` from the [release page](https://github.com/spikkl/spikkl-php-client/releases).

Include the `vendor/autoload.php` as shown in Initialize example.

Getting Started
---------------

[](#getting-started)

Initializing the Spikkl API Client, and setting up your API key.

```
$spikkl = new \Spikkl\Api\ApiClient();
$spikkl->setApiKey("API_KEY");
```

Perform a postal code lookup request.

```
$results = $spikkl->lookup("NLD", "2611HB", "175");
```

Perform a lookup by coordinate (longitude, latitude).

```
$results = $spikkl->reverse("NLD", 4.899431, 52.379189);
```

Note: longitude and latitude values will be rounded to 9 decimal places.

Exception handling
------------------

[](#exception-handling)

The Spikkl API uses conventional HTTP response codes to indicate or failure of an API request. Code in the `2xx` range indicate success and code in the `4xx` range indicate failure. The Spikkl API client uses specific exceptions for specific failure responses.

```
try {
    $results = $spikkl->lookup("NLD", "2611HB", "175");
} catch (\Spikkl\Api\Exceptions\AccessRestrictedException $exception) {
    // The API key is restricted for designated origins
} catch (\Spikkl\Api\Exceptions\InvalidApiKeyException $exception) {
    // The authentication with the Spikkl API failed
} catch (\Spikkl\Api\Exceptions\RevokedApiKeyException $exception) {
    // The provided API key is restricted.
} catch (\Spikkl\Api\Exceptions\ZeroResultsException $exception) {
    // The API call is successful but the API cannot find any results
} catch (\Spikkl\Api\Exceptions\QuotaReachedException $exception) {
    // The quota is reached for your current plan.
} catch (\Spikkl\Api\Exceptions\InvalidRequestException $exception) {
    // One of the query parameters (postal_code, street_number, or street_number_suffix)
    // might be invalid or missing
}
```

The reverse lookup request could throw additional exceptions.

```
try {
    $results = $spikkl->reverse("NLD", 4.899431, 52.379189);
} catch (\Spikkl\Api\Exceptions\OutOfRangeException $exception) {
    // The coordinates provided do not correspond with the country code
}
```

API documentation
-----------------

[](#api-documentation)

If you wish to learn more about our API, please visit the [Spikkl API Documentation](https://www.spikkl.nl/documentation).

License
-------

[](#license)

[BSD (Berkeley Software Distribution) License](https://opensource.org/licenses/bsd-license.php). Copyright (c) 2020, Spikkl

Support
-------

[](#support)

Contact: [www.spikkl.nl](https://www.spikkl.nl) —

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

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

Every ~106 days

Recently: every ~215 days

Total

10

Last Release

1369d ago

PHP version history (2 changes)v1.0.0PHP >=5.6

v1.3PHP ^7.2 | ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/7ab1598f72894d6866c0311f09cd74554e99053a3ddc9f4633779e1e6808eeb0?d=identicon)[hgwevandenberg](/maintainers/hgwevandenberg)

---

Top Contributors

[![hgwevandenberg](https://avatars.githubusercontent.com/u/8985147?v=4)](https://github.com/hgwevandenberg "hgwevandenberg (1 commits)")[![SjonHortensius](https://avatars.githubusercontent.com/u/1684987?v=4)](https://github.com/SjonHortensius "SjonHortensius (1 commits)")

---

Tags

apiclientvalidationservicepostcodepostal-codepostcode-apiaddress validationspikkl

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/spikkl-spikkl-php-client/health.svg)

```
[![Health](https://phpackages.com/badges/spikkl-spikkl-php-client/health.svg)](https://phpackages.com/packages/spikkl-spikkl-php-client)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k9.5M89](/packages/openai-php-laravel)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[resend/resend-php

Resend PHP library.

617.2M43](/packages/resend-resend-php)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

273.0k](/packages/eslazarev-wildberries-sdk)[files.com/files-php-sdk

Files.com PHP SDK

2481.1k](/packages/filescom-files-php-sdk)[mozex/anthropic-laravel

Laravel integration for the Anthropic API: facade, config publishing, install command, testing fakes, messages, streaming, tool use, thinking, and batches.

74331.3k1](/packages/mozex-anthropic-laravel)

PHPackages © 2026

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