Loading...
Loading...
Loading...
Loading...
Loading...
The competition object represents a structured set of information that defines a specific competition or league.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Name | Type | Description |
---|
id | UUID | Unique ID for this competition. IMG Arena generates it. |
name | String |
category |
location | The competition's location. |
The competition's .
The competition's .
Represents the location details of a continent where a competition to be played.
Name | Type | Description |
---|---|---|
name
String
Continent's name
Name | Type | Description |
---|---|---|
action
String
Action type name
actionId
Integer
Unique id of a specific action type
actionAggregate
Integer
Number of times a specific action was recorded during a match
subActionAggregates
Detailed information of record sub action types
Represents the location details of a tournament or season.
Name | Type | Description |
---|---|---|
name
String
Location name. This is usually a city, occasionally a country.
country
Country name in official format.
continent
Continent where the given country belongs.
Name | Type | Description |
---|---|---|
isTied
Boolean
Is the match currently in a tied state?
periods
Information for each period.
finished
Boolean
Inidicates the match has finished and no more packets will be sent
awayTeamScore
Integer
The away team score.
homeTeamScore
Integer
The home team score.
currentPeriod
Integer
The current period.
currentStatus
String
Scheduled
Live
Completed
Postponed
Abandoned
Cancelled
Suspended
Unverified
collectionStatus
String
CollectionScheduled
CollectingLive
CollectingPostMatch
CollectionSuspended
CollectionDropped
CollectionCompleted
PostMatchChecked
currentClockTime
String
The clock time of the action.
isHomeTeamInPossession
Boolean
Is the home team in possession of the ball?
currentClockState
String
Running
Stopped
Name | Type | Description |
---|---|---|
player
Detailed information of a team
gameActionAggregates
Aggregated event data that comprises of general attributes and event specific attributes and is grouped by a player
periodActionAggregates
Provides aggregated event data for each player within a given period
Represents a stage details of an event.
Name | Type | Description |
---|
id | UUID | Unique ID for this competition. IMG Arena generates it. |
name | String | The competition's name. |
startDateUTC | String | Start date in UTC format. |
endDateUTC | String | End date in UTC format. |
season | Season details. |
Property | Type | Description |
---|---|---|
id
UUID
Unique squad id
season
Season within the squad is registered
team
Information about the team
players
Players' details within a team
Property | Type | Description |
---|---|---|
seqNum
Integer
Sequence number.
traceId
Tracing Id for logs.
version
Integer
API version.
finished
Boolean
Indicates whether a match has finished.
fixtureId
UUID
Unique fixture Id.
timestamp
String
of when the statistics were created, in RFC 3339 format.
teamActionAggregates
Aggregated actions statistics.
Name | Type | Description |
---|---|---|
id
UUID
Unique venue id
name
String
Name of the venue
location
Location information
gameStatistics
teamsStatistics
americanFootballFixtureState
Property | Type | Description |
---|---|---|
id
UUID
Unique ID for this fixture. Generated by IMG Arena.
name
String
The fixture's .
status
String
Scheduled
Live
Completed
Postponed
Abandoned
Cancelled
Suspended
Unverified
collectionStatus
String
CollectionScheduled
CollectingLive
CollectingPostMatch
CollectionSuspended
CollectionDropped
CollectionCompleted
PostMatchChecked
type
String
This allows a user to call the fixtures API by 'Official', 'Simulation' or 'Training'.
coverageLevel
String
No Coverage
In Venue
Low Latency Stream
Standard Stream
Video Post Match
startDateUTC
String
of when the fixture is scheduled to start, in RFC 3339 format.
teams
Team details
stage
Stage information
venue
Details of the venue
fixtureSummary
usages
String
FastPath
Represents the category details of a team or competition.
Represents the player action details of a match.
Name | Type | Description |
---|
Name | Type | Description |
---|
id | Integer | Category ID |
name | String |
|
traceId | UUID | Unique tracing id for logs |
version | Integer | API version |
finished | Boolean |
fixtureAction | Contains information about the action |
fixtureSummary | Contains a summary about the fixture status |
fixtureSeqNum is a deduplicated list of scorer sequence numbers based on the action creation time across all devices and all scorers. timelineSequence is a value that considers the chronological order of actions. The intention is for it to be both sequential and unique, ensuring that no actions have the same timelineSequence and that any action occurring afterward has a greater timeline sequence. When a fixture is finished the order of actions is based on the timelinesequence. During a live match, the packets should be ordered by fixtureSeqNum.
Name | Type | Description |
---|
name string
Official name of a country
period | Integer | The period id. |
actionId | UUID | The id number of the action. This will be useful in linking actions that are pending, updated etc. |
metadata | Provides essential contextual information about a sports event, including the coverage level, fixture status, collection status, and reason codes for collection status. This parameter enhances the data's utility by indicating the depth of event coverage, the real-time progress of the fixture, the current state of data collection, and explanations for any collection interruptions. |
sendType | String |
clockTime | String | The value on the clock when the action was collected. |
fixtureId | UUID | The unique id of the fixture. |
timestamp | String |
sendTypeId | Integer |
fixtureSeqNum | Integer | A deduplicated list of scorer sequence numbers based on the action creation time across all devices and all scorers. |
timelineSequence | Double | The timeline sequence |
fixtureActionType | String |
fixtureActionTypeId | Integer | The action type Id related to the fixtureActionType. |
relatedFixtureActionIds | String | The sub action type name. |
delayStatus | String | Identify delayed packets collected offline due to scorer disconnection, ensuring these packets include the actual collection timestamp upon reconnection. |
the send type .
of when the season is scheduled to start, in RFC 3339 format.
the send type .
The action type . Full list of actions can be found .
Name | Type | Description |
---|---|---|
id
UUID
Unique ID for this season. Generated by IMG Arena.
name
String
The season's .
startDateUTC
String
of when the season is scheduled to start, in RFC 3339 format.
endDateUTC
String
of when the season is scheduled to end, in RFC 3339 format.
competition
A list of competitions played within the season.
stages
Location details of the season.
Name | Type | Description |
---|---|---|
id
Integer
The period ID.
type
String
Match type.
label
String
String value describing the period.
start
String
Timestamp of when the period has started, in RFC 3339 format.
end
String
Timestamp of when the period has ended, in RFC 3339 format.
homeTeamScore
Integer
The overall home team score.
awayTeamScore
Integer
The overall away team score.
homeTeamPeriodScore
Integer
The home team score in that period.
awayTeamPeriodScore
Integer
The away team score in that period.
id uuid
Unique player id
name string
Full name of the player
subAction string
Sub action type name
subActionId integer
Unique id of a specific sub action type
subActionAggregate integer
Number of times a specific sub action was recorded during a match
Represents a team's details.
Name | Type | Description |
---|---|---|
id
UUID
Unique id of a team.
name
String
Team's name.
club
More details about the club the team belongs to.
category
Team's category.
homeTeam
Boolean
Indicates whether the team is playing at home or away.
Represents a stage details of an event.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|
id
UUID
Unique club id
name
String
Name of the club
id | UUID | Unique ID for this competition. IMG Arena generates it. |
name | String | The competition's name. |
startDateUTC | String | Start date in UTC format. |
endDateUTC | String | End date in UTC format. |
rounds | Round details. |
groups | Group details. |
Name | Type | Description |
---|---|---|
type
String
The match .
label
String
The string relating to the period.
period
Integer
The period of the match
aggregates
Aggregates
Aggregated event data that comprises of general attributes and event specific attributes and is grouped by sport specific action types.
coverageLevel
Defines the granularity of data collected for an event.
fixtureStatus
Indicates the current phase of an event, such as upcoming, in progress, paused or completed.
collectionStatus
Reflects the ongoing state of data collection for an event, highlighting if it's active, paused, or complete.
collectionStatusReasonCode
Provides a code or explanation for the current data collection status, clarifying any interruptions or changes.
Name | Type | Description |
---|---|---|
team
Team information
gameActionAggregates
Game action aggregates
periodActionAggregates
Period action aggregates
playerActionAggregates
Player action aggregates