Series API

The Series API provides access to series information. Series are templates for recurring events, grouping related events together (e.g., all Bitcoin price events, all election events).

Access

const dflow = new DFlowClient();
const series = dflow.series;

Methods

getSeries

Get all available series templates with optional filters.

// Get all series
const allSeries = await dflow.series.getSeries();
 
for (const s of allSeries) {
  console.log(`${s.ticker}: ${s.title}`);
}
 
// Filter by category
const politicsSeries = await dflow.series.getSeries({
  category: 'Politics',
});
 
// Filter by tags
const cryptoSeries = await dflow.series.getSeries({
  tags: 'crypto,bitcoin',
});
 
// Get only initialized series
const initialized = await dflow.series.getSeries({
  isInitialized: true,
});

Parameters:

Name	Type	Required	Description
`category`	`string`	No	Filter by category (e.g., Politics, Economics, Entertainment)
`tags`	`string`	No	Filter by tags (comma-separated list)
`isInitialized`	`boolean`	No	Filter series that are initialized (have a market ledger)
`status`	`MarketStatus`	No	Filter series by market status

Returns: Series[]

getSeriesByTicker

Get a specific series by ticker.

const series = await dflow.series.getSeriesByTicker('KXBTC');
 
console.log(`Title: ${series.title}`);
console.log(`Category: ${series.category}`);
console.log(`Tags: ${series.tags.join(', ')}`);

Series Object

interface Series {
  ticker: string;
  title: string;
  description?: string;
  category?: string;
  frequency?: string;
  tags?: string[];
}

Examples

List All Series

const allSeries = await dflow.series.getSeries();
 
console.log(`Found ${allSeries.length} series:\n`);
 
for (const series of allSeries) {
  console.log(`📊 ${series.title}`);
  console.log(`   Ticker: ${series.ticker}`);
  if (series.category) {
    console.log(`   Category: ${series.category}`);
  }
  console.log('');
}

Get Events for a Series

// First, get the series
const series = await dflow.series.getSeriesByTicker('KXBTC');
console.log(`Series: ${series.title}`);
 
// Then get events in this series
const events = await dflow.events.getEvents({
  seriesTicker: series.ticker,
  status: 'active',
});
 
console.log(`\nActive events in ${series.ticker}:`);
for (const event of events.events) {
  console.log(`  - ${event.title}`);
}

Get Markets by Series

const markets = await dflow.markets.getMarkets({
  seriesTicker: 'KXBTC',
  status: 'active',
});
 
console.log(`Found ${markets.markets.length} active markets in KXBTC series`);

Series API

On this page