Skip to main content
API docs by Redocly

AFL Sports Data API (v1.48.0)

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

Content type
[
  • {
    }
]

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

Content type
{
  • "id": 1,
  • "name": "Australian Football League",
  • "code": "AFL",
  • "gender": "1"
}

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

Content type
{
  • "league": {
    },
  • "levels": [
    ]
}

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

Content type
{
  • "id": 1,
  • "name": "Seniors",
  • "code": "SEN",
  • "league": {
    },
  • "currentSeason": {
    }
}

Matches

Get details about a given match

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "id": 216085122,
  • "name": "St Kilda v Hawthorn",
  • "code": "STK v HAW",
  • "phaseId": 11086,
  • "seasonId": 2020,
  • "competitionId": 2020011086,
  • "competitionName": "AFL Premiership Season 2020",
  • "roundNumber": 16,
  • "phaseName": "AFL 2020 Home and Away",
  • "phaseRoundNumber": 16,
  • "result": "St Kilda by 14 points.",
  • "resultCode": "STK by 14pts",
  • "winningSquadId": 130,
  • "attendance": 2740,
  • "leagueId": 1,
  • "levelId": 1,
  • "type": {
    },
  • "date": {
    },
  • "time": {
    },
  • "venue": {
    },
  • "status": {
    },
  • "coinToss": {
    },
  • "home": {
    },
  • "away": {
    },
  • "periods": [
    ],
  • "lastModified": {
    }
}

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: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 21727,
  • "squads": {
    },
  • "officials": [
    ]
}

Get details about the venue for a single match

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "code": "MS",
  • "dimensions": {
    },
  • "id": 190,
  • "location": {
    },
  • "matchId": 21727,
  • "name": "Marvel Stadium"
}

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

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Content type
{
  • "matchId": 21727,
  • "metrics": [
    ]
}

Get a list of match transactions for the specified match

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 21727,
  • "transactions": [
    ]
}

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: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 216467491,
  • "chains": [
    ]
}

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: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 216467491,
  • "home": {
    },
  • "away": {
    },
  • "rotations": [
    ]
}

Get match and period scores and results for a given match

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "away": {
    },
  • "home": {
    },
  • "matchId": 216085122,
  • "result": "St Kilda by 14 points.",
  • "resultCode": "STK by 14pts",
  • "winningSquadId": 130
}

Get a list of shots at goal for a given match

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 216467491,
  • "shots": [
    ]
}

Get a list of inside 50 entries for a given match

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 0,
  • "entries": [
    ]
}

Get player leaders in a given match for selected metrics

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 21727,
  • "statistics": [
    ]
}

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: 216085122

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>
Example: fromPeriodSeconds=200

Limits statistics to counting events that occurred on or after this number of seconds

toPeriodSeconds
integer <int32>
Example: toPeriodSeconds=400

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

Content type
{
  • "matchId": 21727,
  • "squads": [
    ]
}

Get players statistics based on the request payload passed through

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122
Request Body schema:
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

Content type
Example
{
  • "playerMetricRequests": [
    ]
}

Response samples

Content type
{
  • "playerStatistics": [
    ],
  • "playerMetricRequests": [
    ]
}

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: 216085122

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>
Example: fromPeriodSeconds=200

Limits statistics to counting events that occurred on or after this number of seconds

toPeriodSeconds
integer <int32>
Example: toPeriodSeconds=400

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

Content type
{
  • "matchId": 21727,
  • "squads": [
    ]
}

Get squad statistics based on the request payload passed through

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122
Request Body schema:
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

Content type
Example
{
  • "squadMetricRequests": [
    ]
}

Response samples

Content type
{
  • "squadStatistics": [
    ],
  • "squadMetricRequests": [
    ]
}

Get a list of all transactions for stoppages in the match

Authorizations:
oauth2bearerAuth
path Parameters
matchId
required
integer <int32> [ 0 .. 2147483647 ]
Example: 216085122

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

Responses

Response samples

Content type
{
  • "matchId": 21727,
  • "stoppages": [
    ]
}

Metadata

Returns a list of possible Match Status

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • {
    }
]

Returns a list of possible Match Types

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • {
    }
]

Returns a list of possible chain start types

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • {
    }
]

Returns a list of possible chain end types

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • {
    }
]

Returns a list of possible chain turnover type

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • "string"
]

Returns a list of possible chain turnover states

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • "string"
]

Returns a list of possible chain turnover creation types

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • "string"
]

Returns a list of implemented metrics

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • "string"
]

Returns a list of possible rotation types

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • {
    }
]

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

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
{
  • "property1": [
    ],
  • "property2": [
    ]
}

PositionTypes

Get a list of all available position types

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
[
  • {
    }
]

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

Content type
{
  • "code": "SEL",
  • "description": "Selected Position",
  • "id": 69,
  • "name": "Selected Position",
  • "role": {
    }
}

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

Content type
[
  • {
    }
]

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

Content type
{
  • "code": "BP",
  • "description": "Left Back Pocket",
  • "id": 4141,
  • "name": "Back Pocket"
}

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

Content type
application/json
{
  • "id": 1,
  • "name": "Australian Football League",
  • "code": "AFL",
  • "gender": "1",
  • "seasons": [
    ]
}

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

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": {
    },
  • "rounds": {
    },
  • "startDate": "2019-03-21",
  • "startYear": 2019,
  • "phases": [
    ]
}

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

Responses

Response samples

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": [
    ],
  • "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

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

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

Content type
application/json
{
  • "seasonId": 2020,
  • "squads": [
    ]
}

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

Content type
application/json
{
  • "code": "AFC",
  • "id": 10,
  • "name": "Adelaide Crows",
  • "homeState": {
    },
  • "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

Content type
application/json
{
  • "code": "AFC",
  • "id": 10,
  • "name": "Adelaide Crows",
  • "seasonId": 2020,
  • "players": [
    ]
}

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

Content type
application/json
{
  • "seasonId": 2020,
  • "squads": [
    ]
}

Get a list of available seasons for the AFL Premiership

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Australian Football League",
  • "code": "AFL",
  • "gender": "1",
  • "seasons": [
    ]
}

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

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": {
    },
  • "rounds": {
    },
  • "startDate": "2019-03-21",
  • "startYear": 2019,
  • "phases": [
    ]
}

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

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": [
    ],
  • "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

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

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

Content type
application/json
{
  • "seasonId": 2020,
  • "squads": [
    ]
}

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

Content type
application/json
{
  • "code": "AFC",
  • "id": 10,
  • "name": "Adelaide Crows",
  • "homeState": {
    },
  • "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

Content type
application/json
{
  • "code": "AFC",
  • "id": 10,
  • "name": "Adelaide Crows",
  • "seasonId": 2020,
  • "players": [
    ]
}

Usage

Usage_GetLatestUsage

Authorizations:
oauth2bearerAuth

Responses

Response samples

Content type
application/json
{
  • "requestsRemaining": 0,
  • "quotaPeriod": {
    },
  • "requestLimit": 0,
  • "burstLimit": 0,
  • "rateLimit": 0.1,
  • "planName": "string",
  • "items": [
    ],
  • "startDate": "string",
  • "endDate": "string"
}