Games Collection by organisation & date

Overview

Retrieve a list of games and fixture information including game results, for a specified organisation on a given day.

This includes:

  • association and competition details,

  • season and grade information,

  • teams or competitors and

  • venue details.

Play HQ Terminology


Terms of use

https://www.playhq.com/terms


Play HQ API credentials

The Games Collection API uses API keys to authenticate requests. To request API credentials please contact support@playhq.com

Once you have received your credentials from Play HQ you will be able to generate an authentication token. More information on how to do this can be found here.


Resources

Get Request

GET partner/v1/organisations/:id/games/:date
Information on Path and Header parameters can be found here.

Data included in a successful response

Name in File

Field Description

Sample Data

Database Field Typ

id

Unique game ID

88a5b302-f71f-11ea-adc1-0242ac120002

UUID

status

Status of game

UPCOMING

String

createdAt

Game Created At timestamp (UTC format)

2015-08-05T08:40:51.620Z

String

updatedAt

Game last updated at timestamp
(UTC format)

2015-08-05T08:40:51.620Z

String

ASSOCIATION

Object (defined below)

 

Object

association.id

Association Id owning the game

ccc647fa-286a-433b-8284-464c37d6f049

UUID

association.name

Association Name

Keilor Basketball Association

String

association.url

Association URL

https://www.playhq.com/basketball-victoria/org/keilor-basketball-association/ccc647fa

 

association.logo

Object containing logo properties (defined below)

 

Array

association.logo.sizes

Array of objects (defined below)

 

 

association.logo.sizes.url

Logo of Association

https://assets.playhq.com/bv/ccc647/64_64_logo.png

String

association.logo.sizes.dimensions

Object containing logo dimensions (defined below)

 

Object

association.logo.sizes.dimensions.width

 

64

Number

association.logo.sizes.dimensions.height

 

64

Number

COMPETITION

Object (defined below)

 

Object

competition.id

Competition Id

8e4e71fc-1f3e-4eba-9701-d5f361d2c269

UUID

competition.name

Competition Name

Victorian Junior Basketball League

String

SEASON

Object (defined below)

 

Object

season.id

Season ID

11ed119a-cb8f-4faa-a338-cb714ba97a8c

UUID

season.name

Season Name

2021

String

season.status

Season Status

UPCOMING
ACTIVE
COMPLETED

 

season.url

Season URL

https://www.playhq.com/basketball-victoria/org/keilor-basketball-association/junior-domestic-winter-2021/8e4e71fc

 

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

Round Id

a93c2389-b361-4af1-95f1-a758900fb018

UUID

round.name

Round Name

Round 1

String

POOL

Object (defined below)

 

Object

pool.id

Pool identifier - Optional grouping within each grade

null

UUID

pool.name

Pool name

Pool A

String

SCHEDULE

Object (defined below)

 

Object

schedule.date

Schedule date

2015-08-05

String

schedule.time

Schedule time

08:40:51

String

schedule.timezone

Schedule Timezone

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 if team is playing on home ground

true

Boolean

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

String

competitors.scoreSubtotals.value

Game subtotals for specified team and game

4

Number

VENUE

Object (defined below)

 

Object

venue.id

Id of Venue

eccf8810-7d57-4ffd-bb48-9418e3eb93ac

UUID

venue.name

 

Keilor Basketball Netball Stadium

String

venue.surfaceName

 

Court 1

String

venue.surfaceNameAbbreviation

 

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

Error Response

Submit an invalid organisation ID

400 - Bad Request

Submit multiple organisation IDs

400 - Bad Request

Submit an invalid date format

400 - Bad Request

Unauthorised GET submitted for a valid organisation ID on a valid date via the private endpoint

401 - Unauthorised

Authorised GET submitted for a valid organisation ID that exists for another sport.

403 - Forbidden

 

Sample Response

PlayHQ External API

Was this article helpful?
0 out of 0 found this helpful