PHPackages                             szymondukla/holiday-api-wrapper - 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. szymondukla/holiday-api-wrapper

Abandoned → [festivo-io/festivo-php](/?search=festivo-io%2Ffestivo-php)ArchivedLibrary[API Development](/categories/api)

szymondukla/holiday-api-wrapper
===============================

Holiday API is the only service offering it's powerful data completely free of charge.

1.2.0(5y ago)23292MITPHPPHP ^7.0

Since Dec 6Pushed 5y ago3 watchersCompare

[ Source](https://github.com/SzymonDukla/Festivo-PHP-Wrapper)[ Packagist](https://packagist.org/packages/szymondukla/holiday-api-wrapper)[ RSS](/packages/szymondukla-holiday-api-wrapper/feed)WikiDiscussions master Synced today

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

Festivo Holiday API PHP Wrapper
===============================

[](#festivo-holiday-api-php-wrapper)

API Version: 1.1

Documentation

#### Table of contents

[](#table-of-contents)

- [Obtaining an API Key](#api-key)
- [Supported countries](#countries)
- [Endpoints](#endpoints)
- [Parameters](#parameters)
- [Installation Instructions](#installation-instructions)
- [File Tree](#file-tree)
- [Opening an Issue](#opening-an-issue)

### API Key

[](#api-key)

As of 27th of May 2019 we require all users to sign up and generate their API key. We offer a spectrum of different subscription plans, including our *Developer* plan. Please check [your account](https://app.getfestivo.com) for more information.

### Countries

[](#countries)

Full list of countries is available at [getfestivo.com](https://getfestivo.com).

### Endpoints

[](#endpoints)

Currently, only two endpoints are supported:

- `/v2/holidays` - access holiday data

### Parameters

[](#parameters)

You can filter returned holidays by date and upcoming or past events:

NameExampleMandatoryDescriptionapi\_keyaf543g6454hh567h565665hgf456yesA key available on your Dashboard page once you sing up and sign into your account. Don't have an account yet? [Get started FOR FREE!](https://www.nationsonline.org/oneworld/country_code_list.htm)countryPLyes[ISO 3166-1 alpha-2](https://www.nationsonline.org/oneworld/country_code_list.htm) formatyear2018yes[ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (CCYY)month4 or 04no1 or 2 digit month (1-12)day7 or 07no1 or 2 digit day (1-31 depending on the month)previousfalsenoboolean; returns the previous holidays based on the date (works with all parameters listed before)upcomingtruenoboolean; returns the previous holidays based on the date (works with all parameters listed before *except* previous)prettytruenoboolean; prettifies returned JSON for a better human reading performancepublictruenoboolean; returns only official, public holidays (Premium and Enterprise plan only)*Full list of parameters is available in our [Documentation](https://getfestivo.com/documentation#filters)*

### Installation Instructions

[](#installation-instructions)

1. Download and install package from Composer via `composer require szymondukla/holiday-api-wrapper:"^1.2"`. You can also download an archive and setup it manually using `composer install` command.
2. Include main class into your project and add required `use` declaration, i.e.

```