Overview
Retrieve a list of games and related fixture information per specified team.
This includes:
- Status of game;
- Grade and round information for each game;
- schedule for the game and
- the opposing team.
All data can be retrieved in real time but certain information may not be available until the fixture or game has been finalised.
Terms of use
Play HQ API credentials
Team Fixture Collection uses API keys to authenticate requests. To request API credentials please submit a support request.
Important: API credential requests will be reviewed by PlayHQ and the administration body for the relevant sport or association.
Once you have received your credentials from PlayHQ you will be able to generate an authentication token. More information on how to do this can be found here.
Resources
Get Request
GET /v1/teams/:id/fixtureData included in a successful response
|
Field Name in File |
Field Description |
Sample Data (or picklist values, if appropriate) |
Database Table/Node Name* |
Database Field Type* |
|---|---|---|---|---|
|
id |
Game UUID |
88a5b302-f71f-11ea-adc1-0242ac120002 |
|
UUID |
|
status |
Status of game |
UPCOMING |
|
String |
|
url |
URL to Game Centre on PlayHQ |
https://www.playhq.com/basketball-victoria/org/jg_association2/domestic-winter-2021/monday-u10-mixed/game-centre/91e4cde3 |
|
|
|
createdAt |
Game Created At timestamp |
2015-08-05T08:40:51.620Z |
|
String |
|
updatedAt |
Game last updated at timestamp |
2015-08-05T08:40:51.620Z |
|
String |
|
grade |
Object (defined below) |
|
|
Object |
|
grade.id |
Grade ID |
d1f9c41d-cb8f-4faa-a338-cb714ba97a8c |
|
UUID |
|
grade.name |
Grade Name |
12 Boys - VJL2 (P2) |
|
String |
|
grade.url |
Grade URL |
https://www.playhq.com/basketball-victoria/org/keilor-thunder-basketball-club/victorian-junior-basketball-league-2021/12-boys-vjl2-p2/65260768 |
|
|
|
round |
Object (defined below) |
|
|
Object |
|
round.id |
Unique ID of round |
a93c2389-b361-4af1-95f1-a758900fb018 |
|
UUID |
|
round.name |
Name of round |
Round 1 |
|
String |
|
round.abbreviatedName |
Short name for round |
R1 |
|
String |
|
round.isFinalRound |
Flag to determine if round is final in grade |
false |
|
Boolean |
|
pool |
Pool game is associated to |
null |
|
String |
|
schedule |
Object containing details of the games schedule |
|
|
Object |
|
schedule.date |
Scheduled date for each game |
2015-08-05 |
|
String |
|
schedule.time |
Scheduled time for each game |
08:40:51 |
|
String |
|
schedule.timezone |
Timezone for each game |
Australia/Melbourne |
|
String |
|
competitors |
Array of sub objects (defined below) |
|
|
Array |
|
competitors.id |
Competitors Id |
95c446ef-dea5-486e-96bb-1bb24a609177 |
|
UUID |
|
competitors.name |
Competitors Name |
Keilor U12 Boys 2 |
|
String |
|
competitors.isHomeTeam |
Flag to determine which team is home team |
true |
|
String |
|
competitors.outcome |
Game outcome for specified team |
i.e. Won or Lost |
|
String |
|
competitors.scoreTotal |
Competitors Score Total |
40 |
|
Number |
|
competitors.scoreSubtotals |
Array of sub objects (defined below) |
|
|
Array |
|
competitors.scoreSubtotals.type |
Game subtotals score type for specified team and game |
i.e. Behinds Total or Goals Total 2_POINTER |
|
String |
|
competitors.scoreSubtotals.count |
Game subtotal count for specified team and game |
2 |
|
Number |
|
competitors.scoreSubtotals.value |
Game subtotals total value for each score type, specified team and game |
4 |
|
Number |
|
venue |
Object (defined below) |
|
|
Object |
|
venue.id |
Id of Venue |
eccf8810-7d57-4ffd-bb48-9418e3eb93ac |
|
UUID |
|
venue.name |
Venue name |
Keilor Basketball Netball Stadium |
|
String |
|
venue.surfaceName |
Court/ Playing surface name within Venue |
Court 1 |
|
String |
|
venue.surfaceNameAbbreviation |
Short Court/ Playing surface name within Venue |
CRT1 |
|
String |
|
venue.address |
Object (defined below) |
|
|
Object |
|
venue.address.line1 |
Venue Address Line 1 |
Stadium Dr |
|
String |
|
venue.address.suburb |
Venue Address Suburb |
Keilor Park |
|
String |
|
venue.address.postcode |
Venue Address Postcode |
3042 |
|
Number |
|
venue.address.state |
Venue Address Stat |
VIC |
|
String |
|
venue.address.country |
Venue Address Country |
AU |
|
String |
|
venue.address.longitude |
Venue Address Longitude |
-37.713286 |
|
Number |
|
venue.address.latitude |
Venue Address Latitude |
144.848203 |
|
Number |
|
metadata |
Object (defined below) |
|
|
Object |
|
metadata.hasMore |
|
true |
|
Boolean |
|
metadata.nextCursor |
|
dXNlcjpXMDdRQ1JQQTQ= |
|
|
Errors
|
Scenario |
|
|---|---|
|
Submit an invalid team ID |
400 - Bad Request |
|
Submit multiple team IDs |
400 - Bad Request |