{ "opencollection": "1.0.0", "info": { "name": "Kalshi Trade API Manual Endpoints account events API", "version": "3.19.0" }, "items": [ { "info": { "name": "events", "type": "folder" }, "items": [ { "info": { "name": "Get Event Candlesticks", "type": "http" }, "http": { "method": "GET", "url": "https://external-api.kalshi.com/trade-api/v2/series/:series_ticker/events/:ticker/candlesticks", "params": [ { "name": "ticker", "value": "", "type": "path", "description": "The event ticker" }, { "name": "series_ticker", "value": "", "type": "path", "description": "The series ticker" }, { "name": "start_ts", "value": "", "type": "query", "description": "Start timestamp for the range" }, { "name": "end_ts", "value": "", "type": "query", "description": "End timestamp for the range" }, { "name": "period_interval", "value": "", "type": "query", "description": "Specifies the length of each candlestick period, in minutes. Must be one minute, one hour, or one day." } ] }, "docs": " End-point for returning aggregated data across all markets corresponding to an event." }, { "info": { "name": "Get Events", "type": "http" }, "http": { "method": "GET", "url": "https://external-api.kalshi.com/trade-api/v2/events", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Parameter to specify the number of results per page. Defaults to 200. Maximum value is 200." }, { "name": "cursor", "value": "", "type": "query", "description": "Parameter to specify the pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page." }, { "name": "with_nested_markets", "value": "", "type": "query", "description": "Parameter to specify if nested markets should be included in the response. When true, each event will include a 'markets' field containing a list of Market objects associated with that event. Historical markets settled before the historical cutoff will not be included." }, { "name": "with_milestones", "value": "", "type": "query", "description": "If true, includes related milestones as a field alongside events." }, { "name": "status", "value": "", "type": "query", "description": "Filter by event status. Possible values are 'unopened', 'open', 'closed', 'settled'. Leave empty to return events with any status." }, { "name": "series_ticker", "value": "", "type": "query", "description": "Filter by series ticker" }, { "name": "min_close_ts", "value": "", "type": "query", "description": "Filter events with at least one market with close timestamp greater than this Unix timestamp (in seconds)." }, { "name": "min_updated_ts", "value": "", "type": "query", "description": "Filter events with metadata updated after this Unix timestamp (in seconds). Use this to efficiently poll for changes." } ] }, "docs": "Get all events. This endpoint excludes multivariate events.\nTo retrieve multivariate events, use the GET /events/multivariate endpoint.\nAll events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.\n" }, { "info": { "name": "Get Multivariate Events", "type": "http" }, "http": { "method": "GET", "url": "https://external-api.kalshi.com/trade-api/v2/events/multivariate", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results per page. Defaults to 100. Maximum value is 200." }, { "name": "cursor", "value": "", "type": "query", "description": "Pagination cursor. Use the cursor value returned from the previous response to get the next page of results." }, { "name": "series_ticker", "value": "", "type": "query", "description": "Filter by series ticker" }, { "name": "collection_ticker", "value": "", "type": "query", "description": "Filter events by collection ticker. Returns only multivariate events belonging to the specified collection. Cannot be used together with series_ticker." }, { "name": "with_nested_markets", "value": "", "type": "query", "description": "Parameter to specify if nested markets should be included in the response. When true, each event will include a 'markets' field containing a list of Market objects associated with that event." } ] }, "docs": "Retrieve multivariate (combo) events. These are dynamically created events from multivariate event collections. Supports filtering by series and collection ticker." }, { "info": { "name": "Get Event", "type": "http" }, "http": { "method": "GET", "url": "https://external-api.kalshi.com/trade-api/v2/events/:event_ticker", "params": [ { "name": "event_ticker", "value": "", "type": "path", "description": "Event ticker" }, { "name": "with_nested_markets", "value": "", "type": "query", "description": "If true, markets are included within the event object. If false (default), markets are returned as a separate top-level field in the response. Historical markets settled before the historical cutoff will not be included." } ] }, "docs": "Endpoint for getting data about an event by its ticker. An event represents a real-world occurrence that can be traded on, such as an election, sports game, or economic indicator release.\nEvents contain one or more markets where users can place trades on different outcomes.\nAll events are accessible through this endpoint, even if their associated markets are older than the historical cutoff.\n" }, { "info": { "name": "Get Event Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://external-api.kalshi.com/trade-api/v2/events/:event_ticker/metadata", "params": [ { "name": "event_ticker", "value": "", "type": "path", "description": "Event ticker" } ] }, "docs": " Endpoint for getting metadata about an event by its ticker. Returns only the metadata information for an event." }, { "info": { "name": "Get Event Forecast Percentile History", "type": "http" }, "http": { "method": "GET", "url": "https://external-api.kalshi.com/trade-api/v2/series/:series_ticker/events/:ticker/forecast_percentile_history", "params": [ { "name": "ticker", "value": "", "type": "path", "description": "The event ticker" }, { "name": "series_ticker", "value": "", "type": "path", "description": "The series ticker" }, { "name": "percentiles", "value": "", "type": "query", "description": "Array of percentile values to retrieve (0-9999, max 10 values)" }, { "name": "start_ts", "value": "", "type": "query", "description": "Start timestamp for the range" }, { "name": "end_ts", "value": "", "type": "query", "description": "End timestamp for the range" }, { "name": "period_interval", "value": "", "type": "query", "description": "Specifies the length of each forecast period, in minutes. 0 for 5-second intervals, or 1, 60, or 1440 for minute-based intervals." } ], "auth": { "type": "apikey", "key": "KALSHI-ACCESS-KEY", "value": "{{KALSHI-ACCESS-KEY}}", "placement": "header" } }, "docs": "Endpoint for getting the historical raw and formatted forecast numbers for an event at specific percentiles." } ] } ], "bundled": true }