AFL Sports Data API (v1.67.1)

Download OpenAPI specification:Download

URL: http://servicedesk.championdata.com/

Champion Data provided API for AFL metadata and metrics.

Leagues

Get a list of available Leagues

Authorizations:

oauth2bearerAuth

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get details for a given League

Authorizations:

oauth2bearerAuth

path Parameters

leagueId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 1

Unique identifier of a League (obtained from /leagues).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of available levels for a given League

Authorizations:

oauth2bearerAuth

path Parameters

leagueId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 1

Unique identifier of a League (obtained from /leagues).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get details for a level within a given league

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Matches

Get details about a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of persons relevant to a given match with details on each person.

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get details about the venue for a single match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of valid metrics and their metadata for a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

query Parameters

showAllMetrics

boolean

Default: false

Toggleable flag which will allows you to see all metrics within the platform or just metrics that are valid within your metric tier.

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of match transactions for the specified match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of possession chains for a given match with details on each chain

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Returns a MatchRotations object containing all Rotation transactions and current stint details for each Player.

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get match and period scores and results for a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of shots at goal for a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of inside 50 entries for a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get player leaders in a given match for selected metrics

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

query Parameters

period	Array of integers <int32> [ items <int32 > ] Example: period=1&period=2 List of integers identifying periods used to filter the metrics returned
topXPlayers	integer <int32> Example: topXPlayers=5 Integer specifying how many of the top-ranked players to return for each metric

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get player statistics for all players and all valid metrics in a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

query Parameters

period	Array of integers <int32> [ items <int32 > ] Example: period=1&period=2 List of integers identifying periods used to filter the metrics returned
zone	Array of strings Example: zone=F50&zone=MID List of string identifying zones used to filter the metrics returned. Supported values are D50, DM, MID, CB, AM and F50.
metric	Array of strings Example: metric=TACKLE&metric=KICK&metric=HANDBALL Array of specific metric codes to get returned. This will result in the endpoint only returning these specific metrics. Note this endpoint is case sensitive and only works with a metrics code
team	string Example: team=home Team to return stats for, 'away' or 'home', case sensitive
fromPeriodSeconds	integer <int32> Limits statistics to counting events that occurred on or after this number of seconds
toPeriodSeconds	integer <int32> Limits statistics to counting events that occurred on or before this number of seconds
lastXSeconds	integer <int32> Limits statistics to counting events that occurred in the last X number of seconds

Responses

Response samples

200
400
403
404
414

Content type

text/plain

No sample

Get players statistics based on the request payload passed through

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Request Body schema:
application/json

Array of objects or null (PostPlayerMetricRequest)

List of player metric requests to return stats for

Array

id	string or null Metric request ID to use for request identification (auto generated if not supplied)
metricCodes	Array of strings or null List of specific metric codes to get returned. This will result in the endpoint only returning these specific metrics. Note this endpoint is case sensitive and only works with a metrics code
team	string or null Team to return stats for, 'away' or 'home', case sensitive
periods	Array of integers or null <int32> List of integers identifying periods used to filter the metrics returned
zones	Array of strings or null List of string identifying zones used to filter the metrics returned. Supported values are D50, DM, MID, CB, AM and F50
lastXSeconds	integer or null <int32> Limits statistics to counting events that occurred in the last X number of seconds of the match
fromPeriodSeconds	integer or null <int32> Limits statistics to counting events that occurred on or after this number of seconds in the current period
toPeriodSeconds	integer or null <int32> Limits statistics to counting events that occurred on or before this number of seconds in the current period

Responses

Request samples

Payload

Content type

application/json

Example

Returns all kicks for all periods and zones that happened within a game. This is assuming the match did not go into overtime

