📢 The Ask AI can now translate any part of the docs to your preferred language!
Read the guide
sportradar.comSportradar Support Portal

event

For: READ, PUBLISH

The event message type is the most common type. It is generated when some kind of event occurs. Whether this is a shot at goal, a referee being assiged or event just the ball moving, these can all generate messages of the 'event' type.

The event messages are broken down by a number of different classifier fields. In increasing levels of granularity they are:

class

This defines the type of events this message is related to. Some examples include: sport; events relating to something that happens as part of the sporting event. EG. A shot at goal or a foul setup; events relating to the setup of the match. EG. Assiging a player to a team/position, assigning a referee

eventType

The type of the event (inside the class). For a sport class message this may be the type of shot being made, or for a setup class message the type of thing being assigned.

subType

Some eventTypes (but not all) also support a 'subType' to further classify the eventType

options

Some eventTypes/subTypes support additional options for more information about the event. These are key/pair values. While some values may be boolean (true/false) others can be integer, strings etc.

While all messages of type 'event' require a class, the other fields may or may not be required depending on the type of event.

        {
            "type": "event",
            "fixtureId": "b25692de-ac17-11e8-98d0-529269fb1459",
            "clientType": "AppName:Version",
            "data": {
                "eventId": "c2404cc0-9f75-11e8-98d0-529269fb1459",
                "entityId": "c24048a6-9f75-11e8-98d0-529269fb1459",
                "personId": "c2405b2a-9f75-11e8-98d0-529269fb1459",
                "class": "sport",
                "eventType": "2pt",
                "eventTime": "2018-08-14T16:45:33.88",
                "subType": "jumpShot",
                "options": {
                    "fastBreak": true,
                    "pointsInThePaint": true,
                    "distance": 2.3,
                },
                "clock": "PT08M23S",
                "shotClock": "PT12.3S",
                "periodId": 2,
                "success": true,
                "x": 56,
                "y": 23,
                "officialId": "c2404ff4-9f75-11e8-98d0-529269fb1459",
                "playId": "d8934b2a-9f75-11e8-98d0-529269fb1459",
                "scores": {
                    "c24048a6-9f75-11e8-98d0-529269fb1459": "56",
                    "b25692de-ac17-11e8-98d0-529269fb1459": "23",
                },
                "status": "updated",
                "timestamp": "2018-08-14T16:45:34.34"
            }
        }

For each sport/event/eventType/SubType the required fields and available different combinations are varied. Please see the list below for more information.

class
eventType
subType
options
Required Fields

setup

fixture

post

periodLengthinteger Length of period in minutes numberOfPeriodsinteger Number of periods in the fixture attendanceinteger Total attendance count

class eventType options.numberOfPeriods options.periodLength

person

namestring The person's name positionstring The position this person plays Allowed Values:

  • GK

  • O

  • D

  • FB

  • HB

  • SW

  • M

  • CH

  • DM

  • AM

  • F

  • CF

  • LF

  • RF

  • S

starterboolean Is this person a starter? captainboolean Is this person the captain? bibstring The number/position on this person's shirt/bib

class eventType personId entityId options.name

role

entity

namestring The team staff person’s name numberinteger[1-10] The persons's number, eg 2nd assistant coach bibstring The number/position on this person's shirt/bib positionstring The position/role of this person Allowed Values:

  • COACH_HEAD

  • COACH_ASSISTANT

  • MANAGER

  • PHYSIOTHERAPIST

  • DOCTOR

  • OTHER

class eventType entityId

fixture

namestring The team staff person’s name numberinteger[1-10] The persons's number, eg 2nd assistant coach bibstring The number/position on this person's shirt/bib positionstring The official's position Allowed Values:

  • UMPIRE

  • UMPIRE_1

  • UMPIRE_2

  • MEDIA_OFFICER

  • UMPIRE_RESERVE

  • TECHNICAL_OFFICIAL

  • TECHNICAL_DELEGATE

  • UMPIRE_VIDEO

  • JUDGE_TIMING

  • JUDGE_SCORING

class eventType personId options.name options.position

sport

assist

class eventType personId entityId periodId

centrePass

class eventType entityId periodId

challenge

awarded

class eventType entityId periodId subType

made

