Skip to main content
The Series resource provides access to series information. Series group related events together (e.g., NFL games, election cycles, daily crypto markets).

​
Methods

MethodEndpointDescription
list(params?)GET /v1/seriesList all series
retrieve(id)GET /v1/series/id/{id}Get series by ID

​
list

Get a list of all series with optional filtering. 
series = client.series.list({
    "active": True,
    "limit": 20,
})

for s in series["series"]:
    print(f"{s['title']} ({s['recurrence']})")

​
Parameters

ParameterTypeDescription
limitintMaximum results
offsetintPagination offset
sluglist[str]Filter by slugs
activeboolFilter by active status
closedboolFilter by closed status
archivedboolFilter by archived status
recurrencestrFilter by recurrence (daily, weekly, etc.)

​
Response Fields

FieldTypeDescription
idintUnique series identifier
slugstrURL-friendly identifier
titlestrSeries title
subtitlestrSeries subtitle
descriptionstrSeries description
seriesTypestrType of series
recurrencestrRecurrence pattern
activeboolWhether series is active
volumestrTotal trading volume
liquiditystrCurrent liquidity

​
retrieve

Get a single series by ID. 
series = client.series.retrieve(123)

print(f"Title: {series['title']}")
print(f"Description: {series['description']}")
print(f"Recurrence: {series['recurrence']}")