kalshi-docs

Category: Docs & Knowledge | Uploader: ammario | Downloads: 0 | Version: v1.0（Latest）

Kalshi prediction markets API documentation. Use when building integrations with Kalshi's REST API or WebSocket streams for trading, market data, or portfolio management.

Changelog: Source: GitHub https://github.com/ammario/kalshi-docs

Directory Structure

Current level: tree/main/

📁 .github/
- 📁 workflows/
  - 📄 update-docs.yml 1.6 KB
📁 api-reference/
- 📁 account/
  - 📄 get-account-api-limits.md 3.4 KB
- 📁 api-keys/
  - 📄 create-api-key.md 4.5 KB
  - 📄 delete-api-key.md 3.3 KB
  - 📄 generate-api-key.md 4.5 KB
  - 📄 get-api-keys.md 3.9 KB
- 📁 collection/
  - 📄 create-market-in-multivariate-event-collection.md 5.9 KB
  - 📄 get-multivariate-event-collection-lookup-history.md 5.1 KB
  - 📄 get-multivariate-event-collection.md 8.7 KB
  - 📄 get-multivariate-event-collections.md 9.6 KB
  - 📄 lookup-tickers-for-market-in-multivariate-event-collection.md 6.7 KB
- 📁 communications/
  - 📄 accept-quote.md 4.8 KB
  - 📄 confirm-quote.md 4.4 KB
  - 📄 create-quote.md 5.5 KB
  - 📄 create-rfq.md 7.6 KB
  - 📄 delete-quote.md 4.1 KB
  - 📄 delete-rfq.md 4.0 KB
  - 📄 get-communications-id.md 4.0 KB
  - 📄 get-quote.md 9.1 KB
  - 📄 get-quotes.md 11.1 KB
  - 📄 get-rfq.md 8.2 KB
  - 📄 get-rfqs.md 9.7 KB
- 📁 events/
  - 📄 get-event-candlesticks-multiple-events.md 13.3 KB
  - 📄 get-event-candlesticks.md 10.3 KB
  - 📄 get-event-forecast-percentile-history.md 6.5 KB
  - 📄 get-event-metadata.md 4.6 KB
  - 📄 get-event.md 19.2 KB
  - 📄 get-events.md 23.1 KB
  - 📄 get-multivariate-events.md 19.5 KB
- 📁 exchange/
  - 📄 get-exchange-announcements.md 3.3 KB
  - 📄 get-exchange-schedule.md 5.7 KB
  - 📄 get-exchange-status.md 3.7 KB
  - 📄 get-series-fee-changes.md 4.5 KB
  - 📄 get-user-data-timestamp.md 3.2 KB
- 📁 fcm/
  - 📄 get-fcm-orders.md 10.3 KB
  - 📄 get-fcm-positions.md 9.3 KB
- 📁 historical/
  - 📄 get-historical-cutoff-timestamps.md 4.7 KB
  - 📄 get-historical-fills.md 8.5 KB
  - 📄 get-historical-market-candlesticks.md 9.5 KB
  - 📄 get-historical-market.md 15.7 KB
  - 📄 get-historical-markets.md 17.4 KB
  - 📄 get-historical-orders.md 10.3 KB
  - 📄 get-historical-trades.md 7.6 KB
- 📁 incentive-programs/
  - 📄 get-incentives.md 6.9 KB
  - 📄 get-volume-incentives.md 6.0 KB
- 📁 incentive_programs/
  - 📄 get-volume-incentives.md 6.1 KB
- 📁 live-data/
  - 📄 get-game-stats.md 3.5 KB
  - 📄 get-live-data-with-type.md 4.0 KB
  - 📄 get-live-data.md 3.6 KB
  - 📄 get-multiple-live-data.md 3.6 KB
- 📁 live_data/
  - 📄 get-live-data.md 2.1 KB
  - 📄 get-multiple-live-data.md 1.9 KB
- 📁 market/
  - 📄 batch-get-market-candlesticks.md 11.0 KB
  - 📄 get-market-candlesticks.md 11.2 KB
  - 📄 get-market-orderbook.md 6.7 KB
  - 📄 get-market.md 15.2 KB
  - 📄 get-markets.md 20.5 KB
  - 📄 get-multiple-market-orderbooks.md 7.0 KB
  - 📄 get-series-list.md 9.4 KB
  - 📄 get-series.md 8.8 KB
  - 📄 get-trades.md 7.1 KB
- 📁 milestone/
  - 📄 get-milestone.md 5.0 KB
  - 📄 get-milestones.md 7.2 KB
