Batch Cancel Orders

curl --request DELETE \
  --url https://api.elections.kalshi.com/trade-api/v2/portfolio/orders/batched \
  --header 'Content-Type: application/json' \
  --header 'KALSHI-ACCESS-KEY: <api-key>' \
  --header 'KALSHI-ACCESS-SIGNATURE: <api-key>' \
  --header 'KALSHI-ACCESS-TIMESTAMP: <api-key>' \
  --data '
{
  "ids": [
    "<string>"
  ]
}
'

{
  "orders": [
    {
      "order_id": "<string>",
      "reduced_by": 123,
      "order": {
        "order_id": "<string>",
        "user_id": "<string>",
        "client_order_id": "<string>",
        "ticker": "<string>",
        "side": "yes",
        "action": "buy",
        "type": "limit",
        "status": "resting",
        "yes_price": 123,
        "no_price": 123,
        "yes_price_dollars": "0.5600",
        "no_price_dollars": "0.5600",
        "fill_count": 123,
        "remaining_count": 123,
        "initial_count": 123,
        "taker_fees": 123,
        "maker_fees": 123,
        "taker_fill_cost": 123,
        "maker_fill_cost": 123,
        "taker_fill_cost_dollars": "0.5600",
        "maker_fill_cost_dollars": "0.5600",
        "queue_position": 123,
        "taker_fees_dollars": "0.5600",
        "maker_fees_dollars": "0.5600",
        "expiration_time": "2023-11-07T05:31:56Z",
        "created_time": "2023-11-07T05:31:56Z",
        "last_update_time": "2023-11-07T05:31:56Z",
        "self_trade_prevention_type": "taker_at_cross",
        "order_group_id": "<string>",
        "cancel_order_on_pause": true
      },
      "error": {
        "code": "<string>",
        "message": "<string>",
        "details": "<string>",
        "service": "<string>"
      }
    }
  ]
}

DELETE

portfolio

orders

batched

Batch Cancel Orders

curl --request DELETE \
  --url https://api.elections.kalshi.com/trade-api/v2/portfolio/orders/batched \
  --header 'Content-Type: application/json' \
  --header 'KALSHI-ACCESS-KEY: <api-key>' \
  --header 'KALSHI-ACCESS-SIGNATURE: <api-key>' \
  --header 'KALSHI-ACCESS-TIMESTAMP: <api-key>' \
  --data '
{
  "ids": [
    "<string>"
  ]
}
'

{
  "orders": [
    {
      "order_id": "<string>",
      "reduced_by": 123,
      "order": {
        "order_id": "<string>",
        "user_id": "<string>",
        "client_order_id": "<string>",
        "ticker": "<string>",
        "side": "yes",
        "action": "buy",
        "type": "limit",
        "status": "resting",
        "yes_price": 123,
        "no_price": 123,
        "yes_price_dollars": "0.5600",
        "no_price_dollars": "0.5600",
        "fill_count": 123,
        "remaining_count": 123,
        "initial_count": 123,
        "taker_fees": 123,
        "maker_fees": 123,
        "taker_fill_cost": 123,
        "maker_fill_cost": 123,
        "taker_fill_cost_dollars": "0.5600",
        "maker_fill_cost_dollars": "0.5600",
        "queue_position": 123,
        "taker_fees_dollars": "0.5600",
        "maker_fees_dollars": "0.5600",
        "expiration_time": "2023-11-07T05:31:56Z",
        "created_time": "2023-11-07T05:31:56Z",
        "last_update_time": "2023-11-07T05:31:56Z",
        "self_trade_prevention_type": "taker_at_cross",
        "order_group_id": "<string>",
        "cancel_order_on_pause": true
      },
      "error": {
        "code": "<string>",
        "message": "<string>",
        "details": "<string>",
        "service": "<string>"
      }
    }
  ]
}

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

ids

string[]

required

An array of order IDs to cancel

Response

Batch order cancellation completed

orders

object[]

required

Show child attributes

orders.order_id

string

required

The order ID to identify which order had an error during batch cancellation

orders.reduced_by

integer

required

The number of contracts that were successfully canceled from this order

orders.order

object

Show child attributes

orders.order.order_id

string

required

orders.order.user_id

string

required

Unique identifier for users

orders.order.client_order_id

string

required

orders.order.ticker

string

required

orders.order.side

enum<string>

required

Available options:

yes,

no

orders.order.action

enum<string>

required

Available options:

buy,

sell

orders.order.type

enum<string>

required

Available options:

limit,

market

orders.order.status

enum<string>

required

The status of an order

Available options:

resting,

canceled,

executed

orders.order.yes_price

integer

required

orders.order.no_price

integer

required

orders.order.yes_price_dollars

string

required

The yes price for this order in fixed-point dollars

Example:

"0.5600"

orders.order.no_price_dollars

string

required

The no price for this order in fixed-point dollars

Example:

"0.5600"

orders.order.fill_count

integer

required

The number of contracts that have been filled

orders.order.remaining_count

integer

required

orders.order.initial_count

integer

required

The initial size of the order (contract units)

orders.order.taker_fees

integer

required

Fees paid on filled taker contracts, in cents

orders.order.maker_fees

integer

required

Fees paid on filled maker contracts, in cents

orders.order.taker_fill_cost

integer

required

The cost of filled taker orders in cents

orders.order.maker_fill_cost

integer

required

The cost of filled maker orders in cents

orders.order.taker_fill_cost_dollars

string

required

The cost of filled taker orders in dollars

Example:

"0.5600"

orders.order.maker_fill_cost_dollars

string

required

The cost of filled maker orders in dollars

Example:

"0.5600"

orders.order.queue_position

integer

required

DEPRECATED: This field is deprecated and will always return 0. Please use the GET /portfolio/orders/{order_id}/queue_position endpoint instead

orders.order.taker_fees_dollars

string | null

Fees paid on filled taker contracts, in dollars

Example:

"0.5600"

orders.order.maker_fees_dollars

string | null

Fees paid on filled maker contracts, in dollars

Example:

"0.5600"

orders.order.expiration_time

string<date-time> | null

orders.order.created_time

string<date-time> | null

orders.order.last_update_time

string<date-time> | null

The last update to an order (modify, cancel, fill)

orders.order.self_trade_prevention_type

enum<string> | null

The self-trade prevention type for orders

Available options:

taker_at_cross,

maker

orders.order.order_group_id

string | null

The order group this order is part of

orders.order.cancel_order_on_pause

boolean

If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason.

orders.error

object

Show child attributes

orders.error.code

string

Error code

orders.error.message

string

Human-readable error message

orders.error.details

string

Additional details about the error, if available

orders.error.service

string

The name of the service that generated the error

Batch Create Orders Amend Order

⌘I

exchange

orders

order-groups

portfolio

api-keys

search

market

events

live-data

incentive-programs

fcm

structured-targets

milestone

communications

multivariate

Batch Cancel Orders

Authorizations

Body

Response