mcpField
K
kalshi-docs

kalshi-docs

github.com/ammarioDevelopment10169 installsUpdated 1d ago
Repository

About kalshi-docs

kalshi-docs is a documentation skill for developers building with Kalshi’s prediction market API. It covers REST endpoints, WebSocket streaming, authentication, and rate limits.

Key features

  1. 01REST API reference by category
  2. 02WebSocket streaming documentation
  3. 03Authentication and API key guidance
  4. 04Rate-limit details and changelog

Use cases

  1. 01Finding endpoints for market and portfolio data
  2. 02Implementing order placement and management
  3. 03Setting up real-time WebSocket data
  4. 04Checking authentication or rate-limit requirements

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/ammario/kalshi-docs --skill kalshi-docs

After installing, type/kalshi-docsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
LICENSE
.gitignore
AGENTS.md
.github/workflows/
update-docs.yml
api-reference/account/
list-non-default-endpoint-costs.md
get-account-api-usage-level-volume-progress.md
get-account-api-limits.md
get-perps-account-api-limits.md
upgrade-account-api-usage-level.md
api-reference/api-keys/
generate-api-key.md
delete-api-key.md
create-api-key.md
get-api-keys.md
api-reference/collection/
get-multivariate-event-collection-lookup-history.md
create-market-in-multivariate-event-collection.md
get-multivariate-event-collection.md
lookup-tickers-for-market-in-multivariate-event-collection.md
get-multivariate-event-collections.md
api-reference/communications/
accept-block-trade-proposal.md
accept-rfq-quote.md
confirm-quote.md
confirm-rfq-quote.md
create-rfq.md
accept-quote.md
delete-rfq.md
create-quote.md
delete-rfq-quote.md
get-block-trade-proposals.md
get-quote.md

Details

From the project README

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

Markdown supported