Live Data API

Access real-time milestone and progress data

Live Data API

The Live Data API provides access to real-time milestone and progress data for prediction markets. These endpoints relay data directly from the Kalshi API.

Access

from dflow import DFlowClient
 
client = DFlowClient()
live_data_api = client.live_data

Methods

get_live_data

Get live data for specific milestones.

def get_live_data(milestone_ids: list[str]) -> list[LiveData]

Parameters

ParameterTypeDescription
milestone_idslist[str]Array of milestone identifiers (max 100)

Example

data = client.live_data.get_live_data(["milestone-1", "milestone-2"])
for d in data:
    if d.milestones:
        print(f"{d.milestones[0].name}: {d.milestones[0].value}")

get_live_data_by_event

Get live data for an event by ticker.

def get_live_data_by_event(
    event_ticker: str,
    minimum_start_date: str | None = None,
    category: str | None = None,
    competition: str | None = None,
    source_id: str | None = None,
    type: str | None = None,
) -> LiveData

Parameters

ParameterTypeDescription
event_tickerstrThe event ticker
minimum_start_datestr | NoneMinimum start date (RFC3339 format)
categorystr | NoneFilter by milestone category
competitionstr | NoneFilter by competition
source_idstr | NoneFilter by source ID
typestr | NoneFilter by milestone type

Example

# Get all live data for an event
data = client.live_data.get_live_data_by_event("BTCD-25DEC0313")
 
# Filter by category
sports_data = client.live_data.get_live_data_by_event(
    "SPORTS-EVENT",
    category="sports",
    competition="NFL",
)

get_live_data_by_mint

Get live data for a market by mint address.

def get_live_data_by_mint(
    mint_address: str,
    minimum_start_date: str | None = None,
    category: str | None = None,
    competition: str | None = None,
    source_id: str | None = None,
    type: str | None = None,
) -> LiveData

Example

data = client.live_data.get_live_data_by_mint("EPjFWdd5...")
 
# With filters
filtered_data = client.live_data.get_live_data_by_mint(
    "EPjFWdd5...",
    type="price",
)

Types

LiveData

class LiveData(BaseModel):
    event_ticker: str | None
    milestones: list[Milestone] | None

Milestone

class Milestone(BaseModel):
    name: str
    value: Any
    timestamp: str | None

On this page