class eventType entityId periodId subType

missed

class eventType entityId periodId subType

emptyNet

over

class eventType entityId periodId subType

start

class eventType entityId periodId subType

fixture

abandoned

class eventType subType

cancelled

class eventType subType

confirmed

class eventType periodId

delayed

class eventType subType

end

class eventType periodId

pending

class eventType periodId

start

class eventType periodId

warm_up

class eventType subType

goal

(blank)

goalOutcomestring What was the outcome of the goal Allowed Values:

  • PENALTY_CORNER

  • PENALTY_STROKE

  • FIELD_GOAL

  • CHALLENGE

class eventType entityId periodId

missed

goalOutcomestring What was the outcome of the goal Allowed Values:

  • PENALTY_CORNER

  • PENALTY_STROKE

  • FIELD_GOAL

  • CHALLENGE

class eventType entityId periodId

ownGoal

goalOutcomestring What was the outcome of the goal Allowed Values:

  • PENALTY_CORNER

  • PENALTY_STROKE

  • FIELD_GOAL

  • CHALLENGE

class eventType entityId periodId

saved

goalOutcomestring What was the outcome of the goal Allowed Values:

  • PENALTY_CORNER

  • PENALTY_STROKE

  • FIELD_GOAL

  • CHALLENGE

saveOutcomestring How was the goal saved? Allowed Values:

  • HAND

  • STICK

  • FOOT

  • BODY

class eventType subType

greenCard

timeinteger Number of minutes cardReasonstring Reason for receiving the card Allowed Values:

  • UNSPORTSMANLIKE_BEHAVIOUR

class eventType entityId periodId personId options.time

longCorner

class eventType entityId periodId

penaltyCorner

class eventType entityId periodId

penaltyStroke

awarded

goalKeeperIdstring The ~person~ ID of the opposition goalkeeper

class eventType entityId periodId subType

made

goalKeeperIdstring The ~person~ ID of the opposition goalkeeper

class eventType entityId periodId subType

missed

goalKeeperIdstring The ~person~ ID of the opposition goalkeeper

class eventType entityId periodId subType

saved

goalKeeperIdstring The ~person~ ID of the opposition goalkeeper saveOutcomestring How was the penalty stroke saved? Allowed Values:

  • HAND

  • STICK

  • FOOT

  • BODY

class eventType options.saveOutcome

period

confirmed

class eventType periodId subType

end

class eventType periodId subType

pending

class eventType periodId subType

start

class eventType periodId subType

playerSuspension

over

timeinteger Number of minutes

class eventType entityId periodId personId options.time

start

timeinteger Number of minutes

class eventType entityId periodId personId options.time

possession

attack

timestring Time in possession (in ISO 8601 duration format, e.g. PT12M34S)

class eventType entityId periodId options.time

attackDangerous

timestring Time in possession (in ISO 8601 duration format, e.g. PT12M34S)

class eventType entityId periodId options.time

circle

timestring Time in possession (in ISO 8601 duration format, e.g. PT12M34S)

class eventType entityId periodId options.time

defensive

timestring Time in possession (in ISO 8601 duration format, e.g. PT12M34S)

class eventType entityId periodId options.time

defensiveSafe

timestring Time in possession (in ISO 8601 duration format, e.g. PT12M34S)

class eventType entityId periodId options.time

starting

timestring Time in possession (in ISO 8601 duration format, e.g. PT12M34S)

class eventType entityId periodId options.time

redCard

cardReasonstring Reason for receiving the card Allowed Values:

  • DANGEROUS_PLAY

  • VERBAL_ABUSE

  • OTHER

  • CONFIRM_LATER

class eventType entityId periodId personId

shootOut

end

class eventType periodId subType

pending

class eventType periodId subType

start

class eventType periodId subType

shootOutAttempt

made

penaltyStrokeboolean Did a penalty stroke occur?

class eventType success entityId periodId personId subType

missed

penaltyStrokeboolean Did a penalty stroke occur?

class eventType success entityId periodId personId subType

retake

penaltyStrokeboolean Did a penalty stroke occur?

class eventType success entityId periodId personId subType

saved

penaltyStrokeboolean Did a penalty stroke occur? saveOutcomestring How was the penalty stroke saved? Allowed Values:

  • HAND

  • STICK

  • FOOT

  • BODY

