API Changelog
Stay updated with API changes and version history
You can subscribe to the RSS changelog at
/changelog.rss if you’d like to stay ahead of breaking changes.
You can reference the pending API spec under the “version” dropdown menu at the top left. When the actual API is upgraded to this new version, you will see the version marked as “Stable” in the drop-down menu and become the new default on the landing page.
This changelog is a work in progress. As always, we welcome any feedback in our Discord #dev channel!
Recent Updates
The python SDK is being generated from our OpenAPI spec and is available through pip with pip install kalshi-python.
Docs for the new SDK are available on docs.kalshi.com/python-sdk.
Subpenny pricing fields have been added to APIs involving price, fees, and money in general.
E.g. next to a field called
"price": 12 (representing 12 cents), you will also see "price_dollars": "0.1200",
which is a string bearing a fixed-point representation of money accuate to at 4 decimal points.For now, this change is read-only, meaning that the minimum allowable tick size for orders is still 1c. Eventually,
we will introduce sub-penny pricing on orders. For now, please prepare for an eventual migration to the higher granularity
price representation.For more info, see Subpenny Pricing.The market payload has been updated to include two new fields that describe markets which are part of Multivate Events.
The market payload has been updated to include two new fields that describe markets which are part of Multivate Events.
The MVE payload has been expanded to support more flexible structures. Several fields that are now redundant are deprecated, but not yet removed.
The Settlements API now includes the settlement value for a yes contract.
The get_milestones endpoint now uses case-insensitive matching for the category parameter, resolving inconsistent filtering behavior between “Sports” and “sports”.
Filtering events by close ts and series by tags supported in the API.
The batch order endpoints are now available to all API users in the demo environment:Affected Endpoints:
POST /portfolio/orders/batched(BatchCreateOrders)DELETE /portfolio/orders/batched(BatchCancelOrders)
- Basic tier users can now access batch endpoints in demo environment
- Production environment remains unchanged - Advanced tier or higher still required
- Rate limits still apply based on user tier
The error messages when an incorrect API signature is passed have been improved
The OpenAPI specification for the Kalshi API is now available at
https://docs.kalshi.com/openapi.yaml. This allows developers to easily generate client libraries and integrate with the API using OpenAPI-compatible tools.Added
client_order_id field to orderbook delta WebSocket messages. This field appears only when you caused the orderbook change and contains the client_order_id of your order that triggered the delta.WebSocket Message Enhancement:- New field:
client_order_id(string, optional) - Present only when the authenticated user’s order causes the orderbook change
- Contains the client-provided order ID of the triggering order
Added
GET /portfolio/orders/queue_positions endpoint for retrieving queue positions of multiple resting orders.Request Parameters:market_tickers(optional): Array of market tickers to filter byevent_ticker(optional): Event ticker to filter by
market_tickers and event_ticker in the request.We are migrating our API documentation to a new platform:
- RSS feed moved from
https://trading-api.readme.io/changelog.rsstohttps://docs.kalshi.com/changelog/rss.xml - Documentation site
trading-api.readme.iois now deprecated - New documentation home:
https://docs.kalshi.com - Historical changelog entries will not be backfilled to the new RSS feed
The GetEventMetadata endpoint has been expanded to include settlement sources.
The GetApiVersion endpoint has been removed. API versioning will not be available for the time being.