1 of 13

Live Objects

Action

Represents the player action details of a match.

Properties

Contains information about the action

version integer

API version

Contains a summary about the fixture status

traceId uuid

Unique tracing id for logs

{
   "fixtureAction":{
      "timestamp":"2023-05-14T13:36:57.372386Z",
      "actionId":"f8406467-91f4-4487-a392-0f505ee4e082",
      "fixtureSeqNum":110,
      "clockTime":"45:00",
      "fixtureActionType":"Yellow Card",
      "fixtureActionTypeId":107,
      "sendTypeId":1,
      "sendType":"Pending",
      "timelineSequence":2.0000027000000110,
      "team":{
         "homeTeam": false,
         "id":"e8e60aa9-15f6-49ee-a657-cdc04e32644b",
         "name":"FC Groningen"
      },
      "fixtureId":"f4a681f4-ee19-4073-bb43-82c765e5e596",
      "relatedFixtureActionIds":[
         
      ],
      "period":2
   },
   "version":3,
   "fixtureSummary":{
      "awayTeamScore":0,
      "currentClockTime":"45:00",
      "periods":[
         {
            "awayTeamPeriodScore":0,
            "awayTeamScore":0,
            "label":"1st half",
            "id":1,
            "homeTeamScore":0,
            "end":"2023-05-14T13:09:01",
            "type":"Regular",
            "homeTeamPeriodScore":0,
            "start":"2023-05-14T12:32:15"
         }
      ],
      "isHomeTeamInPossesion":false,
      "finished":false,
      "homeTeamScore":0,
      "collectionStatus":"CollectionSuspended",
      "isTied":true,
      "currentPeriod":2,
      "currentStatus":"Suspended"
   },
   "traceId":"371c02cb042e8ad7e70ed1a801139b68"
}

Fixture Action

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.

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

Pending actions can be cancelled.
Confirmed actions can be deleted and typically all key actions (card, goal, penalty) start with a pending state.
Deleted actions can be restored and when this happens you will receive the same action with an 'Updated' sendType
"Updated" is not only used for actions that have been deleted. It also used for any change of players or sub types or anything else regarding a previously "Confirmed" action
An action of one type can be 'Updated' to a different type. (i.e. a yellow to red card in soccer or defensive rebound to offensive rebound in basketball)

clockTime string

The value on the clock when the action was collected.

fixtureId UUID

The unique id of the fixture.

timestamp timestamp

sendTypeId integer

fixtureSeqNum boolean

A deduplicated list of scorer sequence numbers based on the action creation time across all devices and all scorers.

timelineSequence

The timeline sequence

fixtureActionType string

fixtureActionTypeId integer

The action type Id related to the fixtureActionType.

fixtureActionSubType string

The sub action type name.

relatedFixtureActionIds

The relatedFixtureActionId is used for two scenarios:

Deletable actions - e.g., disallowed goal would have goal action id as related so an operator can link actions.
follow on actions - e.g., basketball 2PT Missed might have defensive rebound and block as related.

fixtureActionSubTypeId integer

The sub action type id related to fixtureActionSubType.

Team details

Player information

delayStatus String

Identify delayed packets collected offline due to scorer disconnection, ensuring these packets include the actual collection timestamp upon reconnection.

Information on fixtureSeqNum and timelineSequence

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.

Sample Payload

"delayStatus": "DELAYED",
"fixtureAction": {
  "period": 1,
  "actionId": "6ee3f4f6-e85c-448a-a13a-f5b85979337f",
  "sendType": "Confirmed",
  "clockTime": "10:00",
  "fixtureId": "2104e2e1-3439-4684-a146-28df3f89bda2",
  "timestamp": "2022-09-25T14:20:57.092100Z",
  "sendTypeId": 5,
  "fixtureSeqNum": 11,
  "timelineSequence": 1.000000000000001,
  "fixtureActionType": "Red Card",
  "fixtureActionTypeId": 105,
  "fixtureActionSubType": "Straight Red",
  "fixtureActionSubTypeId": 10501,
  "team": {
    "homeTeam": true,
    "id": "867a43cd-140d-4792-a7b0-74eefca2527f",
    "name": "KV Kortrijk"
  },
  "player": {
    "id": "ac367f4c-c8a5-48ac-afdc-be9fbddfa60c",
    "name": "Kristof D'Haene"
  },
  "relatedFixtureActionIds":[],
}

Metadata

Provides essential contextual information about a sports event, including the coverage level, fixture status, collection status, and reason codes for collection status.

Properties

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.

JSON example

{
    "coverageLevel": 1,
    "fixtureStatus": 1,
    "collectionStatus": 3,
    "collectionStatusReasonCode": 6
}

Fixture Summary

Represents the summary of the fixture details.

Properties

isTied boolean

Is the match currently in a tied state?

Information for each period.

awayTeamScore integer

The away team score.

homeTeamScore integer

The home team score.

currentPeriod integer

The current period.

currentStatus string

collectionStatus

currentClockTime time

The clock time of the action.