- 📁 multivariate/
  - 📄 create-market-in-multivariate-event-collection.md 18.7 KB
  - 📄 get-multivariate-event-collection-lookup-history.md 5.5 KB
  - 📄 get-multivariate-event-collection.md 8.1 KB
  - 📄 get-multivariate-event-collections.md 9.3 KB
  - 📄 lookup-tickers-for-market-in-multivariate-event-collection.md 6.4 KB
- 📁 order-groups/
  - 📄 create-order-group.md 6.5 KB
  - 📄 delete-order-group.md 4.7 KB
  - 📄 get-order-group.md 5.9 KB
  - 📄 get-order-groups.md 5.8 KB
  - 📄 reset-order-group.md 4.9 KB
  - 📄 trigger-order-group.md 4.9 KB
  - 📄 update-order-group-limit.md 6.6 KB
- 📁 orders/
  - 📄 amend-order.md 12.4 KB
  - 📄 batch-cancel-orders.md 11.1 KB
  - 📄 batch-create-orders.md 14.2 KB
  - 📄 cancel-order.md 10.5 KB
  - 📄 create-order-group.md 4.9 KB
  - 📄 create-order.md 13.3 KB
  - 📄 decrease-order.md 11.8 KB
  - 📄 delete-order-group.md 4.2 KB
  - 📄 get-order-group.md 4.7 KB
  - 📄 get-order-groups.md 4.7 KB
  - 📄 get-order-queue-position.md 5.4 KB
  - 📄 get-order.md 9.1 KB
  - 📄 get-orders.md 11.9 KB
  - 📄 get-queue-positions-for-orders.md 6.3 KB
  - 📄 reset-order-group.md 4.2 KB
- 📁 portfolio/
  - 📄 amend-order.md 14.3 KB
  - 📄 batch-cancel-orders.md 11.7 KB
  - 📄 batch-create-orders.md 15.5 KB
  - 📄 cancel-order.md 9.9 KB
  - 📄 create-order-group.md 4.8 KB
  - 📄 create-order.md 15.8 KB
  - 📄 create-subaccount.md 4.4 KB
  - 📄 decrease-order.md 10.6 KB
  - 📄 delete-order-group.md 4.0 KB
  - 📄 get-all-subaccount-balances.md 4.9 KB
  - 📄 get-balance.md 4.8 KB
  - 📄 get-fills.md 8.9 KB
  - 📄 get-order-group.md 4.6 KB
  - 📄 get-order-groups.md 4.5 KB
  - 📄 get-order-queue-position.md 4.4 KB
  - 📄 get-order.md 9.3 KB
  - 📄 get-orders.md 10.7 KB
  - 📄 get-positions.md 10.5 KB
  - 📄 get-queue-positions-for-orders.md 5.2 KB
  - 📄 get-settlements.md 9.5 KB
  - 📄 get-subaccount-netting.md 4.4 KB
  - 📄 get-subaccount-transfers.md 5.7 KB
  - 📄 get-total-resting-order-value.md 4.4 KB
  - 📄 reset-order-group.md 4.1 KB
  - 📄 transfer-between-subaccounts.md 5.3 KB
  - 📄 update-subaccount-netting.md 4.6 KB
- 📁 search/
  - 📄 get-filters-for-sports.md 3.8 KB
  - 📄 get-tags-for-series-categories.md 3.0 KB
- 📁 structured-targets/
  - 📄 get-structured-target.md 3.9 KB
  - 📄 get-structured-targets.md 5.0 KB
📁 fix/
- 📄 connectivity.md 5.2 KB
- 📄 drop-copy.md 4.9 KB
- 📄 error-handling.md 9.5 KB
- 📄 market-settlement.md 8.5 KB
- 📄 order-entry.md 31.2 KB
- 📄 order-groups.md 4.7 KB
- 📄 rfq-messages.md 24.0 KB
- 📄 session-management.md 11.8 KB
- 📄 subpenny-pricing.md 2.3 KB
📁 getting_started/
- 📄 api_keys.md 6.2 KB
- 📄 demo_env.md 964 B
- 📄 fee_rounding.md 7.3 KB
- 📄 fixed_point_contracts.md 1.9 KB
- 📄 fixed_point_migration.md 3.7 KB
- 📄 historical_data.md 6.1 KB
- 📄 making_your_first_request.md 1.2 KB
- 📄 market_lifecycle.md 7.5 KB
- 📄 orderbook_responses.md 8.5 KB
- 📄 pagination.md 5.3 KB
- 📄 quick_start_authenticated_requests.md 7.0 KB
- 📄 quick_start_create_order.md 5.9 KB
- 📄 quick_start_market_data.md 8.4 KB
- 📄 quick_start_websockets.md 14.9 KB
- 📄 rate_limits.md 4.3 KB
- 📄 rfqs.md 3.9 KB
- 📄 subpenny_pricing.md 1.3 KB
- 📄 targets_and_milestones.md 4.2 KB
- 📄 terms.md 1.4 KB
📁 python-sdk/
- 📁 api/
  - 📄 ApiKeysApi.md 5.4 KB
  - 📄 CommunicationsApi.md 15.4 KB
  - 📄 EventsApi.md 15.3 KB
  - 📄 ExchangeApi.md 5.2 KB
  - 📄 MarketsApi.md 20.2 KB
  - 📄 MilestonesApi.md 5.4 KB
  - 📄 MultivariateCollectionsApi.md 9.5 KB
  - 📄 PortfolioApi.md 10.7 KB
  - 📄 SeriesApi.md 5.0 KB
  - 📄 StructuredTargetsApi.md 3.4 KB
