Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kalshi order-groups API

Order group management endpoints

Kalshi order-groups API is one of 21 APIs that Kalshi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include order-groups. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 3.19.0.

Requests are made against 4 base URLs: https://external-api.kalshi.com/trade-api/v2, https://api.elections.kalshi.com/trade-api/v2, https://external-api.demo.kalshi.co/trade-api/v2, https://demo-api.kalshi.co/trade-api/v2.

7 operations 6 paths 10 schemas 1 DELETE2 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3.19.0
Base URL
https://api.elections.kalshi.com/trade-api/v2
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Kalshi order-groups API declares 3 security schemes for authenticating requests. An API key is passed in the header as KALSHI-ACCESS-KEY (kalshiAccessKey). An API key is passed in the header as KALSHI-ACCESS-SIGNATURE (kalshiAccessSignature). An API key is passed in the header as KALSHI-ACCESS-TIMESTAMP (kalshiAccessTimestamp).

  • kalshiAccessKey — Your API key ID
  • kalshiAccessSignature — RSA-PSS signature of the request
  • kalshiAccessTimestamp — Request timestamp in milliseconds

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

order-groups 7

Order group management endpoints

GET
/portfolio/order_groups
Get Order Groups
GetOrderGroups 1 param → 200400401500
POST
/portfolio/order_groups/create
Create Order Group
CreateOrderGroup body → 201400401500
GET
/portfolio/order_groups/{order_group_id}
Get Order Group
GetOrderGroup 2 params → 200401404500
DELETE
/portfolio/order_groups/{order_group_id}
Delete Order Group
DeleteOrderGroup 3 params → 200401404500
PUT
/portfolio/order_groups/{order_group_id}/reset
Reset Order Group
ResetOrderGroup 3 params body → 200401404500
PUT
/portfolio/order_groups/{order_group_id}/trigger
Trigger Order Group
TriggerOrderGroup 3 params body → 200401404500
PUT
/portfolio/order_groups/{order_group_id}/limit
Update Order Group Limit
UpdateOrderGroupLimit 2 params body → 200400401404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are GetOrderGroupResponse (4 properties), OrderGroup (4 properties), ErrorResponse (4 properties), CreateOrderGroupRequest (4 properties). Each schema is shown below with its type and property counts.

GetOrderGroupsResponse
object
1 property
CreateOrderGroupResponse
object
3 properties 2 required
FixedPointCount
string
Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0–2 decimal places (e.g., "10", "10.0", "10.…
ExchangeIndex
integer
Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported.
CreateOrderGroupRequest
object
4 properties
EmptyResponse
object
An empty response body
ErrorResponse
object
4 properties
OrderGroup
object
4 properties 2 required
GetOrderGroupResponse
object
4 properties 2 required
UpdateOrderGroupLimitRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kalshi-order-groups-api-openapi.yml Raw ↑

Other APIs Kalshi publishes across the network.

Kalshi Trade API (Demo)
Kalshi WebSocket Streaming API
Kalshi AsyncAPI Specification
Kalshi Python Starter Kit
Kalshi account API
Kalshi api-keys API
Kalshi communications API
Kalshi events API
Kalshi exchange API
Kalshi fcm API
Kalshi historical API
Kalshi incentive-programs API