{"playerMetricRequests": [{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["D50"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["D50"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["D50"
]
}
]
}

Response samples

200
400
403
404
413

Content type

text/plain

No sample

Get squad statistics for both squads and all valid metrics in a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

query Parameters

period	Array of integers <int32> [ items <int32 > ] Example: period=1&period=2 List of integers identifying periods used to filter the metrics returned
zone	Array of strings Example: zone=F50&zone=MID List of string identifying zones used to filter the metrics returned. Supported values are D50, DM, MID, CB, AM and F50.
context	string Example: context=For The context of the metrics returned. Supported values are For, Against, Diff, PhysicalDiff.
metric	Array of strings Example: metric=TACKLE&metric=KICK&metric=HANDBALL Array of specific metric codes to get returned. This will result in the endpoint only returning these specific metrics. Note this endpoint is case sensitive and only works with a metrics code
team	string Example: team=home Team to return stats for, 'away' or 'home', case sensitive
fromPeriodSeconds	integer <int32> Limits statistics to counting events that occurred on or after this number of seconds
toPeriodSeconds	integer <int32> Limits statistics to counting events that occurred on or before this number of seconds
lastXSeconds	integer <int32> Limits statistics to counting events that occurred in the last X number of seconds

Responses

Response samples

200
400
403
404
414

Content type

text/plain

No sample

Get squad statistics based on the request payload passed through

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Request Body schema:
application/json

Array of objects or null (PostSquadMetricRequest)

List of squad metric requests to return stats for

Array

id	string or null Metric request ID to use for request identification (auto generated if not supplied)
metricCodes	Array of strings or null List of specific metric codes to get returned. This will result in the endpoint only returning these specific metrics. Note this endpoint is case sensitive and only works with a metrics code
team	string or null Team to return stats for, 'away' or 'home', case sensitive
periods	Array of integers or null <int32> List of integers identifying periods used to filter the metrics returned
zones	Array of strings or null List of string identifying zones used to filter the metrics returned. Supported values are D50, DM, MID, CB, AM and F50
lastXSeconds	integer or null <int32> Limits statistics to counting events that occurred in the last X number of seconds of the match
fromPeriodSeconds	integer or null <int32> Limits statistics to counting events that occurred on or after this number of seconds in the current period
toPeriodSeconds	integer or null <int32> Limits statistics to counting events that occurred on or before this number of seconds in the current period
context	string or null The context of the metrics returned. Supported values are For, Against, Diff, PhysicalDiff

Responses

Request samples

Payload

Content type

application/json

Example

Returns all kicks for all periods and zones that happened within a game. This is assuming the match did not go into overtime

{"squadMetricRequests": [{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [1
],
"zones": ["D50"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [2
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [3
],
"zones": ["D50"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["F50"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["AM"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["MID"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["CB"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["DM"
]
},
{"metricCodes": ["KICK"
],
"periods": [4
],
"zones": ["D50"
]
}
]
}

Response samples

200
400
403
404
413

Content type

text/plain

No sample

Get a list of all transactions for stoppages in the match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Gets the statistics time coded to when they occurred in a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

query Parameters

metric required	Array of strings Example: metric=TACKLE&metric=KICK&metric=HANDBALL Array of specific metric codes to get returned.
period	Array of integers <int32> [ items <int32 > ] Example: period=1&period=2 List of integers identifying periods used to filter the metrics returned
zone	Array of strings Example: zone=F50&zone=MID List of string identifying zones used to filter the metrics returned. Supported values are D50, DM, MID, CB, AM and F50.
team	string Example: team=home Team to return stats for, 'away' or 'home', case sensitive
page	integer <int32> [ 0 .. 2147483647 ] Default: 1 Example: page=1 Page index of the results to return. Default value is the first page which is 1.
limit	integer <int32> [ 0 .. 2147483647 ] Default: 5000 Example: limit=5000 The number of transactions per page to return. The limit and default value is 5000 transactions per page.
orderBy	string Default: "asc" Example: orderBy=asc Order transactions by asc or desc based on transaction id. Default value is asc

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Gets a summary of ruck contest statistics for a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

query Parameters

stoppageType

Array of strings

Example: stoppageType=ballUp&stoppageType=throwIn

Combinations of stoppage types to filter the ruck contests on

Responses

Response samples

200
400
403
404
414

Content type

text/plain

No sample

Get a list of shots at goal for a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

query Parameters

personId	integer <int32>
type	string (SummaryType) Enum: "All" "GeneralPlay" "SetShot" Example: type=All The type of shots to include in the summary. Supported values are All, GeneralPlay, SetShot
includeAllShotSummaries	boolean Default: false If true, will include players with no shots or missing type of shot in the response

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of shots at goal for a given match

Authorizations:

oauth2bearerAuth

path Parameters

matchId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 127270401

Unique identifier of a match (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture).

query Parameters

team	string Example: team=home
type	string (SummaryType) Enum: "All" "GeneralPlay" "SetShot" Example: type=All The type of shots to include in the summary. Supported values are All, GeneralPlay, SetShot
includeAllShotSummaries	boolean Default: false If true, will include squads with no shots or missing type of shot in the response

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Metadata

Returns a list of possible Match Status

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of possible Match Types

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of possible chain start types

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of possible chain end types

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of possible chain turnover type

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of possible chain turnover states

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of possible chain turnover creation types

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of implemented metrics

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns a list of possible rotation types

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Returns possible types for shot details angle, distance, score and source

Authorizations:

oauth2bearerAuth

Responses

Response samples

200

Content type

text/plain

No sample

Provides a summary around each metric available within the platform

Authorizations:

oauth2bearerAuth

query Parameters

metric

Array of strings

Example: metric=TACKLE&metric=KICK&metric=HANDBALL

Array of specific metric codes to get returned from the glossary.

Responses

Response samples

200
404

Content type

text/plain

No sample

PositionTypes

Get a list of all available position types

Authorizations:

oauth2bearerAuth

Responses

Response samples

200
403
404

Content type

text/plain

No sample

Get details for a given position type

Authorizations:

oauth2bearerAuth

path Parameters

positionTypeId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 69

Unique identifier of a PositionType (obtained from /positiontypes).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get a list of positions for a position type

Authorizations:

oauth2bearerAuth

path Parameters

positionTypeId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 69

Unique identifier of a PersonRole (obtained from /positiontypes).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Get details for a given position

Authorizations:

oauth2bearerAuth

path Parameters

positionId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 4141

Unique identifier of a position (obtained from /positionTypes/{positionTypeId}/positions).

Responses

Response samples

200
400
403
404

Content type

text/plain

No sample

Seasons

Get a list of available seasons within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)

Responses

Response samples

200
400
403
404

Content type

application/json

{"id": 1,
"name": "Australian Football League",
"code": "AFL",
"gender": "1",
"seasons": [{"competitionCode": "AFL2019",
"competitionId": 2019010674,
"competitionName": "AFL Premiership Season 2019",
"competitionType": "Premiership",
"endDate": "2019-09-28",
"endYear": 2019,
"firstMatchStart": "2019-03-21T08:25:00.000Z",
"id": 2019,
"matches": {"complete": 161,
"incomplete": 1
},
"rounds": {"lastCompleted": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
},
"nextScheduled": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
}
},
"startDate": "2019-03-21",
"startYear": 2019
}
]
}

Get details about a specific season within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

Responses

Response samples

200
400
403
404

Content type

application/json

{"competitionCode": "AFL2019",
"competitionId": 2019010674,
"competitionName": "AFL Premiership Season 2019",
"competitionType": "Premiership",
"endDate": "2019-09-28",
"endYear": 2019,
"firstMatchStart": "2019-03-21T08:25:00.000Z",
"id": 2019,
"matches": {"complete": 161,
"incomplete": 1
},
"rounds": {"lastCompleted": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
},
"nextScheduled": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
}
},
"startDate": "2019-03-21",
"startYear": 2019,
"phases": [{"id": 11086,
"name": "Home & Away",
"code": "HA"
}
]
}

Get the fixture of matches for a season within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

query Parameters

squadId	integer <int32> Example: squadId=10 Unique identifier of a Squad (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/squads
roundNumber	integer <int32> Example: roundNumber=1 Unique identifier of a round (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/fixture

Responses

Response samples

200
400
403
404

Content type

application/json

{"competitionCode": "AFL2019",
"competitionId": 2019010674,
"competitionName": "AFL Premiership Season 2019",
"competitionType": "Premiership",
"endDate": "2019-09-28",
"endYear": 2019,
"firstMatchStart": "2019-03-21T08:25:00.000Z",
"phases": [{"id": 11086,
"name": "Home & Away",
"code": "HA",
"rounds": [{"code": "R01",
"id": 216238195,
"matches": [{"id": 21727,
"roundOrder": 21727,
"squads": {"away": {"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"score": {"goals": null,
"behinds": null,
"points": null
}
},
"home": {"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"score": {"goals": null,
"behinds": null,
"points": null
}
}
},
"date": {"startDate": "2020-03-28",
"startTime": "19:40:00",
"utcMatchStart": "2020-08-21T01:44:44.808Z"
},
"status": {"id": 8,
"name": "Scheduled",
"code": "2",
"typeId": 0,
"typeName": "Upcoming",
"period": 2,
"periodSecs": 765,
"periodDisplay": "Q2 12:45",
"remainingSecs": 234,
"remainingDisplay": "Q2 03:54",
"remainingTime": "03:54"
},
"type": {"id": 1,
"name": "Regular Season",
"code": "REG"
},
"venue": {"id": 190,
"code": "MRVL",
"name": "Marvel Stadium",
"timeZone": "Australia/Melbourne"
},
"winningSquadId": 0
}
],
"name": "Round 1",
"number": 1,
"phaseNumber": 1
}
]
}
],
"seasonId": 2019,
"startDate": "2019-03-21",
"startYear": 2019
}

Get the ladder for a season within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

query Parameters

conference

string

Conference code by which to filter the ladder.

Responses

Response samples

200
400
403
404

Content type

application/json

{"seasonId": 2019,
"phaseId": 11086,
"roundNumber": 18,
"squads": 18
}

Get the ladder after a specific round of a season within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).
roundNumber required	integer <int32> [ 0 .. 2147483647 ] Example: 1 The round number within the season. The response includes all games up to and including this round.

query Parameters

conference

string

Conference code by which to filter the ladder.

Responses

Response samples

200
400
403
404

Content type

application/json

{"seasonId": 2019,
"phaseId": 11086,
"roundNumber": 18,
"squads": 18
}

Get a list of competing squads in a season within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

Responses

Response samples

200
400
403
404

Content type

application/json

{"seasonId": 2020,
"squads": [{"code": "AFC",
"id": 10,
"name": "Adelaide Crows"
}
]
}

Get details about a single squad for a season within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).
squadId required	integer <int32> [ 0 .. 2147483647 ] Example: 10 Unique identifier of a Squad (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/squads

Responses

Response samples

200
400
403
404

Content type

application/json

{"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"homeState": {"id": 4,
"name": "South Australia",
"code": "SA"
},
"seasonId": 2020
}

Get a list of relevent persons for a single squad in a season within a given league and level

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a League (obtained from /leagues).
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level (obtained from /leagues/{leagueId}/levels)
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).
squadId required	integer <int32> [ 0 .. 2147483647 ] Example: 10 Unique identifier of a Squad (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/squads

Responses

Response samples

200
400
403
404

Content type

application/json

{"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"seasonId": 2020,
"players": [{"displayName": "T.Mitchell",
"fullname": "Tom Mitchell",
"personId": 291856,
"dateOfBirth": "1995-03-21",
"ageToday": 34.25,
"ageSeason": 34.15,
"ageYear": 34,
"height": 189,
"weight": 92,
"position": {"id": 16,
"code": "FP",
"name": "Forward Pocket",
"description": "Left Forward Pocket"
},
"firstname": "Tom",
"surname": "Mitchell",
"jumperNumber": 6,
"matches": {"season": 0
}
}
]
}

Get a list of Conferences for a given season

Authorizations:

oauth2bearerAuth

path Parameters

leagueId required	integer <int32> [ 0 .. 2147483647 ] Example: 3 Unique identifier of a League.
levelId required	integer <int32> [ 0 .. 2147483647 ] Example: 1 Unique identifier of a Level.
seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2020 Unique identifier of a Season.

query Parameters

conference

string

Example: conference=A

Filters the season conferences by Conference code

Responses

Response samples

200
400
403
404

Content type

application/json

{"seasonId": 2020,
"squads": [{"code": "AFC",
"id": 10,
"name": "Adelaide Crows"
}
]
}

Get a list of available seasons for the AFL Premiership

Authorizations:

oauth2bearerAuth

Responses

Response samples

200
403
404

Content type

application/json

{"id": 1,
"name": "Australian Football League",
"code": "AFL",
"gender": "1",
"seasons": [{"competitionCode": "AFL2019",
"competitionId": 2019010674,
"competitionName": "AFL Premiership Season 2019",
"competitionType": "Premiership",
"endDate": "2019-09-28",
"endYear": 2019,
"firstMatchStart": "2019-03-21T08:25:00.000Z",
"id": 2019,
"matches": {"complete": 161,
"incomplete": 1
},
"rounds": {"lastCompleted": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
},
"nextScheduled": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
}
},
"startDate": "2019-03-21",
"startYear": 2019
}
]
}

