Skip to content
Developers

Get a match summary

GET/v2/matches/{matchId}/summary

GET
/v2/matches/{matchId}/summary
curl --request GET \
  --url https://api.ligr.live/rest/v2/matches/1/summary \
  --header 'Authorization: Bearer <token>'

Return team-level match and period stats, score, clock, and period state for a match.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
matchId
required

Entity identifier

integer format: int32
>= 1

The match identifier

Query Parameters

Section titled “Query Parameters”
lng
string

Language code for period names (defaults to en)

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json
object
matchId
required

Entity identifier

integer format: int32
>= 1
sport
required
string
Allowed values: football rugbyUnion rugbyLeague netball cricket futsal iceHockey fieldHockey waterPolo handBall lacrosse touchFootball ausRules basketball rugbySevens gridiron volleyball baseball tennis
score
required
Any of:
object
home
required
number format: double
away
required
number format: double
homeShootout
number format: double
nullable
awayShootout
number format: double
nullable
clock
required
object
clockRunning
required
boolean
clockInMs
required
number format: double
clockChangeDate
string
nullable
currentPeriod
required
number format: double
periods
required
Array<object>
object
number
required
number format: double
name
required
string
shortName
required
string
abbreviation
required
string
type
required

Literal unions (rather than the internal enums from ‘@/types/Period’) so the REST contract stands alone and tsoa model names can’t collide with identically-named enums elsewhere in the program (e.g. aws-sdk’s PeriodType).

string
Allowed values: regular overtime
status
required
string
Allowed values: live break
duration

Period duration in milliseconds

number format: double
nullable
started
string
nullable
finished
string
nullable
pregame
boolean
nullable
shootout
boolean
nullable
matchFinished
boolean
nullable
finishType
string
Allowed values: default cancelled finishedEarly abandoned
stats
required
object
home
required

Construct a type with a set of properties K of type T

object
away
required

Construct a type with a set of properties K of type T

object
periods
required
Array<object>
object
periodNumber
required
number format: double
home
required

Construct a type with a set of properties K of type T

object
away
required

Construct a type with a set of properties K of type T

object
score
required
Any of:
object
home
required
number format: double
away
required
number format: double
homeShootout
number format: double
nullable
awayShootout
number format: double
nullable
updatedAt
required
string
Example
{
  "sport": "football",
  "periods": [
    {
      "type": "regular",
      "status": "live",
      "finishType": "default"
    }
  ]
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Match not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}