Table of Contents | ||
---|---|---|
|
...
The table below shows the messages that are delivered for each service offered.
Service | Fixture | MarketSet | ResultSet | Coverage | Match State |
Match Data | Yes | No | No | Optional | Yes |
PreMatch Manager | Yes | Yes | Yes | No | No |
InPlay Manager | Yes | Yes | Yes | Optional | Optional |
Anchor | ||||
---|---|---|---|---|
|
...
Code Block | ||
---|---|---|
| ||
<Header> <MessageGuid>c64c3a47-4f34-427c-ba67-3bc031208849</MessageGuid> <TimeStampUtc>2015-10-22T09:27:19.2654001Z</TimeStampUtc> <Retry>0</Retry> <CustomerId>6012</CustomerId> <MessageFixtureOrder>215</MessageFixtureOrder> </Header> |
Element | Type | Description |
---|---|---|
MessageGuid | GUID | A unique identifier for the message to allow discovery of the message within log files or services |
TimeStampUtc | DateTime | The time that the message was generated for despatch |
Retry | Integer | The number of times that delivery of this message has been attempted. This field will increment with each attempt; the TimeStampUtc field will not be updated for retries. |
CustomerId | Integer, optional | A unique identifier for the customer. Can be used to differentiate between service instances in a multi-channel system. Off by default; activated on request. |
MessageFixtureOrder | Integer, optional | A counter indicating the message order. |
Anchor | ||||
---|---|---|---|---|
|
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<Fixture> <Id>3474238</Id> <Name>Coin, J/Minella, M v Bertens, K/Larsson, J</Name> <FixtureType>Match</FixtureType> <Status>Scheduled</Status> <StartTimeUtc>2015-10-22T13:30:00Z</StartTimeUtc> <Sport> <Id>24</Id> <Name>Tennis</Name> </Sport> <Competition> <Id>5409</Id> <Name>BGL BNP Paribas Luxembourg Open Doubles</Name> <Region> <Id>239</Id> <Name>Luxembourg</Name> </Region> <Gender>Male</Gender> </Competition> <Season> <Id>48628</Id> <Name>BGL BNP Paribas Luxembourg Open Doubles 2015</Name> </Season> <Round> <Id>239363</Id> <Name>Quarterfinals</Name> </Round> <Competitors> <Competitor> <Id>840577</Id> <Name>Coin, J/Minella, M</Name> <HomeAway>Home</HomeAway> <Competitors> <Competitor> <Id>130569</Id> <Name>Coin, J</Name> <HomeAway>Home</HomeAway> <FirstName>Julie</FirstName> <LastName>Coin</LastName> </Competitor> <Competitor> <Id>131306</Id> <Name>Minella, M</Name> <HomeAway>Home</HomeAway> <FirstName>Mandy</FirstName> <LastName>Minella</LastName> </Competitor> </Competitors> </Competitor> <Competitor> <Id>130569</Id> <Name>Coin, J</Name> <HomeAway>Home</HomeAway> <FirstName>Julie</FirstName> <LastName>Coin</LastName> </Competitor> <Competitor> <Id>131306</Id> <Name>Minella, M</Name> <HomeAway>Home</HomeAway> <FirstName>Mandy</FirstName> <LastName>Minella</LastName> </Competitor> <Competitor> <Id>757045</Id> <Name>Bertens, K/Larsson, J</Name> <HomeAway>Away</HomeAway> <Competitors> <Competitor> <Id>561541</Id> <Name>Bertens, K</Name> <HomeAway>Away</HomeAway> <FirstName>Kiki</FirstName> <LastName>Bertens</LastName> </Competitor> <Competitor> <Id>131095</Id> <Name>Larsson, J</Name> <HomeAway>Away</HomeAway> <FirstName>Johanna</FirstName> <LastName>Larsson</LastName> </Competitor> </Competitors> </Competitor> <Competitor> <Id>561541</Id> <Name>Bertens, K</Name> <HomeAway>Away</HomeAway> <FirstName>Kiki</FirstName> <LastName>Bertens</LastName> </Competitor> <Competitor> <Id>131095</Id> <Name>Larsson, J</Name> <HomeAway>Away</HomeAway> <FirstName>Johanna</FirstName> <LastName>Larsson</LastName> </Competitor> </Competitors> </Fixture> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the fixture |
Name | String | The name of the fixture |
FixtureType | FixtureType | An Enum describing the type of fixture. Possible values: |
Status | FixtureStatus | An Enum describing the status of the fixture. Possible values: |
StartTimeUtc | DateTime | The start time of the fixture in UTC |
Sport | Sport | An object describing the sport within which the fixture is played |
Competition | Competition | An object describing the competition within which the fixture is played |
Season | Season | An object describing a season within a competition |
TourSeason | Season, optional | An object describing the tour within which the fixture is played, if applicable |
Round | Round, optional | An object describing a round within a season |
Venue | Venue, optional | An object describing the venue at which the fixture is played |
Competitors | Competitor | A collection of objects describing the competitors |
AggregateEventInfo | AggregateEventInfo, optional | An object that holds additional information about an aggregate event |
ExternalIds | Array of ExternalId | An object that holds Client fixture information in an array |
ExternalId | String, optional | An object that holds Client fixture information |
Source | String, optional | Customer's fixture Source ID, if available and required |
Id | String, optional | Customer's fixture ID, if available and required |
TennisProperties | TennisProperties, optional | An object containing information specific to a tennis match; no populated for sports other than tennis |
AssociationFixtureId | String, optional | Where appropriate, the fixture ID used to build a link to a fixture's streaming feed |
IsOff | Boolean, optional | Used only for horse races. False until the race has started, then True. |
ExternalIds
We can supply a fixture matching service. This can help if, for example, you wish to consume our in-play services and match our fixtures to those that might already exist within your trading platform. When the fixture matching service is active, the ExternalIds element will be populated with an array of your fixture IDs.
...
Code Block | ||
---|---|---|
| ||
<Sport> <Id>10</Id> <Name>Football</Name> </Sport> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the sport |
Name | String | The name of the sport |
Sport IDs and Names:
ID | Name |
17 | American Football |
2 | Australian Rules |
271554 | Badminton |
3 | Baseball |
4 | Basketball |
7950337 | Beach Volleyball |
5 | Boxing |
6 | Cricket |
7 | Cycling |
8 | Darts |
10915624 | eSports |
10 | Football |
491393 | Futsal |
6463040 | Gaelic Football |
12 | Golf |
99614 | Handball |
208627 | Hockey |
6463041 | Hurling |
15 | Ice Hockey |
300115 | Martial Arts/UFC |
16 | Motor Sport |
73743 | Rugby League |
73744 | Rugby Union |
22 | Snooker |
269467 | Table Tennis |
24 | Tennis |
91189 | Volleyball |
Competition
An object that describes a competition.
Code Block | ||
---|---|---|
| ||
<Competition> <Id>115</Id> <Name>Kategoria Superiore</Name> <Region> <Id>218</Id> <Name>Albania</Name> </Region> <Gender>Male</Gender> </Competition> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the competition |
Name | String | The name of the competition |
Region | Region | An object that describes the region within which the competition is held |
Gender | Gender, optional | An enum describing the gender of the competitors. Possible values: |
Region
An object that describes a region.
Code Block | ||
---|---|---|
| ||
<Region> <Id>218</Id> <Name>Albania</Name> </Region> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the region |
Name | String | The name of the region |
Season
An object that describes a season.
Code Block | ||
---|---|---|
| ||
<Season> <Id>46344</Id> <Name>Kategoria Superiore 2015-2016</Name> </Season> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the season |
Name | String | The name of the season |
Round
An object that describes a round.
Code Block | ||
---|---|---|
| ||
<Round> <Id>221896</Id> <Name>Round 7</Name> </Round> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the round |
Name | String | The name of the round |
Venue
An object that describes a venue.
Code Block | ||
---|---|---|
| ||
<Venue> <Id>1970</Id> <Name>Stadiumi Skënderbeu</Name> <Region> <Id>3181898</Id> <Name>Korçë</Name> </Region> </Venue> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the venue |
Name | String | The name of the venue |
Region | Region | An object that describes the region within which the venue is located |
Competitor
An object that describes a competitor. This can be a team or an individual player.
Code Block | ||
---|---|---|
| ||
<Competitor> <Id>127134</Id> <Name>KS Skënderbeu Korçë</Name> <HomeAway>Home</HomeAway> </Competitor> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the competitor |
Name | String | The name of the competitor |
CompetitorType | CompetitorType | An Enum describing the competitor type. Possible values: |
HomeAway | HomeAway, optional | An Enum describing the home or away status of the competitor. Possible values: |
Competitors | Competitor, optional | An array of competitors |
FirstName | String, optional | When the competitor is a player, this is the first name of the player |
LastName | String, optional | When the competitor is a player, this is the last name of the player |
SquadNumber | String, optional | In some sports, the player's squad number |
Position | String, optional | In some sports, a description of the player's position within the team |
Gender | Gender, optional | Indicator of a player's gender |
AgeCategory | String, optional | Not yet used. Describes the age of the competitors. Possible values include: |
ExternalId | String, optional | A customer's competitor ID, if available and required |
AggregateEventInfo
An object that describes a season.
Code Block | ||
---|---|---|
| ||
<AggregateEventInfo> <CurrentHomeTeamFirstLegScore>1</CurrentHomeTeamFirstLegScore> <CurrentAwayTeamFirstLegScore>0</CurrentAwayTeamFirstLegScore> </AggregateEventInfo> |
Element | Type | Description |
---|---|---|
CurrentHomeTeamFirstLegScore | Integer | The current home team's first leg score |
CurrentAwayTeamFirstLegScore | Integer | The current away team's first leg score |
BasketballProperties
An object that provides basketball-specific details for a basketball match.
Code Block | ||
---|---|---|
| ||
<BasketballProperties> <BasketballAssociation>FIBA</BasketballAssociation> </BasketballProperties> |
Element | Type | Description |
---|---|---|
BasketballAssociation | String | The name of the association under whose rules the fixture is to be played |
FootballProperties
An object that provides tennis-specific details for a football match.
Code Block | ||
---|---|---|
| ||
<FootballProperties> <ExtraTimeProperties/> <MatchDuration>PT1H30M</MatchDuration> <ExtraTimeDuration>PT30M</ExtraTimeDuration> </FootballProperties> |
Element | Type | Description |
---|---|---|
ExtraTimeProperties | FootballExtraTimeProperties | An object that describes how (and if) the fixture might go to extra time |
MatchDuration | Timespan | The scheduled duration of the fixture |
ExtraTimeDuration | Timespan | The scheduled duration of extra time, if played |
FootballExtraTimeProperties
...
Code Block | ||
---|---|---|
| ||
<ExtraTimeProperties> <IsExtraTime>True</IsExtraTime> <IsSecondLeg>True</IsSecondLeg> <FirstLegId>54876512</FirstLegId> <GoesStraightToPenalties>False</GoesStraightToPenalties> <AwayGoalsAfterNormalTime>True</AwayGoalsAfterNormalTime> <AwayGoalsAfterExtraTime>True</AwayGoalsAfterExtraTime> </ExtraTimeProperties> |
Element | Type | Description |
---|---|---|
IsExtraTime | Boolean | True if the fixture could go to extra time, False otherwise |
IsSecondLeg | Boolean | True if this is the second leg of a two leg match, False otherwise |
FirstLegId | Integer | The fixture ID of the first leg if this is the second leg of a two leg match |
GoesStraightToPenalties | Boolean | True if the fixture will go straight to penalties in the event of a full-time draw, False otherwise |
AwayGoalsAfterNormalTime | Boolean | True if the "Away Goal Rule" applies after normal time |
AwayGoalsAfterExtraTime | Boolean | True if the "Away Goal Rule" applies after Extra time |
TennisProperties
An object that provides tennis-specific details for a tennis match.
Code Block | ||
---|---|---|
| ||
<TennisProperties> <NumberOfSets>3</NumberOfSets> <FinalSet>TieBreak</FinalSet> <ScoringSystemForServiceGames>StandardAdvantage</ScoringSystemForServiceGames> <CourtSurface> Unset</CourtSurface> </TennisProperties> |
Element | Type | Description |
---|---|---|
NumberOfSets | Integer | The maximum number of sets to be played in the match |
FinalSet | FinalSet | An Enum describing the type of the final set of the match. Values: |
ScoringSystemForServiceGames | ScoringSystemForServiceGames | An Enum describing the scoring systemfor service (as opposed to Tie Break) games. Values: |
CourtSurface | CourtSurface | An Enum describing the court surface upon which the match is to be played. Values: |
Anchor | ||||
---|---|---|---|---|
|
...
Code Block | ||
---|---|---|
| ||
<MarketSet> <FixtureId>3476056</FixtureId> <Markets> ... Markets truncated for readability </Markets> </MarketSet> |
Element | Type | Description |
---|---|---|
FixtureId | Integer | An immutable identifier for a fixture |
Markets | Market | An array of market objects, each describing a market within the identified fixture |
Market
An object that describes a market.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<Market> <Id>100013200</Id> <Sequence>0</Sequence> <TradingStatus>Open</TradingStatus> <Name>Match Result</Name> <ExpiryUtc>2016-04-29T09:35:00Z</ExpiryUtc> <MarketType> <Id>322</Id> <Name>Match</Name> <IsHandicap>false</IsHandicap> </MarketType> <InPlay>true</InPlay> <Selections> <Selection> <Id>300053291</Id> <TradingStatus>Trading</TradingStatus> <Name>Schwartzman, DS</Name> <CompetitorId>567116</CompetitorId> <Outcome> <Id>25</Id> <Name>Player 1</Name> </Outcome> <Numerator>47</Numerator> <Denominator>50</Denominator> <Decimal>1.94</Decimal> <Probability>0.49278</Probability> </Selection> <Selection> <Id>300053292</Id> <TradingStatus>Trading</TradingStatus> <Name>Dzumhur, D</Name> <CompetitorId>700304</CompetitorId> <Outcome> <Id>26</Id> <Name>Player 2</Name> </Outcome> <Numerator>87</Numerator> <Denominator>100</Denominator> <Decimal>1.87</Decimal> <Probability>0.50722/Probability> </Selection> </Selections> <CashOutStatus>Closed</CashOutStatus> </Market> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for a market |
Sequence | Integer, optional | The sequence number for an InPlay market |
TradingStatus | MarketStatus | An enum that describes the trading status of the market. Possible values: |
Name | String | The name of the market |
ExpiryUtc | DateTime | The time that the market expires |
Handicap | Decimal, optional | For handicap markets, the handicap line |
MarketType | MarketType | An object that describes the market's type |
InPlay | Boolean | True if the market contains an in-play price, False if the market contains a pre-match price |
Selections | Selection | An array of Selection objects |
ExternalId | String, optional | A customer's market ID, if available and required |
CashOutStatus | CashOutStatus, optional | Optional feature, off by default. An enum that describes the cash-out status of the market: |
EachWayTerm | EachWayTerm, optional | For horse racing only, an object that describes the market's each way terms |
MarketType
An object that describes the type of a market.
Code Block | ||
---|---|---|
| ||
<MarketType> <Id>82</Id> <Name>Asian Handicap</Name> <IsHandicap>true</IsHandicap> </MarketType> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the market type |
Name | String | The name of the market type |
IsHandicap | Boolean | True if the market type has a handicap, False otherwise |
Selection
An object that describes a selection.
Code Block | ||
---|---|---|
| ||
<Selection> <Id>300053292</Id> <TradingStatus>Trading</TradingStatus> <Name>Dzumhur, D</Name> <CompetitorId>700304</CompetitorId> <Outcome> <Id>26</Id> <Name>Player 2</Name> </Outcome> <Numerator>87</Numerator> <Denominator>100</Denominator> <Decimal>1.87</Decimal> <Probability>0.50721</Probability> </Selection> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the market type |
TradingStatus | SelectionStatus | An Enum describing the trading state of the selection. Possible values: |
Name | String | The name of the market type |
CompetitorId | Integer, optional | The ID of the competitor if the selection is a competitor within the parent fixture |
Outcome | Outcome, optional | An object describing the selection's outcome type |
Range | Range, optional | An object describing the range of outcomes for which the selection is a winner |
Numerator | Integer | The numerator of the price of the selection |
Denominator | Integer | The denominator of the price of the selection |
Decimal | Decimal | The price of the selection in decimal format |
Probability | Decimal, optional | The probability of the selection. Off by default, activated on request. |
ExternalId | String, optional | A customer's market ID, if available and required |
Outcome
An object that describes the outcome type of a selection.
Code Block | ||
---|---|---|
| ||
<Outcome> <Id>2</Id> <Name>Draw</Name> </Outcome> |
Element | Type | Description |
---|---|---|
Id | Integer | An immutable identifier for the outcome type |
Name | String | The name of the outcome type |
A list of outcome types can be found in Appendix A
...
Code Block | ||
---|---|---|
| ||
<Range> <High>0.0</High> <Low>2.0</Low> </Range> |
Element | Type | Description |
---|---|---|
High | Decimal, optional | The high value of a range |
Low | Decimal, optional | The low value of a range |
EachWayTerm
For horse racing markets only, an object that describes the market's each way terms.
Code Block | ||
---|---|---|
| ||
<EachWayTerm> <Places>5</Places> <Numerator>1</Numerator> <Denominator>2</Denominator> </EachWayTerm> |
Element | Type | Description |
---|---|---|
Places | Integer | The number of places over which each-way terms are to be applied |
Numerator | Integer | Numerator of fraction of odds to be applied for each-way terms |
Denominator | Integer | Denominator of fraction of odds to be applied for each-way terms |
Sequence Number – Football and Basketball
...
For Point Markets there are also two options but the point number is also taken into account. This is done by adding 1000000 times the point number to the game sequence number.
The following table illustrates how that works:
Market | Sequence Number | Example | |
11328 | Current Service Game Point Winner (Game, Point) | Game + (1000000 * Point)
| (Game, Point) (Game 3, Point 2)
|
11329 | Next Service Game Point Winner (Game, Point) | ||
11335 | Numbered Service Game Point Winner (Game, Point) | ||
11336 | Current Service Game Point Winner (Set, Game, Point) | Set + (Game*1000) + (Point * 1000000)
| (Set2, Game 3, Point 4)
|
11337 | Next Service Game Point Winner (Set, Game, Point) | ||
11340 | Numbered Service Game Point Winner (Set, Game, Point) |
Current, Next and Numbered Market Type Variants
...
Code Block | ||
---|---|---|
| ||
<ResultSet> <FixtureId>3474167</FixtureId> <Results> <MarketResult> ... Markets truncated for readability </MarketResult> </Results> |
Element | Type | Description |
---|---|---|
FixtureId | Integer | An immutable identifier for a fixture |
Results | MarketResult | An array of market result objects, each describing the outcome of a market within the identified fixture |
MarketResult
An object that describes a result for a market.
Code Block | ||
---|---|---|
| ||
<MarketResult> <MarketId>100001358</MarketId> <MarketSequence>14</MarketSequence> <Results> <SelectionResult> <AdditionalResultData i:nil="true" /> <ResultStatus>Loser</ResultStatus> <SelectionId>300002810</SelectionId> </SelectionResult> <SelectionResult> <AdditionalResultData i:nil="true" /> <ResultStatus>Winner</ResultStatus> <SelectionId>300002811</SelectionId> </SelectionResult> </Results> <MarketResultScore> <First>0</First> <Second>1</Second> <MarketResultScore> </MarketResult> |
Element | Type | Description |
---|---|---|
MarketId | Integer | The identifier of the market to which this result applies |
MarketSequence | Integer, optional | For an in-play market, the sequence number being resulted |
Results | SelectionResult | An array of selection result objects |
SelectionResult
An object that describes the outcome of a selection.
Code Block | ||
---|---|---|
| ||
<SelectionResult> <AdditionalResultData i:nil="true" /> <ResultStatus>Loser</ResultStatus> <SelectionId>300002810</SelectionId> </SelectionResult> |
Element | Type | Description |
---|---|---|
SelectionId | Integer | The identifier of the selection to which this result applies |
ResultStatus | ResultStatus | An Enum that describes the selection's outcomes. Possible values: |
AdditionalResultData | AdditonalResultData, optional | Contains additional information that may be required to result some selections where the outcome isn't win/lose. |
AdditionalResultData
An object that contains additional data necessary to settle bets placed on a selection where Selection.ResultStatus is either Placed or Partial.
Code Block | ||
---|---|---|
| ||
<AdditionalResultData> <PercentageWin>50.0</PercentageWin> <PercentagePush>50.0</PercentagePush> <Place>0</Place> <CountInPlace>0</CountInPlace> </AdditionalResultData> |
Element | Type | Description |
---|---|---|
PercentageWin | Integer | A number that describes what proportion of the bet should be paid |
PercentagePush | ResultStatus | A number that describes what proportion of the bet should be pushed |
Place | Integer | The placed position of the selection |
CountInPlace | Integer | The counted place position of the selection |
MarketResultScore
An optional object that will provide you with event scores through select market type resulting messages for both Prematch and Inplay Manager.
Code Block | ||
---|---|---|
| ||
<MarketResultScore> <First>0</First> <Second>1</Second> <MarketResultScore> |
Element | Type | Description |
---|---|---|
First | Integer | A number describing the first or Home selection score |
Second | Integer | A number describing the second or Away selection score |
Sports and markets that currently include this object are displayed by the following table. Each market includes the score at the resulting time, so as an example, Half Time Result provides the score at the end of the first half whilst Match Result includes the full-time score.
Sport | Market Id | Market Name | PreMatch | InPlay |
Football | 2 | Match Result | Yes | Yes |
Football | 6832 | Half Time Result | Yes | Yes |
Football | 7591 | 2nd Half Result | Yes |
|
Football | 10502 | Result At Extra Time Half-time (including normal time goals) |
| Yes |
Football | 10986 | Extra Time Half Time Result (excluding normal time goals) |
| Yes |
Football | 10498 | Match Result After extra time (including normal time goals) |
| Yes |
Football | 10982 | Extra Time Result (excluding normal time goals) |
| Yes |
Basketball | 306 | Match Result (excluding overtime) | Yes | Yes |
Basketball | 5 | Half-Time Result | Yes | Yes |
Basketball | 6950 | First-Quarter Result | Yes | Yes |
Basketball | 9766 | Second-Quarter Result |
| Yes |
Basketball | 9767 | Third-Quarter Result |
| Yes |
Basketball | 9768 | Fourth-Quarter Result |
| Yes |
Additional sports are scheduled to be equipped with the MarketResultScore element. Please contact Genius Sports Support for further information.
...
Code Block | ||
---|---|---|
| ||
<Coverage> <FixtureId>3025747</FixtureId> <ExternalFixtureIdi:nil="true" /> <IsBooked>true</IsBooked> <AvailableFeeds> ... </AvailableFeeds> </CoverageCommand> |
Element | Type | Description |
---|---|---|
FixtureId | Int | An immutable identifier for the fixture |
ExternalFixtureId | String, optional | Customer's fixture ID, if available and required |
IsBooked | Boolean | True if you have booked the fixture, false otherwise |
AvailableFeeds | Feed | An array of objects describing the feeds available for this fixture. |
Feeds
An object that describes a data feed in a fixture.
Code Block | ||
---|---|---|
| ||
<Feed> <IsLicensed>true</IsLicensed> <Type>MatchState</Type> </Feed> |
Element | Type | Description |
---|---|---|
IsLicensed | Boolean | True if you are licensed to receive data from this feed for this fixture, false otherwise. |
Type | String | A description of the feed. |