Get Offers

get

https://api.matchbook.com/edge/rest/v2/offers

Get the current unsettled offers. This can include offers in all statuses.

API GROUP : BETTING_READ

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Offer Statuses

Status	Description
open	The offer is available to be matched by other users.
cancelled	The offer has been cancelled by the user.
edited	The offer has been edited by the user but is still available to be matched by other users with the new values.
matched	The offer has been fully matched by one or more other users.
flushed	The offer has been flushed by the system and is no longer available to be matched by other users.

Query Params

offset

int64

Defaults to 0

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

per-page

int64

Defaults to 20

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

sport-ids

string

A comma separated list of sport ids. Only offers on those sports are included in the response.

event-ids

string

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

market-ids

string

A comma separated list of market ids. Only offers on the provided markets are included in the response.

runner-ids

string

A comma separated list of runner ids. Only offers on the provided runners are included in the response.

side

string

Only offers on the side are included in the response. Valid values are back, lay, win or lose.

status

string

A comma separated list of statuses. Only offers with one of the provided statuses are included in the response. Valid values are: open, cancelled, edited, flushed, matched and unmatched. Matched and unmatched are special values. Matched will return offers that are partially or fully matched. Unmatched will return offers that have got some amount of stake available to be matched i.e. offers that are open and edited.

interval

int32

Only include offers in the response that have been submitted or have changed within the specified number of seconds.

include-edits

boolean

Defaults to false

If true, the offers in the response will include the edits applied on them.

cancellation-reason

string

On cancelled offers specifies reason of cancellation. Valid values are: user_request and heartbeat_expiry.

aggregation-type

string

Defaults to none

Can be summary | average : if one of these two values is specified, offers will be returned in one of the aggregated modes. stake will be the total stake of all aggregated offers; each offer will have one and only one matched bet for the aggregated matched odds and the matched stake. The unmatched amount is under the remaining field of the offer and the unmatched odds are the offer main odds. There is no id field obviously but there is an ids field listing all actual aggreagated offer ids.

Response

Offer Statuses

200200