Skip to navigation
Predict REST APIEvent

List events

List Predict sports events with cursor pagination and optional topic, category, series, provider, time, update, and market-status filters in one request.

Query parameters

idslist of stringsOptional
Return only events with these ids. At most 100 unique ids may be supplied.
slugslist of stringsOptional
Return only events with these slugs. At most 100 unique slugs may be supplied.
sortstringOptional

Order by a timestamp and direction. Defaults to created_at:desc.

topicstringOptional
Topic slug. Omit to include all topics.
starts_afterdatetimeOptional
Excludes events starting at or before this time.
starts_beforedatetimeOptional
Excludes events starting at or after this time.
limitintegerOptional
Number of events to return. Defaults to 20 when omitted.
cursorstringOptional
Opaque cursor returned by the previous page.
statusenumOptional
Omit to include both active and settled events.
Allowed values:
categorystringOptional
Category slug. Omit to include all categories.
seriesstringOptional
Series slug. Omit to include all series.
updated_sincedatetimeOptional
Returns events updated at or after this time. Omit to include all updates.
providerstringOptional

Exact external identity in provider:id form. The first colon separates the provider name, so ids containing colons remain intact. Omit to include all providers. An unknown identity returns an empty page.

contest_statusenumOptional

Match/tournament state. Omit to include every event, including those with no contest row. A set value matches that label only.

Response

OK
datalist of objectsOptional
next_cursorstringOptional
Opaque pagination cursor returned by the previous page.

Errors

400
Bad Request Error
405
Method Not Allowed Error
500
Internal Server Error
503
Service Unavailable Error