Cup Bracket
This endpoint allows you to retrieve the cup knock outs.
You can use id
from the seasons
or leagues
endpoint to get the wanted cup knock out tree.
Fields in rounds:
Field | Explanation |
---|---|
order | The order of the round |
description | The description of the round |
blocks | The blocks of the round |
finished | If the match is finished |
order | The order of the block |
home_team_score | The score of the home team |
away_team_score | The score of the away team |
has_next_round_link | If the match has next round |
match_in_progress | If the match is in play |
series_start_date_timestamp | The start date of the match |
automatic_progression | If the match has automatic progression |
participants | The participants of the block (match) |
team_id | The id of the team |
winner | If the team is winner of the block |
order | The order of the participants |
Multi-language: This feature allows the user to manually change the language of the API response by adding value to the
lang
attribute. Example:lang=en
.
Pagination: The endpoint uses an offset and limit system. Specify the offset and limit parameters to fetch the desired range of results. The maximum and default number of results per request is 50.
Update Period: The endpoint is updated after every finished match.
Recommended Calls: Limit calls to 1 per finished match.
Use Cases
Get cup knock out based on the idhttps://aussie-rules.sportdevs.com/cup-bracket?id=eq.{id}
Get cups based on the season_idhttps://aussie-rules.sportdevs.com/cup-bracket?season_id=eq.{season_id}
Get cups based on the league_idhttps://aussie-rules.sportdevs.com/cup-bracket?league_id=eq.{league_id}
Query Parameters
- id integer
Default value:
eq.20833
The id of the cup bracket
- season_id integer
Default value:
eq.13360
The id of the season
- league_id integer
Default value:
eq.3506
The id of the league
- offset string
Default value:
0
Limiting and Pagination
- limit string
Default value:
50
Limiting and Pagination
- lang string
Default value:
en
Multi-language
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema array
- id integer
The id of the cup bracket
Note: This is a Primary Key.
- name text
The name of the cup bracket
- current_round integer
The last or the current round in the cup bracket
- type integer
The type of the cup bracket
- season_id integer
The id of the season
Note: This is a Foreign Key to
seasons.id
. - season_name text
The name of the season
- league_id integer
The id of the league
Note: This is a Foreign Key to
leagues.id
. - league_name text
The name of the league
- league_hash_image character varying
Possible values:
<= 64 characters
The name image of the league
- rounds jsonb
The rounds of the cup bracket
[
{
"id": 20833,
"name": "AFL 2022, Final Round",
"current_round": 3,
"type": 1,
"season_id": 13360,
"season_name": "AFL 2022",
"league_id": 3506,
"league_name": "AFL",
"league_hash_image": "719f6d97918185e32a06e2edcda10c4d2f1e39442a5763540155f543bc794a03",
"rounds": [
{
"type": 201,
"order": 1,
"blocks": [
{
"order": 5,
"matches": [
770
],
"finished": true,
"participants": [
{
"order": 1,
"winner": false,
"team_id": 50654,
"team_name": "Melbourne Demons",
"team_hash_image": "4fd986e06131075b601d2b0aa3af649a4fad3c7b74b65c01ff943b38721bb251"
},
{
"order": 2,
"winner": true,
"team_id": 50638,
"team_name": "Sydney Swans",
"team_hash_image": "c0363fe3f998c8ab8b59c60251fc924ae83360f702cc44a31b46cf77816100de"
}
],
"away_team_score": "91",
"home_team_score": "69",
"automatic_progression": false
},
{
"order": 2,
"matches": [
774
],
"finished": true,
"participants": [
{
"order": 1,
"winner": true,
"team_id": 50636,
"team_name": "Brisbane Lions",
"team_hash_image": "306509e2855d7418cac42157dec6d5d4a88e803995f1d2197845044de93c749b"
},
{
"order": 2,
"winner": false,
"team_id": 50641,
"team_name": "Richmond Tigers",
"team_hash_image": "e500d9528e1cbfe929d862444f18202c7bf530c1c6fb7fc029fd10492e4286f6"
}
],
"away_team_score": "104",
"home_team_score": "106",
"automatic_progression": false
},
{
"order": 3,
"matches": [
765
],
"finished": true,
"participants": [
{
"order": 1,
"winner": true,
"team_id": 50652,
"team_name": "Fremantle Dockers",
"team_hash_image": "a50f813edbf71a0df910aabbf81ccb012b9a52ca6ec17cd696d40921e337c0ea"
},
{
"order": 2,
"winner": false,
"team_id": 50666,
"team_name": "Western Bulldogs",
"team_hash_image": "841fcbaa23306bd72d1953a1968653af2feba484d49bb7b58c0a38dc8c8bffab"
}
],
"away_team_score": "60",
"home_team_score": "73",
"automatic_progression": false
},
{
"order": 6,
"matches": [
760
],
"finished": true,
"participants": [
{
"order": 1,
"winner": true,
"team_id": 50632,
"team_name": "Geelong Cats",
"team_hash_image": "c59ea05d78ed9c8b2b4335ae26d352d6f22be7ebf62ebfeff3792807c0fae636"
},
{
"order": 2,
"winner": false,
"team_id": 2225,
"team_name": "Collingwood Magpies",
"team_hash_image": "e1ca0a2c202717781b0bdd84654e00c8e05fc5a9ddebc92148eb895baa7770d9"
}
],
"away_team_score": "72",
"home_team_score": "78",
"automatic_progression": false
},
{
"order": 1,
"participants": [
{
"order": 1,
"winner": false,
"team_id": 50654,
"team_name": "Melbourne Demons",
"team_hash_image": "4fd986e06131075b601d2b0aa3af649a4fad3c7b74b65c01ff943b38721bb251"
}
],
"automatic_progression": false
},
{
"order": 4,
"participants": [
{
"order": 1,
"winner": false,
"team_id": 2225,
"team_name": "Collingwood Magpies",
"team_hash_image": "e1ca0a2c202717781b0bdd84654e00c8e05fc5a9ddebc92148eb895baa7770d9"
}
],
"automatic_progression": false
}
],
"description": "Qualification round 1"
},
{
"type": 2,
"order": 2,
"blocks": [
{
"order": 3,
"matches": [
754
],
"finished": true,
"participants": [
{
"order": 1,
"winner": false,
"team_id": 50654,
"team_name": "Melbourne Demons",
"team_hash_image": "4fd986e06131075b601d2b0aa3af649a4fad3c7b74b65c01ff943b38721bb251"
},
{
"order": 2,
"winner": true,
"team_id": 50636,
"team_name": "Brisbane Lions",
"team_hash_image": "306509e2855d7418cac42157dec6d5d4a88e803995f1d2197845044de93c749b"
}
],
"away_team_score": "92",
"home_team_score": "79",
"has_next_round_link": true,
"automatic_progression": false
},
{
"order": 1,
"matches": [
747
],
"finished": true,
"participants": [
{
"order": 1,
"winner": true,
"team_id": 2225,
"team_name": "Collingwood Magpies",
"team_hash_image": "e1ca0a2c202717781b0bdd84654e00c8e05fc5a9ddebc92148eb895baa7770d9"
},
{
"order": 2,
"winner": false,
"team_id": 50652,
"team_name": "Fremantle Dockers",
"team_hash_image": "a50f813edbf71a0df910aabbf81ccb012b9a52ca6ec17cd696d40921e337c0ea"
}
],
"away_team_score": "59",
"home_team_score": "79",
"has_next_round_link": true,
"automatic_progression": false
},
{
"order": 2,
"participants": [
{
"order": 1,
"winner": false,
"team_id": 50638,
"team_name": "Sydney Swans",
"team_hash_image": "c0363fe3f998c8ab8b59c60251fc924ae83360f702cc44a31b46cf77816100de"
}
],
"has_next_round_link": true,
"automatic_progression": false
},
{
"order": 4,
"participants": [
{
"order": 1,
"winner": false,
"team_id": 50632,
"team_name": "Geelong Cats",
"team_hash_image": "c59ea05d78ed9c8b2b4335ae26d352d6f22be7ebf62ebfeff3792807c0fae636"
}
],
"has_next_round_link": true,
"automatic_progression": false
}
],
"description": "Semifinal"
},
{
"type": 0,
"order": 3,
"blocks": [
{
"order": 1,
"matches": [
733
],
"finished": true,
"participants": [
{
"order": 1,
"winner": true,
"team_id": 50638,
"team_name": "Sydney Swans",
"team_hash_image": "c0363fe3f998c8ab8b59c60251fc924ae83360f702cc44a31b46cf77816100de"
},
{
"order": 2,
"winner": false,
"team_id": 2225,
"team_name": "Collingwood Magpies",
"team_hash_image": "e1ca0a2c202717781b0bdd84654e00c8e05fc5a9ddebc92148eb895baa7770d9"
}
],
"away_team_score": "94",
"home_team_score": "95",
"has_next_round_link": true,
"automatic_progression": false
},
{
"order": 2,
"matches": [
741
],
"finished": true,
"participants": [
{
"order": 1,
"winner": true,
"team_id": 50632,
"team_name": "Geelong Cats",
"team_hash_image": "c59ea05d78ed9c8b2b4335ae26d352d6f22be7ebf62ebfeff3792807c0fae636"
},
{
"order": 2,
"winner": false,
"team_id": 50636,
"team_name": "Brisbane Lions",
"team_hash_image": "306509e2855d7418cac42157dec6d5d4a88e803995f1d2197845044de93c749b"
}
],
"away_team_score": "49",
"home_team_score": "120",
"has_next_round_link": true,
"automatic_progression": false
}
],
"description": "Preliminary finals"
},
{
"type": 1,
"order": 4,
"blocks": [
{
"order": 1,
"matches": [
715
],
"finished": true,
"participants": [
{
"order": 1,
"winner": true,
"team_id": 50632,
"team_name": "Geelong Cats",
"team_hash_image": "c59ea05d78ed9c8b2b4335ae26d352d6f22be7ebf62ebfeff3792807c0fae636"
},
{
"order": 2,
"winner": false,
"team_id": 50638,
"team_name": "Sydney Swans",
"team_hash_image": "c0363fe3f998c8ab8b59c60251fc924ae83360f702cc44a31b46cf77816100de"
}
],
"away_team_score": "52",
"home_team_score": "133",
"automatic_progression": false
}
],
"description": "Final"
}
]
}
]