holiday_event_api 1.0.1

The Official Holiday and Event API built for Dart and Flutter.

The Official Holiday and Event API for Dart and Flutter

Industry-leading Holiday and Event API for Dart and Flutter. Over 5,000 holidays and thousands of descriptions. Trusted by the World’s leading companies. Built by developers for developers since 2011.

Supported Dart and Flutter Versions

The latest version of the the Holiday and Event API is compatible with the latest version of Dart but should work with 2.15.0 and later.

Authentication

Access to the Holiday and Event API requires an API Key. You can get for one for FREE here, no credit card required! Note that free plans are limited. To access more data and have more requests, a paid plan is required.

Installation

The recommended way to install the Holiday and Event API is through Pub.

flutter pub add holiday_event_api

or

dart pub add holiday_event_api

Example

import 'package:holiday_event_api/holiday_event_api.dart';

void main() async {
  try {
    // Get a FREE API key from https://apilayer.com/marketplace/checkiday-api#pricing
    final client = HolidayEventApi('<your API key>');

    // Get Events for a given Date
    final events = await client.getEvents(
        // These parameters are the defaults but can be specified:
        // date: 'today',
        // timezone: 'America/Chicago',
        // adult: false,
        );

    final event = events.events[0];
    print("Today is ${event.name}! Find more information at: ${event.url}.");
    print(
        "Rate limit remaining: ${events.rateLimit.remainingMonth}/${events.rateLimit.limitMonth} (month).");

    // Get Event Information
    final eventInfo = await client.getEventInfo(
      id: event.id,
      // These parameters can be specified to calculate the range of eventInfo.event.occurrences
      // start: 2020,
      // end: 2030,
    );

    print("The Event's hashtags are ${eventInfo.event.hashtags}.");

    // Search for Events
    final query = 'zucchini';
    final search = await client.search(
      query: query,
      // These parameters are the defaults but can be specified:
      // adult: false,
    );

    print(
        "Found ${search.events.length} events, including '${search.events[0].name}', that match the query '$query'.");
  } catch (e) {
    print(e);
  }
}

License

The Holiday and Event API is made available under the MIT License (MIT). Please see the License File for more information.