Skip to main content

Documentation Index

Fetch the complete documentation index at: https://pond.dflow.net/llms.txt

Use this file to discover all available pages before exploring further.

Work in progress. This page documents an evolving standard and is subject to change. The details object is passed through directly from Kalshi’s API and uses additionalProperties: true in the upstream spec, so it is a flexible key-value object rather than a strict schema. Field names and shapes can change as Kalshi updates their data. Validate field presence at runtime rather than relying on this reference being current. This page will be updated when the schema is finalized.

Common Fields

These fields can appear on any milestone type. Not every type populates every field.
FieldRequiredType
typeYesMilestoneType
widgetLiveTextYesstring
tileLiveTextYesstring
home_pointsYesnumber
away_pointsYesnumber
home_abbreviationYesstring
away_abbreviationYesstring
home_nameYesstring
away_nameYesstring
home_short_nameYesstring
away_short_nameYesstring
home_image_urlYesstring
home_image_url_lightNostring
home_image_url_darkNostring
home_secondary_image_urlNostring
away_image_urlYesstring
away_image_url_lightNostring
away_image_url_darkNostring
away_secondary_image_urlNostring
home_idYesstring
away_idYesstring
home_rankNonumber | string
away_rankNonumber | string
statusNo"none" | "live" | "finished"
postponedNoboolean
scheduledYesstring
roundNonumber
final_round_time_leftNostring
winnerNostring
home_is_firstNoboolean
  • home_is_first: Indicates whether the home team is the first one in the title (e.g., {home} at {away} when true, vs. {away} at {home} when false). Most professional sports list the away team first; college sports (along with a handful of others) list the home team first.
  • Compact scoreboard UI: Try home_name / away_name, home_short_name / away_short_name, and home_abbreviation / away_abbreviation in order of decreasing length. These fields are sourced from Sportradar and may not always be set; some players and teams don’t have an abbreviation.

Football

FieldRequiredType
legNostring
possessionNo"home" | "away"
last_playYesstring
sub_titleYesstring

Soccer

FieldRequiredType
aggregate_textNostring
show_penaltiesNoboolean
home_penaltiesNostring[]
away_penaltiesNostring[]
home_penalties_scoreNonumber
away_penalties_scoreNonumber
home_significant_eventsNoSoccerSignificantEvent[]
away_significant_eventsNoSoccerSignificantEvent[]

Tennis

FieldRequiredType
advantageNostring
serverNostring
home_current_round_scoreNostring
home_seedNonumber
home_round_scoresNoTennisRoundScores[]
home_tennis_statisticsNoTennisPlayerStatistics
home_countryNostring
away_current_round_scoreNostring
away_seedNonumber
away_round_scoresNoTennisRoundScores[]
away_tennis_statisticsNoTennisPlayerStatistics
away_countryNostring
  • Tennis scoring: home_points / away_points are not the canonical scores in tennis. Sets won is derived from home_round_scores / away_round_scores by counting entries where outcome === 'winner'. The live in-game point score is home_current_round_score / away_current_round_score, returned as raw 0 / 1 / 2 / 3 and mapped to "0" / "15" / "30" / "40" client-side; advantage disambiguates 40-40 and onward. Per-set history is exactly what home_round_scores and away_round_scores carry.

Esports

FieldRequiredType
home_game_scoresNoEsportsGameScore[]
away_game_scoresNoEsportsGameScore[]
esportsRoundBasedNoboolean
esportsHasLiveGameDataNoboolean
formatNostring
currentGameDurationSecondsNonumber
playerStatsNoEsportsPlayerStats
seriesStatsNoEsportsSeriesStats

Golf

FieldRequiredType
leaderboardNoMilestoneLeaderboardVo[]

MMA

FieldRequiredType
methodOfVictoryNostring
fightLengthYesnumber

Racing

FieldRequiredType
completedLapsNonumber
totalLapsNonumber
weatherNostring
substatusNostring
airTemperatureNonumber
humidityNonumber

Rugby / AFL

FieldRequiredType
score_breakdown_labelsNostring[]
home_score_breakdownNonumber[]
away_score_breakdownNonumber[]

Baseball

FieldRequiredType
ballsNonumber
strikesNonumber
outsNonumber
inningNonumber
inning_halfNonumber

Cricket

FieldRequiredType
battingNo"home" | "away" | "innings_break"
home_oversNonumber
away_oversNonumber
home_wicketsNonumber
away_wicketsNonumber

Let’s stay in touch

https://mintcdn.com/dflow/a8Yx7HBusmKl4Z7w/images/meteor-icons_telegram.svg?fit=max&auto=format&n=a8Yx7HBusmKl4Z7w&q=85&s=e928c5dd68311ff0d419936a35c86eed

Dev Notifications

Join the DFlow Dev Notifications Telegram group to stay in the loop on new features and other announcements.