order-groups

Get Order Groups

Changed on

Retrieves all order groups for the authenticated user.

get/portfolio/order_groups

Request

  • Base URL
    https://external-api.kalshi.com/trade-api/v2
  • URL
    https://external-api.kalshi.com/trade-api/v2/portfolio/order_groups
  • Auth
    API key in header KALSHI-ACCESS-KEY and API key in header KALSHI-ACCESS-SIGNATURE and API key in header KALSHI-ACCESS-TIMESTAMP

Query parameters

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.

Response

Order groups retrieved successfully

Example response

{
  "order_groups": [
    {
      "contracts_limit_fp": "10.00"
    }
  ]
}

Changes

    • warning

      for the query request parameter subaccount, the min was set to 0.00

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status