class eventType success entityId periodId personId subType

shootOutDefence

conceded

class eventType entityId periodId subType

saved

class eventType entityId periodId subType

shootOutToss

lost

class eventType entityId subType

won

class eventType entityId subType

substitution

in

class eventType personId entityId subType

out

class eventType personId entityId subType

toss

lost

class eventType entityId subType

won

class eventType entityId subType

videoReview

pending

teamboolean Team video review umpireboolean Umpire video review

class eventType periodId

rejected

teamboolean Team video review umpireboolean Umpire video review

class eventType periodId

upheld

teamboolean Team video review umpireboolean Umpire video review

class eventType periodId

yellowCard

timeinteger Number of minutes cardReasonstring Reason for receiving the card Allowed Values:

  • BREAKDOWN_OF_PLAY

  • BACK_STICK

  • DELIBERATE_FOOT

  • DRILLING

  • KNOCKING_BALL_AWAY

  • NOT_5M

  • NOT_3M

  • SLIDING_TACKLE

  • VERBAL_ABUSE

  • OTHER

  • DANGEROUS_PLAY

  • CONFIRM_LATER

class eventType entityId periodId personId options.time

clock

countDown

adjust

valuestring The new value of the clock

class eventType options.value

start

class eventType subType

stop

class eventType subType

greenCard

adjust

valuestring The new value of the clock

class eventType options.value

start

class eventType subType

stop

class eventType subType

main

adjust

valuestring The new value of the clock

class eventType options.value

start

class eventType subType

stop

class eventType subType

shootOut

adjust

valuestring The new value of the clock

class eventType options.value

start

class eventType subType

stop

class eventType subType

yellowCard

adjust

valuestring The new value of the clock

class eventType options.value

start

class eventType subType

stop

class eventType subType

heartbeat

client

class eventType

disconnect

client

class eventType

reset

client

class eventType

clientSessionStart

client

sessionIdstring Id for the client application user session authMethodstring The authentication method used by the client application usernamestring Username of the user in the client application userIdstring User identifier in the client application

class eventType

Bold fields are required. Other fields may be required depending on the eventClass/type etc.

Field
Description

eventId

A unique identifier for an event/action. UUIDv1 format. An edits/deletes of this event will need to use the same identifier.

entityId

A unique identifier for the entity/team that is performing this event/action. UUIDv1 format.

personId

A unique identifier for the person /team that is performing this event/action. UUIDv1 format. If the person is part of an entity/team that id field should also be included.

class

The class of the event - see above

eventType

The eventType of the event - see above

subType

The subType of the event - see above

options

The options for the event - see above

eventTime

An ISO-8601 datetime giving the time this event occurred. If this event is added out of sequence, then this timestamp should reflect when the event 'would' have occurred.

clock

The game clock time when this action occurred. Format ISO-8601 Duration.

shotClock

The game shot clock time when this action occurred. Format ISO-8601 Duration.

periodId

The unique identifier of the period. Overtime periods start at 11. 1 = 1 OT1 = 11

success

Boolean. Did the action complete successfully. It most cases this is true, however goal/shot attempts can be false.

x

The x-coordinate on the playing surface where the action occurred.

y

The y-coordinate on the playing surface where the action occurred.

z

The z-coordinate on the playing surface where the action occurred.

officialId

The unique identifier of the official who made this call.

playId

The unique identifier of the 'play' (a group of events who share this id).

scores

The structure of entityIds and scores giving the current score after the completion of the action.

status

The status of this message. Options are added (Default); updated - meaning the content of this event has been edited; deleted - meaning this event has been deleted; enriched - meaning further information has been added to the event (not changed).

flagged

Boolean. This event has been flagged for further review and may be changed later

highlight

Boolean. This event may be a highlight of the game.

timestamp

An ISO-8601 datetime giving the time this message was sent.

clientType

The type of client that is sending this event. Generally this is given as ApplicationName:ApplicationVersion.

If a field has no value it should not be sent as part of the message. If a field has no value then it should not be sent as part of the message. "" or 0 are valid values and should only be used when the value is known to be these values.

PreviousMessage TypesNextscoreboard

Last updated

Was this helpful?