API Explorer for Genius Ably Push Feeds
- 1 Introduction
- 2 Using the APIs to Receive Messages
- 3 Authenticating against Genius Sports APIs
- 4 Sport-specific Match State Platform APIs
- 4.1 Description
- 4.2 Channel Naming
- 4.3 Message Contracts
- 4.4 Available Sources
- 5 Match Statistics API
- 5.1 Description
- 5.2 Channel Naming
- 5.3 Message Contracts
- 5.4 Available Sources
Introduction
This page lists the APIs available for access via the https://geniussports.atlassian.net/wiki/spaces/BID/pages/3990454301. Match State Platform APIs power Genius Ably Push Feeds. OpenAPI Specification of all of them is available at Match State Platform APIs Swagger UI. Match State Platform Access Control API exposes endpoints that allow getting access to live Genius Ably Push feeds.
Using the APIs to Receive Messages
In order to subscribe to an Ably channel and receive messages you need to obtain:
An Ably Access token
An Ably Channel name
Both of these are provided by an https://geniussports.atlassian.net/wiki/spaces/BID/pages/3990454771 . The URL for the service to use is provided in the relevant section below for each message.
For more details about how to connect to Ably see https://geniussports.atlassian.net/wiki/spaces/BID/pages/3990454301 .
Channel naming conventions are explained below, but clients should use the channel name provided by the .
Authenticating against Genius Sports APIs
In order to authenticate against Genius Sports Match State Platform APIs and Match Statistics API, see Authenticating against Genius Sports APIs.
Sport-specific Match State Platform APIs
Description
Provides a feed of live match data for fixtures, including updates during the game.
Channel Naming
The Ably channel name takes the following format, where the variables included in the parentheses {} are substituted with appropriate values according to the table below.
match-state:{sportName}:{versionNumber}:{fixtureId}:{sourceId}
e.g. match-state:AmericanFootball:v1:123456:GeniusPremium
Channel Variable | Example Value | Description |
| “v1” | The version of the contract (see Message Contracts below). |
| “AmericanFootball” | The name of the sport included in the message. |
| “123456” | The id of the fixture to which the data in the message is associated. |
| “GeniusPremium” | The id of the source from where the data came from (see Available Sources below). |
See for an example of how to obtain the fixture id.
Message Contracts
The following message formats are supported:
Sport | Contract name | Contract Version | Contract Documentation |
|---|---|---|---|
American Football | Match State | v1 | |
v2 | |||
Match Events | v1 | ||
v2 | |||
Telemetry | v1 | ||
Volleyball | Match State | v1 | |
Football (Soccer) | Match State | v1 | |
Match Events | v1 |
Available Sources
Sport | Source Id | Description | Contract | Supported Environments | Message Rate | Message Size |
|---|---|---|---|---|---|---|
American Football
| GeniusPremium | Low latency feed from Genius Sports. Powered by NFL official data when available. High data points granularity. Intended for applications where very low latency is critical. Must not be used for public facing representations of live data. | V1 V2 | UAT, Production | Max 2 messages per-second | Up to 800 kB |
GeniusPremiumReplay | Test feed with replayable historic matches. This is intended to aid the integration process by providing historic matches with all the necessary action points. | V1 V2 | UAT | Max 2 messages per-second | Up to 800 kB | |
GeniusSportsInPlay | Low latency redundant feed from Genius Sports. Intended to be used when main GeniusPremium feed is not functioning as expected. | V2 | UAT, Production | Max 2 messages per-second | Up to 500 kB | |
GeniusLiveStats | Low latency feed from Genius Sports. Powered by in house collection tool. High data points granularity. Intended for applications where very low latency is critical. Must not be used for public facing representations of live data. *Available for CFL only. | V2 | UAT, Production | Max 2 messages per-second | Up to 800 kB | |
GeniusLiveStatsTest | Test feed available for CFL only. *No replayable historic matches available | V2 | UAT, Production | Max 2 messages per-second | Up to 800 kB | |
Volleyball | GeniusSportsItaly |
| V1 |
|
|
|
Football | GeniusSportsInPlay, GeniusSportsInPlay2 | Low latency rich and detailed feed from Genius Sports. Powered by Genius Sports data collection engines. Intended for applications where very low latency is critical. Must not be used for public facing representations of live data. | V1 | UAT, Production | Max 2 messages per-second | Up to 500 kB |
Match Statistics API
Description
The Match Statistics API provides live statistical information about a particular match such as the proportion of field goals that were successfully made.
Channel Naming
The Ably channel name takes the following format, where the variables included in the parentheses {} are substituted with appropriate values according to the table below.
live-statistics:AmericanFootball:{versionNumber}:{fixtureId}:{sourceId}
e.g. "live-statistics:v1:17:296:123456:NFL"
Channel Variable | Example Value | Description |
| “v1” | The version of the contract (see Message Contracts below). |
| “AmericanFootball” | The id of the sport included in the message. |
| “123456” | The id of the fixture to which the data in the message is associated. |
| “GeniusPremium” | The id of the source from where the data came from (see Available Sources below). |
See for an example of how to obtain the sport/competition/fixture ids for a fixture.
Message Contracts
The following message formats are supported:
Sport | Contract name | Contract Version | Contract Documentation |
|---|---|---|---|
American Football | Statistics | v1 |
Available Sources
Sport | Source Id | Description | Contract | Supported Environments | Message Rate | Message Size |
|---|---|---|---|---|---|---|
American Football | GeniusPremium | Low latency feed from Genius Sports. Powered by NFL official data when available. Intended for applications where very low latency is critical. Must not be used for public facing representations of live data. | V1 | UAT, Production | Max 2 messages per-second | Up to 800 kB |
GeniusPremiumReplay | Test feed with replayable historic matches. This is intended to aid the integration process by providing historic matches with all the necessary action points. | V1 | UAT, Production | Max 2 messages per-second | Up to 800 kB |