Parameters for GAA Competition APIs

CONTENTS

countyBoardID

owner IDs

Fixtures and Results API Parameters

Competitions API Parameters

___________________________________________

countyBoard IDs

The countyBoards are ordered alphabetically with the corresponding parameter values running from 1 - 32. Please see the table below to find the countyBoardID and value for your given county:

County	Parameter Value	Parameter
Antrim	1	countyBoardID=1
Armagh	2	countyBoardID=2
Carlow	3	countyBoardID=3
Cavan	4	countyBoardID=4
Clare	5	countyBoardID=5
Cork	6	countyBoardID=6
Derry	7	countyBoardID=7
Donegal	8	countyBoardID=8
Down	9	countyBoardID=9
Dublin	10	countyBoardID=10
Fermanagh	11	countyBoardID=11
Galway	12	countyBoardID=12
Kerry	13	countyBoardID=13
Kildare	14	countyBoardID=14
Kilkenny	15	countyBoardID=15
Laois	16	countyBoardID=16
Leitrim	17	countyBoardID=17
Limerick	18	countyBoardID=18
Longford	19	countyBoardID=19
Louth	20	countyBoardID=20
Mayo	21	countyBoardID=21
Meath	22	countyBoardID=22
Monaghan	23	countyBoardID=23
Offaly	24	countyBoardID=24
Roscommon	25	countyBoardID=25
Sligo	26	countyBoardID=26
Tipperary	27	countyBoardID=27
Tyrone	28	countyBoardID=28
Waterford	29	countyBoardID=29
Westmeath	30	countyBoardID=30
Wexford	31	countyBoardID=31
Wicklow	32	countyBoardID=32

owner IDs

The owner parameter IDs are ordered alphabetically with the corresponding parameter values. Please see the table below to find the owner parameter and value for your given province or county:

Province / County	Parameter Value	Parameter
ULSTER	2139	owner=2139
Antrim	2175	owner=2175
Armagh	2174	owner=2174
Cavan	2172	owner=2172
Derry	2169	owner=2169
Donegal	2168	owner=2168
Down	2167	owner=2167
Fermanagh	2165	owner=2165
Monaghan	2153	owner=2153
Tyrone	2148	owner=2148
MUNSTER	2140	owner=2140
Clare	2171	owner=2171
Cork	2170	owner=2170
Kerry	2163	owner=2163
Limerick	2158	owner=2158
Tipperary	2149	owner=2149
Waterford	2147	owner=2147
LEINSTER	2141	owner=2141
Carlow	2173	owner=2173
Dublin	2166	owner=2166
Kildare	2162	owner=2162
Kilkenny	2161	owner=2161
Laois	2160	owner=2160
Longford	2157	owner=2157
Louth	2156	owner=2156
Meath	2154	owner=2154
Offaly	2152	owner=2152
Westmeath	2146	owner=2146
Wexford	2145	owner=2145
Wicklow	2144	owner=2144
CONNACHT	2142	owner=2142
Galway	2164	owner=2164
Leitrim	2159	owner=2159
Mayo	2155	owner=2155
Roscommon	2151	owner=2151
Sligo	2150	owner=2150

Fixtures and Results API Parameters

The request to the GAA fixtures and results API must contain one of the ‘Compulsory Parameters’ to return competition data. If the request does not contain at least one of these parameters you will receive an error message and no competition data will be returned.

To display the exact competition data you require, you can use the filtering parameters to narrow down the search to suit your club, county or province.

Compulsory Parameter IDs	Examples of Parameter Values
clubID	clubID=1234
owner	owner=1
countyBoardID	countyBoardID=12
provinceName	provinceName=Ulster
Filtering Parameter IDs	Examples of Parameter Values
dateFrom	dateFrom=20170829
daysPrevious	daysPrevious=7
daysAfter	daysAfter=7
leagueTable	leagueTable=Y/N **
leagueTableOnly	leagueTableOnly=Y/N
fixturesOnly	fixturesOnly=Y/N
resultsOnly	resultsOnly =Y/N
venueID	venueID=1234
compGroupID	compGroupID=1234
compID	compID=1234
includeCountyGames	includeCountyGames=Y/N
includeProvincialGames	includeProvincialGames=Y/N
reverseDateOrder	reverseDateOrder=Y/N
compLevel	compLevel=Senior/Junior/U21/Minor etc
compAgeLevel	compAgeLevel=Senior/U21/U12/U10/U8 etc
gender	gender=M/F
compStyle	compStyle=football/hurling
includeClubGames	includeClubGames=Y
noTBC	noTBC=Y/N
orderTBCLast	orderTBCLast=Y/N
orderByRank	orderByRank=Y/N
showArchive	showArchive=Y/N
season	season=2017
uniqueID	uniqueID=12345
includeSchoolGames	includeSchoolGames=Y/N
includeCollegeGames	includeCollegeGames=Y/N
next7Days	next7Days=Y/N
showByeGames	showByeGames=Y/N
format	format=league/knockout
language	language=irish/english
eventId	eventId

NOTE:

** If you wish to display the league table you must include the compID parameter within the call. For example:

https://people.gaa.ie/api/fixtures/xml?clubID=xxxx&compID=xxxxxx&leagueTable=Y

Competitions API Parameters

The request to the GAA competition API must contain one of the ‘Compulsory Parameters’ to return competition data. If the request does not contain at least one of these parameters you will receive an error message and no competition data will be returned.

To display the exact competition data you require, you can use the filtering parameters to narrow down the search to suit your club, county or province.

Compulsory Parameter IDs	Examples of Parameter Values
clubID	clubID=1234
owner	owner=1
countyBoardID	countyBoardID=12
provinceName	provinceName=Ulster
Filtering Parameter IDs	Examples of Parameter Values
childID	childID
parentID	parentID=1234
season	season=2017
grade	grade=senior/junior/u21
gender	gender=M/F
discipline	discipline=football/hurling
compAgeLevel	compAgeLevel=Senior/U18/
showArchive	showArchive=Y/N
includeCountyComps	includeCountyGames=Y/N
includeProvinceComps	includeProvinceComps=Y/N
includeClubComps	includeClubComps=Y/N
includeThirdLevelComps	includeThirdLevelComps=Y/N
includeSchoolComps	includeSchoolComps=Y/N
includeInterFirmComps	includeInterFirmComps=Y/N
code	code=FOOTBALL
level	level=JUNIOR
type	type=PROVINCE