This documentation describes Kalshi's trading API (known as Trade API v2). By using this API, you agree to Kalshi's Developer Agreement (https://kalshi.com/developer-agreement).
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 2.0.0
- Package version: 2.0.0
- Generator version: 7.7.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Put the package under your project folder in a directory named kalshi
and add the following to Cargo.toml
under [dependencies]
:
kalshi = { path = "./kalshi" }
All URIs are relative to https://trading-api.kalshi.com/trade-api/v2
Class | Method | HTTP request | Description |
---|---|---|---|
AuthApi | login | POST /login | Login |
AuthApi | logout | POST /logout | Logout |
ExchangeApi | get_exchange_announcements | GET /exchange/status | GetExchangeAnnouncements |
ExchangeApi | get_exchange_schedule | GET /exchange/schedule | GetExchangeSchedule |
MarketApi | get_event | GET /events/{event_ticker} | GetEvent |
MarketApi | get_events | GET /events | GetEvents |
MarketApi | get_market | GET /markets/{ticker} | GetMarket |
MarketApi | get_market_candlesticks | GET /series/{series_ticker}/markets/{ticker}/candlesticks | GetMarketCandlesticks |
MarketApi | get_market_orderbook | GET /markets/{ticker}/orderbook | GetMarketOrderbook |
MarketApi | get_markets | GET /markets | GetMarkets |
MarketApi | get_series | GET /series/{series_ticker} | GetSeries |
MarketApi | get_trades | GET /markets/trades | GetTrades |
PortfolioApi | amend_order | POST /portfolio/orders/{order_id}/amend | AmendOrder |
PortfolioApi | batch_cancel_orders | DELETE /portfolio/orders/batched | BatchCancelOrders |
PortfolioApi | batch_create_orders | POST /portfolio/orders/batched | BatchCreateOrders |
PortfolioApi | cancel_order | DELETE /portfolio/orders/{order_id} | CancelOrder |
PortfolioApi | create_order | POST /portfolio/orders | CreateOrder |
PortfolioApi | decrease_order | POST /portfolio/orders/{order_id}/decrease | DecreaseOrder |
PortfolioApi | get_balance | GET /portfolio/balance | GetBalance |
PortfolioApi | get_fills | GET /portfolio/fills | GetFills |
PortfolioApi | get_order | GET /portfolio/orders/{order_id} | GetOrder |
PortfolioApi | get_orders | GET /portfolio/orders | GetOrders |
PortfolioApi | get_portfolio_resting_order_total_value | GET /portfolio/summary/total_resting_order_value | GetPortfolioRestingOrderTotalValue |
PortfolioApi | get_portfolio_settlements | GET /portfolio/settlements | GetPortfolioSettlements |
PortfolioApi | get_positions | GET /portfolio/positions | GetPositions |
- AmendOrderRequest
- AmendOrderResponse
- Announcement
- BatchCancelOrdersIndividualResponse
- BatchCancelOrdersRequest
- BatchCancelOrdersResponse
- BatchCreateOrdersIndividualResponse
- BatchCreateOrdersRequest
- BatchCreateOrdersResponse
- BidAskDistribution
- CancelOrderResponse
- CreateOrderRequest
- CreateOrderResponse
- DailySchedule
- DecreaseOrderRequest
- DecreaseOrderResponse
- EventData
- EventPosition
- ExchangeStatus
- Fill
- GetBalanceResponse
- GetEventResponse
- GetEventsResponse
- GetExchangeAnnouncementsResponse
- GetExchangeScheduleResponse
- GetFillsResponse
- GetMarketCandlesticksResponse
- GetMarketOrderbookResponse
- GetMarketResponse
- GetMarketsResponse
- GetOrderResponse
- GetOrdersResponse
- GetPortfolioSettlementsResponse
- GetPositionsResponse
- GetSeriesResponse
- GetUserRestingOrderTotalValueResponse
- JsonError
- LoginRequest
- LoginResponse
- MaintenanceWindow
- Market
- MarketCandlestick
- MarketPosition
- Order
- OrderBook
- OrderConfirmation
- PriceDistribution
- PublicTrade
- PublicTradesGetResponse
- Schedule
- Series
- Settlement
- SettlementSource
- WeeklySchedule
To get access to the crate's generated documentation, use:
cargo doc --open