Message

Modified on Tue, 01 Mar 2022 at 04:42 PM

The messages are structured as follows:

XML Example

<Message>
    <Header>
        ...
    </Header>
    <Body>
        ...
    </Body>
</Message>

Json Example

{
  "Message": {
    "Header": {
    ...
    },
    "Body": {
    ...
    }
  },
}

Header

The header consists of general information, which can be later used as a reference. It is structured as follows:

XML Example

<Header>
    <Type>2</Type>
    <MsgGuid>16c9746d-619e-4e42-b8e1-fb95251c3859</MsgGuid>
    <ServerTimestamp>1489578474</ServerTimestamp>
    <MsgSeq>1</MsgSeq>
</Header>

JSON Example

{
  "Header": {
    "Type": "2",
    "MsgGuid": "16c9746d-619e-4e42-b8e1-fb95251c3859",
    "ServerTimestamp": "1489578474",
    "MsgSeq": "1"
  },
}

Model

Element	Data Type	Description
Type	int	The type of the message
MsgGuid	guid	The unique GUID of the message
ServerTimestamp	long	Timestamp representing the current time of when the message was sent
MsgSeq	int	The message sequence. The sequence is not unique, it's a sequential per type of message. For example, every market has its own sequence, every livescore message has their own sequence, not related to market messages, every resulting message have their own sequence, etc.

Note: all timestamps are in UTC

Body

The body of the message holds all of the content. It is structured as follows:

XML Example

<Body>
    <Events>
        ...
    </Events>
    <Competition>
        ...
    </Competition>    
    <KeepAlive> 
        ...
    <KeepAlive>
</Body>

Json Example

{
  "Body": {
    "Events": {
    ...
    },
    "Competition": {
    ...
    },
    "KeepAlive": {
    ...
    }
  },
}

Model

Element	Data Type	Description
Events	Array	Array of Event
Competition	Array	An array of Competition - Relevant for Outright MessageTypes
KeepAlive	Array	An array of active events – all the events that are live at the moment