Overview
Welcome to the Foireann Open Data API! This guide is designed to help you get started with our API, which provides access to comprehensive data on Competitions, Fixtures, and Results from Foireann. Our API conforms to the OpenAPI 3.0.1 specification, ensuring a standardised and user-friendly experience.
Table of Contents
Getting Started
- API Overview: The Foireann Open Data API allows for querying detailed information about GAA, LGFA & Camogie fixtures and competitions. It includes endpoints for fetching fixtures, results, and comprehensive competition data from 2013 onwards.
- Base URL: The API is accessible in the Production environment at the following base URL: https://api.foireann.ie/open-data/. This is the root URL to which you will append your endpoint paths.
- API Version: Currently, you are accessing version 1.0 of the API.
Endpoints Overview
The API consists of two main endpoints:
- Competitions: Fetch competitions, divisions, and league tables
- Enables searching and filtering of competitions and divisions
- Filtering by season, age levels, formats, activity types and more
- Fixtures: Fetch fixtures and results
- Allows searching and filtering of fixtures and results
- Filtering by competitions, divisions, teams, venues, results and more
A detailed description of the parameters for each endpoint is provided in the Specification section.
Authentication
To access the Foireann Open Data API, you will require an API key. API keys can be obtained by submitting a request to Foireann Support.
The request must:
- Be submitted via the Foireann Contact Form (Help Portal > Ways to Get In Touch > Write to Us)
- Be submitted by a Club Administrator of the unit requesting access.
- The Club Administrator must also be listed on the executive committee on Foireann.
- The request must include the following information:
- Name of Website Developer
- Email of Website Developer
- Club permission to Access their API
- Any Amalgamations the club is a part of.
- The Website URL
|
When requesting access to the Foireann Open Data API, if the request doesn't meet the criteria above, this will cause a delay in gaining access to the API Key. |
Please see below the full process to access the Foireann Open Data API:
- To initiate the process, please contact Foireann Support and submit a support request at Foireann Help you will need to provide specific details for verification and setup (as outlined above)
- Foireann support will review the request and complete a security check i.e. the request has come from a Club Administrator and the member is listed on the executive committee.
- Foireann support will provide the next steps to the requester which include the following:
- The developer of their website must create a Foireann account if they don't have one already.
- The developer will add a new unit called 'Foireann API Integration' to their profile.
- A Terms & Conditions document will be to the requester via the support ticket for both the Club and Developer to sign/date and send back to Foireann.
- Once Foireann support has received the signed Terms & Conditions, then an API Key will be assigned.
|
It is up to the Club and Developer to ensure that the Terms & Conditions of the Foireann Open Data API are adhered to. Foireann can withdraw access to the API at any stage if T&Cs are not met. |
5. Upon approval of your request, you will receive two API keys. You can use either API key, they’re both valid and both work in the same way. We have two API keys so that we can regenerate and replace one at a time (the one you’re not using) to allow you to periodically rotate API keys in your application without a gap in service.
Support and Feedback
If you have any questions or feedback, please contact Foireann Support and submit a support request via your Foireann account at Foireann Help.
Specification
The Foireann Open Data API conforms to the OpenAPI 3.0.1 specification. The specification is available here.
Comments
0 comments
Article is closed for comments.