isHomeTeamInPossession boolean

Is the home team in possession of the ball?

finished boolean

Inidicates the match has finished and no more packets will be sent

currentClockState String

Running
Stopped

Sample Payload

   "fixtureSummary":{
      "awayTeamScore":0,
      "currentClockTime":"45:28",
   
      ................
      "homeTeamScore":0,
      "isTied":true,
      "isHomeTeamInPossesion":false,
      "collectionStatus":"CollectingLive",
      "finished":true,
      "currentPeriod":1,
      "currentStatus":"Live"
      }

Club

Represents the club details of a team.

Properties

id uuid

Unique club id

name string

Name of the club

"club": {
                "id": "3bf65514-d1b3-4768-8119-cee69b574734",
                "name": "HAPOEL TEL AVIV"
}

Competition

Represents the competition details of an event to be played.

Properties

id uuid

Unique ID for this competition. Generated by IMG Arena.

name string

The competition's .

Venue

Represents the venue details of a tournament or season.

Properties

id uuid

Unique venue id

name String

Name of the location

Location

Details of location

"venue": {
            "id": "d97b065d-2b70-46de-b1e4-1147ae8e564a",
            "name": "Tempodrom",
            "location": {
                "name": "Berlin",
                "country": {
                    "name": "Germany"
                },
                "continent": {
                    "name": "Europe"
                }
            }
        }

Location

Represents the location details of a tournament or season.

Properties

Country

Represents the location details of a country where a competition to be played.

Properties

Continent

Represents the location details of a continent where a competition to be played.

Properties

Period

Represents the period's details.

Properties

Sample payload

Fixture Action

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

sendType string

the send type . Please also note some important information:

Pending actions can be cancelled.
Confirmed actions can be deleted and typically all key actions (card, goal, penalty) start with a pending state.
Deleted actions can be restored and when this happens you will receive the same action with an 'Updated' sendType
"Updated" is not only used for actions that have been deleted. It also used for any change of players or sub types or anything else regarding a previously "Confirmed" action
An action of one type can be 'Updated' to a different type. (i.e. a yellow to red card in soccer or defensive rebound to offensive rebound in basketball)

clockTime string

The value on the clock when the action was collected.

fixtureId UUID

The unique id of the fixture.

timestamp timestamp

of the action within the fixture, in RFC 3339 format.

sendTypeId integer

the send type .

fixtureSeqNum boolean

A deduplicated list of scorer sequence numbers based on the action creation time across all devices and all scorers.

timelineSequence

The timeline sequence

fixtureActionType string

The action type . Full list of actions can be found .

fixtureActionTypeId integer

The action type Id related to the fixtureActionType.

fixtureActionSubType string

The sub action type name.

relatedFixtureActionIds

The relatedFixtureActionId is used for two scenarios:

Deletable actions - e.g., disallowed goal would have goal action id as related so an operator can link actions.
follow on actions - e.g., basketball 2PT Missed might have defensive rebound and block as related.

fixtureActionSubTypeId integer

The sub action type id related to fixtureActionSubType.

team

Team details

player optional

Player information

delayStatus String

Identify delayed packets collected offline due to scorer disconnection, ensuring these packets include the actual collection timestamp upon reconnection.

Information on fixtureSeqNum and timelineSequence

Sample Payload

"delayStatus": "DELAYED",
"fixtureAction": {
  "period": 1,
  "actionId": "6ee3f4f6-e85c-448a-a13a-f5b85979337f",
  "sendType": "Confirmed",
  "clockTime": "10:00",
  "fixtureId": "2104e2e1-3439-4684-a146-28df3f89bda2",
  "timestamp": "2022-09-25T14:20:57.092100Z",
  "sendTypeId": 5,
  "fixtureSeqNum": 11,
  "timelineSequence": 1.000000000000001,
  "fixtureActionType": "Red Card",
  "fixtureActionTypeId": 105,
  "fixtureActionSubType": "Straight Red",
  "fixtureActionSubTypeId": 10501,
  "team": {
    "homeTeam": true,
    "id": "867a43cd-140d-4792-a7b0-74eefca2527f",
    "name": "KV Kortrijk"
  },
  "player": {
    "id": "ac367f4c-c8a5-48ac-afdc-be9fbddfa60c",
    "name": "Kristof D'Haene"
  },
  "relatedFixtureActionIds":[],
}

Live Objects

Action

Properties

Fixture Action

Information on fixtureSeqNum and timelineSequence

Sample Payload

Metadata

Properties

Fixture Summary

Properties

Sample Payload

Category

Properties

Club

Properties

Competition

Properties

Venue

Properties

Location

Properties

Country

Properties

Continent

Properties

Period

Properties

Sample payload

Live Objects

Fixture Action

Information on fixtureSeqNum and timelineSequence

Sample Payload

Metadata

Properties

Category

Properties

Club

Properties

Fixture Summary

Properties

Sample Payload

Action

Properties

Competition

Properties

Venue

Properties

Country

Properties

Location

Properties

Continent

Properties

Period

Properties

Sample payload