v3

OpenAPI 3.0.02026-07-31103181312.8 KB
milestone

Get Milestones

Minimum start date to filter milestones. Format: RFC3339 timestamp

get/milestones

Query parameters

limitinteger required

Number of milestones to return per page

minimum_start_datestring date-time

Minimum start date to filter milestones. Format RFC3339 timestamp

categorystring
Example:Sports

Filter by milestone category. E.g. Sports, Elections, Esports, Crypto.

competitionstring
Example:Pro Football

Filter by competition. E.g. Pro Football, Pro Basketball (M), Pro Baseball, Pro Hockey, College Football.

source_idstring

Filter by source id

typestring
Example:football_game

Filter by milestone type. E.g. football_game, basketball_game, soccer_tournament_multi_leg, baseball_game, hockey_match, political_race.

related_event_tickerstring

Filter by related event ticker

cursorstring

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results

min_updated_tsinteger

Filter milestones with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes.

Response

Milestones retrieved successfully

cursorstring

Cursor for pagination.

Example response

{
  "milestones": [
    {
      "category": "Sports",
      "type": "football_game"
    }
  ]
}