📁 sdks/
- 📁 python/
  - 📄 quickstart.md 1.5 KB
- 📁 typescript/
  - 📄 quickstart.md 1.7 KB
- 📄 overview.md 2.5 KB
📁 typescript-sdk/
- 📁 api/
  - 📄 ApiKeysApi.md 6.2 KB
  - 📄 CommunicationsApi.md 18.4 KB
  - 📄 EventsApi.md 21.8 KB
  - 📄 ExchangeApi.md 5.7 KB
  - 📄 MarketsApi.md 18.7 KB
  - 📄 MilestonesApi.md 4.4 KB
  - 📄 MultivariateCollectionsApi.md 7.3 KB
  - 📄 PortfolioApi.md 21.1 KB
  - 📄 SeriesApi.md 4.1 KB
  - 📄 StructuredTargetsApi.md 4.2 KB
📁 websockets/
- 📄 communications.md 40.3 KB
- 📄 connection-keep-alive.md 5.2 KB
- 📄 market-positions.md 8.5 KB
- 📄 market-ticker-v2.md 741 B
- 📄 market-ticker.md 10.2 KB
- 📄 multivariate-lookups.md 6.1 KB
- 📄 order-group-updates.md 6.3 KB
- 📄 orderbook-updates.md 14.7 KB
- 📄 public-trades.md 6.7 KB
- 📄 user-fills.md 10.3 KB
- 📄 user-orders.md 14.0 KB
- 📄 websocket-connection.md 48.8 KB
📄 .gitignore 353 B
📄 AGENTS.md 118 B
📄 asyncapi.yaml 99.8 KB
📄 bun.lock 7.8 KB
📄 changelog.md 72.9 KB
📄 fix.md 2.6 KB
📄 LICENSE 6.4 KB
📄 package.json 523 B
📄 README.md 1.9 KB
📄 SKILL.md 2.0 KB
📄 tsconfig.json 484 B
📄 update.ts 7.3 KB
📄 welcome.md 4.6 KB

SKILL.md

---
name: kalshi-docs
description: Kalshi prediction markets API documentation. Use when building integrations with Kalshi's REST API or WebSocket streams for trading, market data, or portfolio management.
license: CC0-1.0
metadata:
  source: https://github.com/ammario/kalshi-docs
  updated: nightly
---

# Kalshi API Documentation

Complete API reference for Kalshi's prediction markets platform. Use this skill when:
- Building trading bots or integrations with Kalshi
- Working with market data, orders, or portfolio APIs
- Implementing WebSocket connections for real-time data
- Understanding authentication and rate limits

## Documentation Structure

- `api-reference/` - Complete REST API endpoints organized by category:
  - `api-keys/` - API key management
  - `communications/` - RFQs and quotes
  - `events/` - Event data and series
  - `exchange/` - Exchange info, schedule, announcements
  - `market/` - Market data, orderbooks, candlesticks
  - `orders/` - Order placement and management
  - `portfolio/` - Positions, fills, balance, settlements
  - `multivariate/` - Multi-leg market operations
- `getting_started/` - Quickstart guides and concepts
- `websockets/` - WebSocket API for real-time streaming
- `asyncapi.yaml` - WebSocket API schema (AsyncAPI format)
- `changelog.md` - API changes and updates

## Key Files

- `getting_started/api_keys.md` - API key setup and authentication
- `getting_started/quick_start_market_data.md` - Fetching market data
- `getting_started/quick_start_create_order.md` - Placing orders
- `getting_started/quick_start_websockets.md` - Real-time streaming
- `getting_started/rate_limits.md` - Rate limiting details
- `api-reference/portfolio/` - Trading and position management
- `api-reference/market/` - Market data endpoints

## Usage Notes

- API base URL: `https://api.kalshi.com/trade-api/v2`
- WebSocket URL: `wss://api.kalshi.com/trade-api/ws/v2`
- Demo environment available at `https://demo-api.kalshi.co`
- All trading endpoints require authentication via API key
- Rate limits apply - see `getting_started/rate_limits.md`

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

kalshi-docs

Directory Structure

SKILL.md

Report

Notice