Methods
| Method | Endpoint | Description |
|---|---|---|
list(params?) | GET /v1/events | List events with filtering |
retrieve(id) | GET /v1/events/{id} | Get event by ID |
retrieve_by_slug(slug) | GET /v1/events/slug/{slug} | Get event by URL slug |
list
Fetch a paginated list of events with optional filters.Parameters
| Parameter | Type | Description |
|---|---|---|
limit | int | Maximum results to return (default: 100) |
offset | int | Number of results to skip for pagination |
active | bool | Filter by active events |
closed | bool | Filter by closed events |
archived | bool | Filter by archived events |
featured | bool | Filter featured events only |
categories | list[str] | Filter by category slugs |
seriesId | list[int] | Filter by series IDs |
live | bool | Filter live sports events |
ended | bool | Filter ended sports events |
Response Fields
| Field | Type | Description |
|---|---|---|
id | int | Unique event identifier |
slug | str | URL-friendly identifier |
title | str | Event title |
description | str | Event description |
category | str | Primary category |
active | bool | Whether event is active for trading |
closed | bool | Whether event is closed |
markets | list | Associated markets |
retrieve
Get a single event by its numeric ID.Parameters
| Parameter | Type | Description |
|---|---|---|
id | int | Event ID |
retrieve_by_slug
Get an event by its URL slug. Useful when you have the slug from a URL or API response.Parameters
| Parameter | Type | Description |
|---|---|---|
slug | str | Event URL slug |
Sports Event Fields
Sports events include additional real-time data:| Field | Type | Description |
|---|---|---|
gameId | str | Sports provider game ID |
live | bool | Whether game is in progress |
ended | bool | Whether game has ended |
score | object | Current score |
period | str | Current period/quarter/half |
participants | list | Teams or players |