Get details about a specific season within the AFL Premiership

Authorizations:

oauth2bearerAuth

path Parameters

seasonId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 2021

Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

Responses

Response samples

200
400
403
404

Content type

application/json

{"competitionCode": "AFL2019",
"competitionId": 2019010674,
"competitionName": "AFL Premiership Season 2019",
"competitionType": "Premiership",
"endDate": "2019-09-28",
"endYear": 2019,
"firstMatchStart": "2019-03-21T08:25:00.000Z",
"id": 2019,
"matches": {"complete": 161,
"incomplete": 1
},
"rounds": {"lastCompleted": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
},
"nextScheduled": {"end": "2019-03-21T08:25:00.000Z",
"id": 21727,
"phaseId": 11086,
"number": 1,
"phaseNumber": 1,
"start": "2019-03-21T08:25:00.000Z"
}
},
"startDate": "2019-03-21",
"startYear": 2019,
"phases": [{"id": 11086,
"name": "Home & Away",
"code": "HA"
}
]
}

Get the fixture of matches for a season within the AFL Premiership

Authorizations:

oauth2bearerAuth

path Parameters

seasonId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 2021

Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

Responses

Response samples

200
400
403
404

Content type

application/json

{"competitionCode": "AFL2019",
"competitionId": 2019010674,
"competitionName": "AFL Premiership Season 2019",
"competitionType": "Premiership",
"endDate": "2019-09-28",
"endYear": 2019,
"firstMatchStart": "2019-03-21T08:25:00.000Z",
"phases": [{"id": 11086,
"name": "Home & Away",
"code": "HA",
"rounds": [{"code": "R01",
"id": 216238195,
"matches": [{"id": 21727,
"roundOrder": 21727,
"squads": {"away": {"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"score": {"goals": null,
"behinds": null,
"points": null
}
},
"home": {"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"score": {"goals": null,
"behinds": null,
"points": null
}
}
},
"date": {"startDate": "2020-03-28",
"startTime": "19:40:00",
"utcMatchStart": "2020-08-21T01:44:44.808Z"
},
"status": {"id": 8,
"name": "Scheduled",
"code": "2",
"typeId": 0,
"typeName": "Upcoming",
"period": 2,
"periodSecs": 765,
"periodDisplay": "Q2 12:45",
"remainingSecs": 234,
"remainingDisplay": "Q2 03:54",
"remainingTime": "03:54"
},
"type": {"id": 1,
"name": "Regular Season",
"code": "REG"
},
"venue": {"id": 190,
"code": "MRVL",
"name": "Marvel Stadium",
"timeZone": "Australia/Melbourne"
},
"winningSquadId": 0
}
],
"name": "Round 1",
"number": 1,
"phaseNumber": 1
}
]
}
],
"seasonId": 2019,
"startDate": "2019-03-21",
"startYear": 2019
}

