Events API
The Events API provides access to event information and search functionality.Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/events | Get all events with filtering |
GET | /v1/events/{id} | Get event by ID |
GET | /v1/events/slug/{slug} | Get event by slug |
GET | /v1/partners/{partnerKey}/events/{externalId} | Get partner event by external ID |
Key Event Fields
| Field | Description |
|---|---|
id | Unique event identifier |
slug | URL-friendly identifier |
title | Event title |
description | Event description |
category | Event category |
subcategory | Event subcategory |
active | Whether event is active |
closed | Whether event is closed |
archived | Whether event is archived |
Sports Event Fields
| Field | Description |
|---|---|
gameId | Sports provider game ID |
sportradarGameId | Sportradar game ID |
score | Current event score |
period | Current period |
live | Whether event is live |
ended | Whether event has ended |
eventState | Detailed event state information |
participants | Event participants (teams/players) |
Volume & Liquidity
| Field | Description |
|---|---|
liquidity | Event liquidity |
volume | Total trading volume |
volume24hr | 24-hour volume |
volume1wk | 7-day volume |
volume1mo | 30-day volume |
Filtering Events
Query events with various filters:Common Filters
| Parameter | Type | Description |
|---|---|---|
active | boolean | Filter by active status |
closed | boolean | Filter by closed status |
archived | boolean | Filter by archived status |
featured | boolean | Filter featured events |
categories | array | Filter by categories |
seriesId | array | Filter by series IDs |
gameId | integer | Filter by game ID |
ended | boolean | Filter by ended status |
live | boolean | Filter live events |
Date Filters
| Parameter | Type | Description |
|---|---|---|
startDateMin | string | Minimum start date |
startDateMax | string | Maximum start date |
startTimeMin | string | Minimum start time |
startTimeMax | string | Maximum start time |
eventDate | string | Specific event date |
eventWeek | integer | Event week number |
Partner Events
Retrieve an event using a partner’s external ID:Path Parameters
| Parameter | Type | Description |
|---|---|---|
partnerKey | string | Partner key identifier |
externalId | string | Partner’s external event ID |