Skip to main content
GET
Python (SDK)

Overview

A base event is the top-level series (for example UNR for unemployment, HORC for House control). Under it sit the individual events — usually one per period or race — and under each event sit its contracts. This endpoint returns all three levels in one nested response.

Response shape

data.baseEvent carries the series, and data.events is an array where each entry has the same event + contracts shape returned by Get Event Contracts:

Display name and categories

displayName and categoryLevels come from the venue’s product listing, which is synced once a day.
  • displayName is the venue’s name for the series, such as US Unemployment Rate.
  • categoryLevels lists the venue’s categories, broadest first: category, subcategory, then region. For example, ["Elections", "United States House", "Arizona"] for an Arizona House race. A few base events have fewer than three levels.
Level names repeat under different parents (United States appears under several categories), so identify a category by its whole path, not by its last level. List Categories returns every category with its path, and search takes that path as category. Both fields are omitted for a base event the sync has not reached yet, so treat them as optional.
A long-running series can carry a large number of events, each with its own contracts. When you only need one period, call Get Event Contracts with that eventId instead, or narrow with search using the baseEventId filter.

Example

Errors

  • 400 — baseEventId missing or malformed
  • 404 — no base event with that ID
  • 500 — unexpected server error

Path Parameters

baseEventId
string
required
Example:

"UNR"

Response

Base event with nested events and contracts

Standard success envelope used by all success responses. data is endpoint-specific.

success
boolean
required
Example:

true

data
object