Get the ladder for a season within the AFL Premiership

Authorizations:

oauth2bearerAuth

path Parameters

seasonId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 2021

Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

Responses

Response samples

200
400
403
404

Content type

application/json

{"seasonId": 2019,
"phaseId": 11086,
"roundNumber": 18,
"squads": 18
}

Get the ladder after a specific round of a season within the AFL Premiership

Authorizations:

oauth2bearerAuth

path Parameters

seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).
roundNumber required	integer <int32> [ 0 .. 2147483647 ] Example: 1 The round number within the season. The response includes all games up to and including this round.

Responses

Response samples

200
400
403
404

Content type

application/json

{"seasonId": 2019,
"phaseId": 11086,
"roundNumber": 18,
"squads": 18
}

Get a list of competing squads in a season within the AFL Premiership

Authorizations:

oauth2bearerAuth

path Parameters

seasonId

required

integer <int32> [ 0 .. 2147483647 ]

Example: 2021

Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).

Responses

Response samples

200
400
403
404

Content type

application/json

{"seasonId": 2020,
"squads": [{"code": "AFC",
"id": 10,
"name": "Adelaide Crows"
}
]
}

Get details about a single squad for a season within the AFL Premiership

Authorizations:

oauth2bearerAuth

path Parameters

seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).
squadId required	integer <int32> [ 0 .. 2147483647 ] Example: 10 Unique identifier of a Squad (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/squads

Responses

Response samples

200
400
403
404

Content type

application/json

{"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"homeState": {"id": 4,
"name": "South Australia",
"code": "SA"
},
"seasonId": 2020
}

