Get Events

get

https://api.matchbook.com/edge/rest/events

Get a list of events available on Matchbook ordered by start time.

API GROUP : EVENTS

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

offset

string

Defaults to 0

Used for paging. The offset of the first entry in the response.

per-page

string

Defaults to 20

Used for paging. The number of entries to return in a single response.

after

int64

A unix epoch timestamp. Only events starting after the timestamp will be returned.

before

int64

A unix epoch timestamp. Only events starting before the timestamp will be returned.

category-ids

string

A comma separated list of category ids. Only events on the provided categories are included in the response.

ids

string

A comma separated list of event ids. Only events with id in the provided list are included in the response.

sport-ids

string

A comma separated list of sport ids. Only events with sport in the provided list are included in the response.

states

string

Defaults to open,suspended,closed,graded

A comma separated list of event states. Only events with status in the provided list are included in the response. Allowed values: open, suspended, closed, graded.

tag-url-names

string

A comma separated list of url-names. Only events with tags having url-name in the provided list are included in the response.

exchange-type

string

Defaults to back-lay

Prices are returned in accordance with the specified exchange-type. Allowed values: back-lay, binary.

odds-type

string

Defaults to DECIMAL

Prices are returned in accordance with the specified odds-type. Allowed values: DECIMAL, US, HK, MALAY, INDO, %.

include-prices

boolean

Defaults to false

A boolean indicating whether to return the prices for the events.

price-depth

int32

Defaults to 3

Value indicating, for each runner, the maximum number of prices that will be returned in the response for each side.

price-mode

string

Defaults to expanded

Allowed values are: expanded, aggregated. With expanded all prices available on the runner are returned up to the defined price-depth. With aggregated at most three prices are returned. First and second are identical to the first two prices returned with by the expanded mode. Third price is an aggregation of the liquidity on the third and following layers calculated to optimise the liquidity displayed.

side

string

Only prices on the specified side are included in the response. Allowed values are: back, lay or win, lose. Both sides are returned if no side is specified.

currency

string

Prices are returned in the specified currency. Allowed values: USD, EUR, GBP, AUD, CAD. HKD

minimum-liquidity

double

Only prices with available-amount greater than or equal to this value are included in the response. The default is 2.

include-event-participants

boolean

Defaults to false

A boolean indicating whether to return the event participants information.

markets-limit

int32

The maximum number of markets to return for each event.

exclude-mirrored-prices

boolean

Defaults to false

A boolean indicating whether to return only the originator prices for binary markets (similar to non binary markets) or to include also mirrored prices.

Response

200200