status

For: READ

The status message type contains information about the current status of the fixture and data sources.

        {
            "type": "status",
            "fixtureId": "b25692de-ac17-11e8-98d0-529269fb1459",
            "data": {
                "sources": {
                    "event": "CONNECTED",
                    "scoreboard": "NOT_AVAILABLE"
                }
                "status": {
                    "fixture": "DELAYED",
                    "options" {
                        "reason": "MEDICAL",
                        "newTime": "2019-08-14T16:55:14.34"
                    },
                    "period": "PENDING",
                    "periodId": 1
                },
                "entities": {
                    "a4f0794e-253b-11eb-adc1-0242ac120002": {
                        "score": 6,
                        "fouls": 3
                    },
                    "ae43bde4-253b-11eb-adc1-0242ac120002": {
                        "score": 27,
                        "fouls": 4
                    }
                },
                "clock": {
                    "main": "PT8M13S",
                    "shot": null,
                    "running": false
                },
                "timestamp": "2018-08-14T16:45:34.34"
        }
    

Bold fields are required

Field
Type
Description

sources

object

An object showing what data sources/types are available for this fixture.

sources.event

string

The status of an event data source. There could be many event sources, but this will show CONNECTED if at least 1 is connected. Options are CONNECTED, NOT_CONNECTED, NOT_AVAILABLE

sources.scoreboard

string

The status of a scoreboard data source. There could be many event sources, but this will show CONNECTED if at least 1 is connected. Options are CONNECTED, NOT_CONNECTED, NOT_AVAILABLE

status.fixture

string

The status of the fixture. Options are ABANDONED, CANCELLED, CONFIRMED, DELAYED, FINISHED, INTERRUPTED, PENDING, PROTESTED, IN_PROGRESS, WARM_UP, ON_PITCH, ABOUT_TO_START

status.period

string

The status of the period. Options are PENDING, IN_PROGRESS, FINISHED, CONFIRMED

status.options

object

Any extra information about the fixture status. Eg. The reason for a delay if fixture = DELAYED.

status.periodId

integer

The current periodId

entities

object

An object containing information about the competitors in this match. They keys are the entityIds.

entities.XXX.scores

string

The score for the particular entity

clock.XXX

object

Information about the current status of the clock. This information comes from the event data. If a scoreboard feed is avaialble, this should be used instead.

clock.main

string

The current time on the clock. ISO 8601 Duration format. PTmmMss.ccS

clock.shot

string

The current time on the shot clock. ISO 8601 Duration format. PTmmMss.ccS. If no shot clock is in use - then this will be null

clock.running

boolean

Is the clock currently running

timestamp

datetime

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

If a field has no value then the key/value will not be sent as part of the message.

Last updated

Was this helpful?