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. 
const series = await client.series.list({
  active: true,
  limit: 20,
});

for (const s of series.series) {
  console.log(`${s.title} (${s.recurrence})`);
}

​
Parameters

ParameterTypeDescription
limitnumberMaximum results
offsetnumberPagination offset
slugstring[]Filter by slugs
activebooleanFilter by active status
closedbooleanFilter by closed status
archivedbooleanFilter by archived status
recurrencestringFilter by recurrence (daily, weekly, etc.)

​
Response Fields

FieldTypeDescription
idnumberUnique series identifier
slugstringURL-friendly identifier
titlestringSeries title
subtitlestringSeries subtitle
descriptionstringSeries description
seriesTypestringType of series
recurrencestringRecurrence pattern
activebooleanWhether series is active
volumestringTotal trading volume
liquiditystringCurrent liquidity

​
retrieve

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

console.log(`Title: ${series.title}`);
console.log(`Description: ${series.description}`);
console.log(`Recurrence: ${series.recurrence}`);