Skip to main content
POST
/
portfolio
/
order_groups
/
create
Create Order Group
curl --request POST \
  --url https://external-api.kalshi.com/trade-api/v2/portfolio/order_groups/create \
  --header 'Content-Type: application/json' \
  --header 'KALSHI-ACCESS-KEY: <api-key>' \
  --header 'KALSHI-ACCESS-SIGNATURE: <api-key>' \
  --header 'KALSHI-ACCESS-TIMESTAMP: <api-key>' \
  --data '
{
  "subaccount": 0,
  "contracts_limit": 2,
  "contracts_limit_fp": "10.00",
  "exchange_index": 0
}
'
{
  "order_group_id": "<string>",
  "subaccount": 1,
  "exchange_index": 0
}

Authorizations

​
KALSHI-ACCESS-KEY
string
header
required

Your API key ID

​
KALSHI-ACCESS-SIGNATURE
string
header
required

RSA-PSS signature of the request

​
KALSHI-ACCESS-TIMESTAMP
string
header
required

Request timestamp in milliseconds

Body

application/json
​
subaccount
integer
default:0

Optional subaccount number to use for this order group (0 for primary, 1-32 for subaccounts)

Required range: x >= 0
​
contracts_limit
integer<int64>

Specifies the maximum number of contracts that can be matched within this group over a rolling 15-second window. Whole contracts only. Provide contracts_limit or contracts_limit_fp; if both provided they must match.

Required range: x >= 1
​
contracts_limit_fp
string | null

String representation of the maximum number of contracts that can be matched within this group over a rolling 15-second window. Provide contracts_limit or contracts_limit_fp; if both provided they must match.

Example:

"10.00"

​
exchange_index
integer
default:0

Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported.

Example:

0

Response

Order group created successfully

​
order_group_id
string
required

The unique identifier for the created order group

​
subaccount
integer
required

Subaccount number that owns the created order group (0 for primary, 1-32 for subaccounts).

Required range: x >= 0
​
exchange_index
integer

Identifier for an exchange shard. Defaults to 0 if unspecified. Note: currently only 0 supported.

Example:

0