Fixtures and Results Website Integrations

CONTENTS

What is the GAA Competitions API and how to gain access

Integrating the XML API

Integrating the JSON API

___________________________________________

What is the GAA Competitions API and how to gain access

Please navigate to the ‘Fixtures and Results API Request’ section before attempting to integrate the GAA competitions API into your club, county or provincial website. This section will provide you with information on what the GAA Competitions APIs are and how to gain access to display the competition data onto your club, county or provincial website.

Integrating the XML API

 

Overview

Following the completion of the F&R API request form via the GAA Management system, you can now integrate the competition data into your club, county or provincial website.

If you require the XML API, there are two main URLs used for the different APIs

API	XML
Fixtures and Results	/api/fixtures/xml
Competitions	/api/competitions/xml

Returning XML from the Server

Two API endpoints can be accessed from the GAA development server:

Fixtures and Results API:

https://people.gaa.ie/api/fixtures/xml

Competitions API:

https://people.gaa.ie/api/competitions/xml

To access the relevant competition data for your club, county or province, you must use the appropriate parameters to return the correct data.

Please see the examples below of typical requests sent to the different API’s.

Fixtures and Results API:

https://people.gaa.ie/api/fixtures/xml?compID=@@@@&leagueTable=Y&resultsOnly=Y

Competitions API:

https://people.gaa.ie/api/competitions/xml?countyBoardID=####&discipline=football

In response to the calls to the API you will get a XML document with the requested competition data. At this point the XML may be parsed with whatever tools are at the developer's disposal and displayed however is seen fit on the club, county or provincial website.

 

KEY

@@@@ - This denotes a competition ID, each competition will have a unique ID that will change every year. Please liaise with your county board or contact  GMS Support to obtain this id.

#### - This denotes an ID for a specific county board, each county will have a different ID.

NOTE: All XML codes must be prefixed with "http://people.gaa.ie/api/fixtures/xml?"

To see a full list of possible parameters please click the link below:

Parameters for GAA Competition APIs

Integrating the JSON API

 

Overview

Following the completion of the F&R API request form via the GAA management system, you can now integrate the competition data into your club, county or provincial website.

If you require the JSON API, there are two main URLs used for the different APIs

API	XML
Fixtures and Results	/api/fixtures/jsonp
Competitions	/api/competitions/jsonp

Returning JSON from the Server

Two API endpoints can be accessed from theGAA development server:

Fixtures and Results API:

https://people.gaa.ie/api/fixtures/jsonp

Competitions API:

https://people.gaa.ie/api/competitions/jsonp

To access the relevant competition data for your club, county or province, you must use the appropriate parameters to return the correct data.

Please see the examples below of typical requests sent to the different API’s.

Fixtures and Results API:

https://people.gaa.ie/api/fixtures/jsonp?compID=@@@@&leagueTable=Y&resultsOnly=Y

Competitions API:

https://people.gaa.ie/api/competitions/jsonp?countyBoardID=####&discipline=football

KEY

@@@@ - This denotes a competition ID, each competition will have a unique ID that will change every year. Please liaise with your county board or contact GMS Support directly to obtain this id.

#### - This denotes an ID for a specific county board, each county will have a different ID.

To see a full list of possible parameters please click the link below:

Parameters for GAA Competition APIs