PHPackages                             euro-ix/ixf-client-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. euro-ix/ixf-client-php

ActiveLibrary[API Development](/categories/api)

euro-ix/ixf-client-php
======================

PHP client for RESTful access to the IX-F database

16.1k1PHP

Since May 14Pushed 12y ago6 watchersCompare

[ Source](https://github.com/euro-ix/ixf-client-php)[ Packagist](https://packagist.org/packages/euro-ix/ixf-client-php)[ RSS](/packages/euro-ix-ixf-client-php/feed)WikiDiscussions master Synced 6d ago

READMEChangelogDependenciesVersions (1)Used By (0)

IXF Database - PHP Client
=========================

[](#ixf-database---php-client)

PHP RESTful interface for the IXF database,

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

[](#installation)

This library is best used with Composer. Just add the following to your `composer.json`:

```
"require": {
    "euro-ix/ixf-client-php": "dev-master"
}
```

If you are not using composer, see the [demo file](https://github.com/euro-ix/ixf-client-php/blob/master/demo/demo.php)for an example list of includes.

Usage
-----

[](#usage)

First, prime the API with the endpoint (official end point to be provided when live) and your credentials:

```
IXF\IXF::setApiBase( 'https://www.example.com/api' );
IXF\IXF::setApiUser( 'guest' );
IXF\IXF::setApiPass( 'guest' );
```

You can get an array of all IXPs and print their name, short name and latitude / longitude, as follows:

```
$ixps = IXF\ApiResource::all( 'IXP' );

foreach( $ixps as $o )
    echo $o->full_name . '[' . $o->short_name . '] => ' . $o->lat . ', ' . $o->lon . "\n";
```

You can use skip and limit options as follows:

```
$ixps = IXF\ApiResource::all( 'IXP', [ 'skip' => 10, 'limit' => 5 ] );
```

The default ordering is by ID.

You can fetch a specific IXP by id and edit it as follows:

```
$ixp = IXF\ApiResource::retrieve( 'IXP', $id );
$ixp->short_name = 'NEW_SHORTNAME';
$ixp->save();
```

You can also delete that IXP via:

```
$ixp->delete();
```

Finally, create an IXP via:

```
$newObjId = IXF\ApiResource::create( 'IXP',
    [
        "full_name" => "Test IXP",
        "short_name" => "TIXP"
    ]
);

$newIXP = IXF\ApiResource::retrieve( 'IXP', $newObjId );
```

Complete documentation can be found in the [wiki](https://github.com/euro-ix/ixf-client-php/wiki).

Documentation and Tests
-----------------------

[](#documentation-and-tests)

See the [tests/](https://github.com/euro-ix/ixf-client-php/blob/master/tests)for sample test suites which will show how the code works.

We'll link API documentation when it's uploaded.

Source / Origin Story
---------------------

[](#source--origin-story)

Written by [Barry O'Donovan](https://github.com/barryo) of [INEX](https://www.inex.ie/) during the May 2014 euro-ix hackaton in Sheffield, UK.

Issues and pull requests are welcomed.

[Stripe](https://stripe.com/) created a beautiful [API](https://stripe.com/docs/api/php)for their payment gateway. They open sourced the PHP library under the MIT license. This library is based on that.

*(a few hours later)* Hmmmm... beautiful API interface, horrendously coded API library. It was a mistake to use it but that's a bed I've made for myself now. I've stripped 70% of the cruft and it's slightly more palatable.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community10

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/804649?v=4)[Barry O'Donovan](/maintainers/barryo)[@barryo](https://github.com/barryo)

---

Top Contributors

[![barryo](https://avatars.githubusercontent.com/u/804649?v=4)](https://github.com/barryo "barryo (21 commits)")

### Embed Badge

![Health badge](/badges/euro-ix-ixf-client-php/health.svg)

```
[![Health](https://phpackages.com/badges/euro-ix-ixf-client-php/health.svg)](https://phpackages.com/packages/euro-ix-ixf-client-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)