Events API

The Events API provides access to event information. For search, see the Search API.

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)

Crypto Event Fields

Crypto price events have no participants or game state. Use these fields instead:

Field	Description
`seriesSlug`	Asset, family and cadence, e.g. `btc-updown-15m`, `btc-strike-daily`, `btc-range-hourly`, `btc-hit-monthly`
`tags`	Taxonomy tags such as `crypto`, `crypto-prices`, `recurring`, the family (`up-or-down`, `multi-strikes`, `neg-risk`, `hit-price`), the window (`15M`, `1H`, `daily`, `weekly`, `monthly`) and the asset (`bitcoin`)
`markets[].assetPriceTerms`	Typed terms of each leg; see Asset Price Market Fields

An Up/Down event holds one market per window; a ladder event holds one market per strike or bucket.

Gold and Silver Event Fields

Gold and silver price events have the same shape as crypto Up/Down events: one market per window, no participants and no game state.

Field	Description
`category`	`finance`
`seriesSlug`	Metal, family and cadence: `gold-updown-15m`, `gold-updown-1h`, `gold-updown-1d`, `silver-updown-15m`, `silver-updown-1h`, `silver-updown-1d`
`tags`	Taxonomy tags such as `commodities`, `metals`, `recurring`, `up-or-down`, the window (`15M`, `1H`, `daily`), the metal (`gold` or `silver`), and `daily-close` on daily windows
`markets[].assetPriceTerms`	Typed terms of the window, with `asset.assetClass` `ASSET_CLASS_COMMODITY`; see Asset Price Market Fields

See Metals Schema for the Institutional fields and the trading hours.

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:

GET /v1/events?active=true&categories=sports&limit=50

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:

GET /v1/partners/{partnerKey}/events/{externalId}

Path Parameters

Parameter	Type	Description
`partnerKey`	string	Partner key identifier
`externalId`	string	Partner’s external event ID

Getting Started

Orders

Combos

RFQs

Portfolio

Events

Markets

Asset Prices

Series

Sports

Sports (Legacy)

Tags

Search

Incentives

Events API Overview

Events API

Endpoints

Key Event Fields

Sports Event Fields

Crypto Event Fields

Gold and Silver Event Fields

Volume & Liquidity

Filtering Events

Common Filters

Date Filters

Partner Events

Path Parameters

​Events API

​Endpoints

​Key Event Fields

​Sports Event Fields

​Crypto Event Fields

​Gold and Silver Event Fields

​Volume & Liquidity

​Filtering Events

​Common Filters

​Date Filters

​Partner Events

​Path Parameters

Events API

Endpoints

Key Event Fields

Sports Event Fields

Crypto Event Fields

Gold and Silver Event Fields

Volume & Liquidity

Filtering Events

Common Filters

Date Filters

Partner Events

Path Parameters