match

GET

/matches/{matchKey}

const url = 'https://api.lovat.cjcameron.com/v2/matches/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.lovat.cjcameron.com/v2/matches/example \
  --header 'Authorization: Bearer <token>'

Authorizations

apiKey

Parameters

Path Parameters

matchKey

required

string

/^\d{4}[a-z0-9]+_(qm|ef|qf|sf|f)(\d+m)?\d+$/

Responses

200

application/json

object

key

required

string

tournamentKey

required

string

compLevel

required

string

Allowed values: qm ef qf sf f

setNumber

required

integer

>= -9007199254740991 <= 9007199254740991

matchNumber

required

integer

>= -9007199254740991 <= 9007199254740991

scheduledAt

required

Any of:

string
null

string format: date-time

actualAt

required

Any of:

string
null

string format: date-time

winningAlliance

required

Any of:

string
null

string

Allowed values: red blue

red

required

object

teams

required

Array

>= 3 items <= 3 items

score

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

blue

required

object

teams

required

Array

>= 3 items <= 3 items

score

required

Any of:

integer
null

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "compLevel": "qm",
  "winningAlliance": "red"
}