order-groups

Delete Order Group

Changed on

Deletes an order group and cancels all orders within it. This permanently removes the group.

delete/portfolio/order_groups/{order_group_id}

Request

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

Path parameters

order_group_idstring required

Order group ID

Query parameters

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0. Subaccount-restricted API keys default to their locked subaccount and must omit this parameter or pass their locked subaccount.

exchange_indexinteger

Identifier for an exchange shard.

Identifier for an exchange shard. Defaults to 0.

Response

Order group deleted successfully

EmptyResponse required

An empty response body

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