events

Retrieve events that are available on Smarkets to bet on.

Changed on

Description

Events in Smarkets follow a tree structure per sport, where events can have several child events, but only one parent event.<br> As an example for football, we have:<ul>

<li>The root event which is the sport - Football <li>Child events which are leagues - Premier League, La Liga, etc <li>Grandchild events which are football matches - Man U vs Chelsea, ... </ul><br> <p>In the case of most sports, we have 3 levels in the tree. However, there are cases where we can have a different number.</p> <p>To identify whether an event is a leaf node in this tree, one can look at the bettable flag.</p> <p>Only leaf events can have markets, which in turn will have contracts.</p>

Rate limits

Maximum 600 requests per 60 seconds<br>

get/v3/events/

Request

Query parameters

idstring[]

Event IDs to filter by

[
  "565413"
]
inplay_enabledboolean

True if trading will be open when the markets go live in-play

statestring[]

Event states to filter by

[
  "new"
]
typestring[]

Event types to filter by

type_domainstring[]

Allows filtering by 'domains' - a feature of the new, improved typing system for events.<br> The domain of an event denotes the category of events this event belongs to. In most cases this will be the sport (football, tennis, golf, etc) but for non-sports the domain could be politics, tv_and_entertainment, to mention some examples. If you want to use this, you might also want to opt into the new typing system (see with_new_type).

type_scopestring[]

Allows filtering by 'scopes' - a feature of the new, improved typing system for events.<br> The scope of an event denotes the kind of event you want, potential values include single_event (your typical football match, horse race, political event), outright (an event who's outcome spans multiple events), acca (an accumulator), etc.<br> If you want to use this, you might also want to opt into the new typing system (see with_new_type).

with_new_typeboolean

Enables a new, improved typing system for events.<br> If this flag is set to true, the format of the type field in the event response will change.<br> Users of the API are urged to make use of the new typing system, as the old typing system will be deprecated in the next version of the API.

parent_idstring[]

Filter by events with these parent IDs

[
  "565413"
]
start_datetime_minstring date-time

When the event is scheduled to go live

start_datetime_maxstring date-time

When the event is scheduled to go live

last_modified_minstring date-time

The timestamp when any of the properties of the event was last modified

last_modified_maxstring date-time

The timestamp when any of the properties of the event was last modified

pagination_last_display_orderinteger

Display order for the last event of the previous page.<br> This parameter should be used in conjunction with sorting by display_order,...

pagination_last_start_datetimestring date-time

Start datetime for the last event of the previous page.<br> This parameter should be used in conjunction with sorting by start_datetime

pagination_last_idstring

The last event id from the previous page, so we can retrieve the subsequent events.<br> This should be used in conjunction with sorting by id

pagination_last_namestring

The name of the last event from the previous page, so we can retrieve the subsequent events.<br> This should be used in conjunction with sorting by name

sort'display_order,start_datetime,name' | 'display_order,start_datetime,id' | 'start_datetime,name' | 'start_datetime,id' | 'id'

The sorting order for the resulting events.<br> It should be used in conjunction with pagination parameters.<br> The default and recommended sorting order and pagination is by event id.<br> The links to the next page returned on every request help clients navigate through all the relevant events

limitinteger

The number of events to retrieve in the API call.<br> Values above the effective per-caller-type page limit are silently reduced to that limit rather than rejected. The effective limit depends on the caller's authentication state (e.g. unauthenticated callers get a lower limit than authenticated members or API users), and these limits may be adjusted server-side without notice.

include_hiddenboolean

Choose to include in the response events that are not visible on the website. Hidden events may not be displayed for a varied number of reasons (for example the start date is too far away). Betting is not available for hidden events.

jurisdiction'CDG' | 'CFTC' | 'DGA' | 'IGC' | 'IRGC' | 'MGA' | 'SGA' | 'UKGC'

Jurisdiction of user

platform'exchange' | 'sbk'

Platform used by user

Response

Events success response

Example response

{
  "events": [
    {
      "bet_allowed": true,
      "bettable": true,
      "chart_time_period": "3w,2w*,1w",
      "created": "2017-12-16T00:16:25.936519Z",
      "description": "1 mile 7 furlongs 152 yards National Hunt",
      "display_order": 100,
      "end_date": "2017-12-21",
      "full_slug": "/sport/horse-racing/ascot/2017/12/22/15:40",
      "hidden": true,
      "id": "565413",
      "inplay_enabled": true,
      "modified": "2017-12-21T10:58:09.279148Z",
      "name": "15:40",
      "parent_id": "565413",
      "seo_description": "1 mile 7 furlongs 152 yards National Hunt",
      "short_name": "15:40 @ Ascot",
      "slug": "ascot-2017-12-22T00:00:00-15-40",
      "special_rules": "Additional contracts may be added",
      "start_date": "2017-12-21T10:58:09.279148Z",
      "start_datetime": "2017-12-21T10:58:09.279148Z",
      "state": "new",
      "super_sub_enabled": true,
      "type": "horse_racing_race",
      "venue": {
        "capacity": 60463,
        "city": "London",
        "country_code": "ENG",
        "country_name": "England",
        "latitude": 51.6042,
        "longitude": 0.0662,
        "name": "Tottenham Hotspur Stadium",
        "neutral": true
      }
    }
  ],
  "pagination": {
    "next_page": "?limit=20&sort=id&pagination_last_id=20"
  }
}

Changes