Get a list of relevent persons for a single squad in a season within the AFL Premiership

Authorizations:

oauth2bearerAuth

path Parameters

seasonId required	integer <int32> [ 0 .. 2147483647 ] Example: 2021 Unique identifier of a Season (obtained from /leagues/{leagueId}/levels/{levelId}/seasons).
squadId required	integer <int32> [ 0 .. 2147483647 ] Example: 10 Unique identifier of a Squad (obtained from /leagues/{leagueId}/levels/{levelId}/seasons/{seasonId}/squads

Responses

Response samples

200
400
403
404

Content type

application/json

{"code": "AFC",
"id": 10,
"name": "Adelaide Crows",
"seasonId": 2020,
"players": [{"displayName": "T.Mitchell",
"fullname": "Tom Mitchell",
"personId": 291856,
"dateOfBirth": "1995-03-21",
"ageToday": 34.25,
"ageSeason": 34.15,
"ageYear": 34,
"height": 189,
"weight": 92,
"position": {"id": 16,
"code": "FP",
"name": "Forward Pocket",
"description": "Left Forward Pocket"
},
"firstname": "Tom",
"surname": "Mitchell",
"jumperNumber": 6,
"matches": {"season": 0
}
}
]
}

Usage

Usage_GetLatestUsage

Authorizations:

oauth2bearerAuth

Responses

Response samples

200
403
404
429

Content type

application/json

{"requestsRemaining": 0,
"quotaPeriod": {"value": "string"
},
"requestLimit": 0,
"burstLimit": 0,
"rateLimit": 0.1,
"planName": "string",
"items": [[0
]
],
"startDate": "string",
"endDate": "string"
}