trading-feed.index [draft]
Resource information
URL | https://api.statscore.com/v2/trading-feed |
---|---|
Method | GET |
Description | Returns all important messages for trading purposes including following message types:
|
Cache | 0 seconds |
Authorization required | Yes |
Method parameters
Name | Type | Description |
---|---|---|
There are no method parameters in this resource |
Query parameters
Name | Type | Description |
---|---|---|
token | xsd:string | REQUIRED. More information concerning authorization in API introduction section |
page | xsd:int | Determines offset of paginated data. Default value is 1 which means first page. |
limit | xsd:int | Determines maximum number of returned records on page. Used in paginated data. Default value is 500. Possible values: 5, 10, 25, 50, 100, 250, 500 |
timestamp | xsd:unix_timestamp | Selection date, format UNIX_TIMESTAMP. Only messages that occurred or were updated after this timestamp will be returned. By default (if no parameter given) incidents from last 24 hours. |
timestamp_to | xsd:unix_timestamp | Selection date, format UNIX_TIMESTAMP. Only messages that occurred before this timestamp will be returned. |
sport_id | xsd:int | Identifier of the sport. Allows incidents for the selected sport to be filtered |
type | xsd:string | Determines type of message
|
object_id | xsd:int | REQUIRED if you set object_type attribute! Identifier of the object depends on object type, e.g. if you choose an event as an object_type you should use event identificator. The complete list of possible seasons can be retrieved using the API resource: seasons.index |
object_type | xsd:string | Possible object type:
|
betting_offer_id | xsd:int | Identifier of the betting_offer |
Method calling examples
Link | Description |
---|---|
https://api.statscore.com/v2/trading-feed.xml?token={{YOUR_TOKEN}} | Returns all important messages for trading purposes from the last 24 hours in XML format |
https://api.statscore.com/v2/trading-feed?token={{YOUR_TOKEN}} | Returns all important messages for trading purposes from the last 24 hours in JSON format |
https://api.statscore.com/v2/trading-feed.xml?token={{YOUR_TOKEN}}&sport_id=1 | Returns all important messages for trading purposes from the last 24 hours for basketball events |
Output elements
.trading-feed | |
---|---|
id | Unique identifier for the message |
type | Possible value:
|
source | Internal attribute, please dont use this attribute |
ut | Information about the date and time of when the message was created. Format UNIX_TIMESTAMP. |
..data | |
...bet_stop | node available only if message type is bet_stop |
object_id | Identifier of the object depends on object type, e.g. if you choose an event as an object_type you should use event identificator The complete list of possible seasons can be retrieved using the API resource: seasons.index The complete list of possible events can be retrieved using the API resource: events.index |
object_type | Possible object type:
|
action | Describes type of operation. For this message type, action attribute always has create value |
betting_offer_ids | List of betting offers identifiers separated by a comma (e.g. 123,234,321). Possibility to input multiple identifiers, separated by comma. If empty value ALL betting offers for specified object_id should be suspended or closed. |
betting_offer_status | The betting offers specified in betting_offer_ids attribute can receive following values:
|
...outcome_result | node available only if message type is outcome_result |
id | Identifier of the outcome |
betting_offer_id | Identifier of the betting_offer related with this outcome. The complete list of possible betting_offer can be retrieved using the API resource: betting-offers.index |
action | Describes type of operation for the outcome result. Possible values:
|
result | Describe result of the outcome. Possible values:
Possible empty value for outcomes yet to be settled. |
wrong_message_id | Identifier for the message which contains incorrect information. Available only when action attribute is update. For action insert it's empty value |
...betting_offer_rollback | node available only if message type is betting_offer_rollback |
id | Identifier of the betting offer |
action | Describes type of operation for the event. Possible values:
|
object_type | Possible object type:
|
object_id | Identifier of the object depends on object type, e.g. if you choose an event as an object_type you should use event identificator The complete list of possible seasons can be retrieved using the API resource: seasons.index The complete list of possible events can be retrieved using the API resource: events.index |
start_date | If specified it means a start date from which all bets made should be cancelled. |
end_date | If specified it means an end date to which all bets made should be cancelled. Possible empty value |