​
Overview

The MatchRequest API allows external platforms to submit a new match for analysis within the KoraStats system. When a request is submitted, the match enters the analysis pipeline where it will be processed according to the selected Service Level Agreement (SLA). The request includes metadata about the match, competition details, and associated files such as:
  • Match video
  • Match sheet
  • Additional supporting documents
This endpoint is typically used by:
  • Broadcast partners
  • Data providers
  • Clubs and federations
  • Third-party analytics platforms
to request match processing and analysis.

​
Parameters

​
module
string
Module API fixed and cannot be changed. Always use api.
​
api
string
Endpoint name. Use MatchRequest.
​
version
string
API version. Use V2.
​
response
string
Output format (json).
​
key
string
API authentication key used to authorize the request.

​
Request Body

The request must include a JSON object describing the match and its associated files. 
{
  "competition": "Competition Name",
  "season": "Season Name",
  "round": 3,
  "homeTeam": "Home Team Name",
  "awayTeam": "Away Team Name",
  "kickOffDate": "2023-09-20T20:00:00Z",
  "referenceMatchId": "65166530367c2fe1068f8057xxxxxxxxxx",
  "serviceLevelAgreement": "SLA48",
  "accountName": "SLA48",
  "priority": 10,
  "matchDuration": "minutes90",
  "fileCreated": "2023-09-29T05:54:58.077673Z",
  "notes": "Write some notes in here",
  "files": [
    {
      "filename": "Filename.pdf",
      "downloadUrl": "https://linktofile",
      "type": "MatchSheetHomeAway"
    },
    {
      "filename": "Filename.mp4",
      "downloadUrl": "https://linktofile",
      "type": "MatchVideoFull"
    }
  ]
}

​
Request Fields

​
Match Information

FieldTypeDescription
competitionstringName of the competition (e.g. English Premier League).
seasonstringCompetition season (e.g. Season 2023/2024).
roundintegerLeague round or tournament stage.
homeTeamstringName of the home team.
awayTeamstringName of the away team.
kickOffDatedatetimeScheduled match kickoff date and time in ISO format.
referenceMatchIdstringExternal system identifier used to reference the match.

​
Processing Information

FieldTypeDescription
serviceLevelAgreementstringProcessing SLA category.
accountNamestringAccount SLA category.
priorityintegerPriority level from 1 to 10 (10 = highest priority).
matchDurationstringMatch duration format (example: minutes90).
fileCreateddatetimeTimestamp indicating when the request files were created.
notesstringAdditional notes related to the match request.

​
Service Level Agreement (SLA)

The SLA determines how quickly the match analysis will be delivered. Available values include:
  • LIVE
  • SLA24
  • SLA48
  • SLA72
Higher priority requests are processed earlier when multiple matches are queued.

​
Files

The files array contains the files required to process the match. At least two files are required:
  • Match video
  • Match sheet
FieldTypeDescription
filenamestringFile name including extension.
downloadUrlstringURL where the file can be downloaded.
typestringFile type category.
Example file types:
  • MatchVideoFull
  • MatchSheetHomeAway
  • MatchEvents
  • MatchLineups

​
Example Request

curl --request POST \
--url "https://korastats.pro/pro/api.php?module=api&api=MatchRequest&version=V2&response=json&key=YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data @request.json

{
  "result": "string",
  "message": "string",
  "data": {
    "requestId": "string",
    "status": "string"
  }
}

​
Field Description

FieldTypeDescription
resultstringIndicates whether the request was processed successfully.
messagestringResponse message describing the request result.
dataobjectObject containing information about the submitted match request.
data.requestIdstringUnique identifier assigned to the submitted match request.
data.statusstringCurrent status of the request within the KoraStats processing pipeline.