PHPackages                             flo-180/oa-sdk-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. flo-180/oa-sdk-php

ActiveLibrary[API Development](/categories/api)

flo-180/oa-sdk-php
==================

PHP Wrapper for the OpenAgenda API

v1(2y ago)06MITPHPPHP ^7.1.10 || ^8.0

Since Jan 11Pushed 1y agoCompare

[ Source](https://github.com/Flo-180/oa-sdk-php)[ Packagist](https://packagist.org/packages/flo-180/oa-sdk-php)[ Docs](https://openagenda.com/)[ RSS](/packages/flo-180-oa-sdk-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (2)Used By (0)

OpenAgenda PHP SDK
==================

[](#openagenda-php-sdk)

[![Home Image](git-header.jpg)](git-header.jpg)

OpenAgendaSDK is a PHP wrapper for OpenAgenda API v2.

Prerequisites
-------------

[](#prerequisites)

Composer is required as well as a PHP 7.1 or higher version running on your web server. Composer installation instructions can be found at .

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

[](#installation)

Install OpenAgendaSdk as a dependency to your project:

```
composer require openagenda/sdk-php

```

Basic usage
-----------

[](#basic-usage)

### Creating an OpenAgendaSdk instance

[](#creating-an-openagendasdk-instance)

First create an OpenAgendaSdk instance using your OpenAgenda publicKey as parameter:

```
$public_key = 'mypublickey';
$oa = new \OpenAgendaSdk\OpenAgendaSdk($public_key);
```

Additionally, you can set some client options such as proxy settings:

```
$oa = new \OpenAgendaSdk\OpenAgendaSdk($public_key, [RequestOptions::PROXY => '127.0.0.1:8888']);
```

As OpenAgenda uses Guzzle Client, read its documention to learn more about request options:

### Requesting OpenAgenda data

[](#requesting-openagenda-data)

OpenAgendaSdk currently comes with 3 methods to get agenda configuration, agenda events or a single agenda event. These methods return OpenAgenda API data as JSON. Decoding json or deserializing object(s) is up to you.

#### Get an agenda configuration

[](#get-an-agenda-configuration)

```
$agendaUid = 123456;
$json = $oa->getAgenda($agendaUid);
```

#### Get the event list of an agenda

[](#get-the-event-list-of-an-agenda)

```
$agendaUid = 123456;
$json = $oa->getEvents($agendaUid);
```

You can add some parameters to your request such as filters, sort, search, pagination. Read OpenAgenda API documentation to get the full list of options:

```
$agendaUid = 123456;
$json = $oa->getEvents($agendaUid, ['search' => 'Concert']);
$newjson = $oa->getEvents($agendaUid, ['search' => 'Concert', 'sort' => 'timings.asc', 'feature' => 1]);
```

#### Get an agenda event

[](#get-an-agenda-event)

```
$agendaUid = 123456;
$eventUid = 654321;
$json = $oa->getEvent($agendaUid, $eventUid);
```

Tests
-----

[](#tests)

### Prerequisites

[](#prerequisites-1)

In order to run tests, you have to set OPENAGENDA\_SDK\_ENV value to 'test' in a PHP dotenv file (.env) or using command line. Methods depends on the framework you use.

PHP dotenv example:

```
OPENAGENDA_SDK_ENV='test'

```

Using command line:

```
export OPENAGENDA_SDK_ENV='test'

```

### Running tests

[](#running-tests)

OpenAgendaSdk tests are based on JSON mocks.

Run tests:

```
./vendor/bin/phpunit ./vendor/openagenda/sdk-php/tests

Testing /your-project-folder/vendor/openagenda/sdk-php/tests
......                                                              6 / 6 (100%)

Time: 00:00.026, Memory: 10.00 MB

OK (6 tests, 11 assertions)

```

Reset to 'default' env to get back real API data when tests are over.

OpenAgenda API documention
--------------------------

[](#openagenda-api-documention)

OpenAgenda API v2 documention is available here:

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance28

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

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

Unknown

Total

1

Last Release

850d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/df70bfd295b7843044d93762140094694f9960d465d76174520358b140b8886f?d=identicon)[Flo-180](/maintainers/Flo-180)

---

Top Contributors

[![Tony3585](https://avatars.githubusercontent.com/u/37616494?v=4)](https://github.com/Tony3585 "Tony3585 (9 commits)")[![hsorais](https://avatars.githubusercontent.com/u/93779261?v=4)](https://github.com/hsorais "hsorais (5 commits)")[![tchoucky61](https://avatars.githubusercontent.com/u/17143877?v=4)](https://github.com/tchoucky61 "tchoucky61 (3 commits)")[![vincedubroeucq](https://avatars.githubusercontent.com/u/31403596?v=4)](https://github.com/vincedubroeucq "vincedubroeucq (3 commits)")[![Flo-180](https://avatars.githubusercontent.com/u/2866294?v=4)](https://github.com/Flo-180 "Flo-180 (2 commits)")[![WengerK](https://avatars.githubusercontent.com/u/1841592?v=4)](https://github.com/WengerK "WengerK (2 commits)")

---

Tags

phpapisdkopenagenda

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/flo-180-oa-sdk-php/health.svg)

```
[![Health](https://phpackages.com/badges/flo-180-oa-sdk-php/health.svg)](https://phpackages.com/packages/flo-180-oa-sdk-php)
```

###  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.7k7.6M74](/packages/openai-php-laravel)[hubspot/api-client

Hubspot API client

23414.2M16](/packages/hubspot-api-client)[php-opencloud/openstack

PHP SDK for OpenStack APIs. Supports BlockStorage, Compute, Identity, Images, Networking and Metric Gnocchi

2292.2M24](/packages/php-opencloud-openstack)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[resend/resend-php

Resend PHP library.

564.7M21](/packages/resend-resend-php)[checkout/checkout-sdk-php

Checkout.com SDK for PHP

553.3M7](/packages/checkout-checkout-sdk-php)

PHPackages © 2026

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