> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Kalshi API reference

> API reference for the Kalshi plugin in Corsair: every `kalshi.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Events

### get

`events.get`

Get an event by ticker

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.events.get({ event_ticker: 'KXHIGHNY-26NOV12' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_ticker` | `string` | Yes | — |
| `with_nested_markets` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `event` | `object` | Yes | — |
| `markets` | `object[]` | No | — |

> [accordion] event full type
>
> ```ts theme={null}
> {
>   event_ticker: string,
>   series_ticker: string,
>   title: string,
>   sub_title?: string,
>   category?: string,
>   mutually_exclusive?: boolean,
>   markets?: {
>     ticker: string,
>     event_ticker: string,
>     market_type?: binary | scalar,
>     title?: string,
>     subtitle?: string,
>     yes_sub_title?: string,
>     no_sub_title?: string,
>     status: string,
>     open_time?: string,
>     close_time?: string,
>     yes_bid_dollars?: string,
>     yes_ask_dollars?: string,
>     no_bid_dollars?: string,
>     no_ask_dollars?: string,
>     last_price_dollars?: string,
>     volume_fp?: string,
>     volume_24h_fp?: string,
>     open_interest_fp?: string,
>     result?: string,
>     price_ranges?: {
>       start: string,
>       end: string,
>       step: string
>     }[]
>   }[]
> }
> ```

> [accordion] markets full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   event_ticker: string,
>   market_type?: binary | scalar,
>   title?: string,
>   subtitle?: string,
>   yes_sub_title?: string,
>   no_sub_title?: string,
>   status: string,
>   open_time?: string,
>   close_time?: string,
>   yes_bid_dollars?: string,
>   yes_ask_dollars?: string,
>   no_bid_dollars?: string,
>   no_ask_dollars?: string,
>   last_price_dollars?: string,
>   volume_fp?: string,
>   volume_24h_fp?: string,
>   open_interest_fp?: string,
>   result?: string,
>   price_ranges?: {
>     start: string,
>     end: string,
>     step: string
>   }[]
> }[]
> ```

***

### list

`events.list`

List events with filters and cursor pagination

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.events.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `with_nested_markets` | `boolean` | No | — |
| `status` | `string` | No | — |
| `series_ticker` | `string` | No | — |
| `tickers` | `string` | No | — |
| `min_close_ts` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `events` | `object[]` | Yes | — |
| `cursor` | `string \| null` | No | — |

> [accordion] events full type
>
> ```ts theme={null}
> {
>   event_ticker: string,
>   series_ticker: string,
>   title: string,
>   sub_title?: string,
>   category?: string,
>   mutually_exclusive?: boolean,
>   markets?: {
>     ticker: string,
>     event_ticker: string,
>     market_type?: binary | scalar,
>     title?: string,
>     subtitle?: string,
>     yes_sub_title?: string,
>     no_sub_title?: string,
>     status: string,
>     open_time?: string,
>     close_time?: string,
>     yes_bid_dollars?: string,
>     yes_ask_dollars?: string,
>     no_bid_dollars?: string,
>     no_ask_dollars?: string,
>     last_price_dollars?: string,
>     volume_fp?: string,
>     volume_24h_fp?: string,
>     open_interest_fp?: string,
>     result?: string,
>     price_ranges?: {
>       start: string,
>       end: string,
>       step: string
>     }[]
>   }[]
> }[]
> ```

***

## Exchange

### schedule

`exchange.schedule`

Get the exchange trading schedule and maintenance windows

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.exchange.schedule({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `schedule` | `object` | Yes | — |

> [accordion] schedule full type
>
> ```ts theme={null}
> {
>   standard_hours?: {
>   }[],
>   maintenance_windows?: {
>     start_datetime: string,
>     end_datetime: string
>   }[]
> }
> ```

***

### status

`exchange.status`

Get whether the exchange and trading are currently active

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.exchange.status({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `exchange_active` | `boolean` | Yes | — |
| `trading_active` | `boolean` | Yes | — |
| `exchange_estimated_resume_time` | `string \| null` | No | — |

***

## Markets

### candlesticks

`markets.candlesticks`

Get OHLC candlesticks for a market over a time range, by minute, hour or day

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.markets.candlesticks({ series_ticker: 'KXHIGHNY', ticker: 'KXHIGHNY-26NOV12-T60', start_ts: 1762848000, end_ts: 1762934400, period_interval: 60 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `series_ticker` | `string` | Yes | — |
| `ticker` | `string` | Yes | — |
| `start_ts` | `number` | Yes | — |
| `end_ts` | `number` | Yes | — |
| `period_interval` | `1 \| 60 \| 1440` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `ticker` | `string` | Yes | — |
| `candlesticks` | `object[]` | Yes | — |

> [accordion] candlesticks full type
>
> ```ts theme={null}
> {
>   end_period_ts: number,
>   yes_bid: {
>     open_dollars: string,
>     low_dollars: string,
>     high_dollars: string,
>     close_dollars: string
>   },
>   yes_ask: {
>     open_dollars: string,
>     low_dollars: string,
>     high_dollars: string,
>     close_dollars: string
>   },
>   price: {
>     open_dollars?: string | null,
>     low_dollars?: string | null,
>     high_dollars?: string | null,
>     close_dollars?: string | null,
>     mean_dollars?: string | null,
>     previous_dollars?: string | null,
>     min_dollars?: string | null,
>     max_dollars?: string | null
>   },
>   volume_fp: string,
>   open_interest_fp: string
> }[]
> ```

***

### get

`markets.get`

Get a market by ticker, including its price ranges

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.markets.get({ ticker: 'KXHIGHNY-26NOV12-T60' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ticker` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `market` | `object` | Yes | — |

> [accordion] market full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   event_ticker: string,
>   market_type?: binary | scalar,
>   title?: string,
>   subtitle?: string,
>   yes_sub_title?: string,
>   no_sub_title?: string,
>   status: string,
>   open_time?: string,
>   close_time?: string,
>   yes_bid_dollars?: string,
>   yes_ask_dollars?: string,
>   no_bid_dollars?: string,
>   no_ask_dollars?: string,
>   last_price_dollars?: string,
>   volume_fp?: string,
>   volume_24h_fp?: string,
>   open_interest_fp?: string,
>   result?: string,
>   price_ranges?: {
>     start: string,
>     end: string,
>     step: string
>   }[]
> }
> ```

***

### list

`markets.list`

List markets with filters and cursor pagination

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.markets.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `event_ticker` | `string` | No | — |
| `series_ticker` | `string` | No | — |
| `status` | `string` | No | — |
| `tickers` | `string` | No | — |
| `min_close_ts` | `number` | No | — |
| `max_close_ts` | `number` | No | — |
| `mve_filter` | `only \| exclude` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `markets` | `object[]` | Yes | — |
| `cursor` | `string \| null` | No | — |

> [accordion] markets full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   event_ticker: string,
>   market_type?: binary | scalar,
>   title?: string,
>   subtitle?: string,
>   yes_sub_title?: string,
>   no_sub_title?: string,
>   status: string,
>   open_time?: string,
>   close_time?: string,
>   yes_bid_dollars?: string,
>   yes_ask_dollars?: string,
>   no_bid_dollars?: string,
>   no_ask_dollars?: string,
>   last_price_dollars?: string,
>   volume_fp?: string,
>   volume_24h_fp?: string,
>   open_interest_fp?: string,
>   result?: string,
>   price_ranges?: {
>     start: string,
>     end: string,
>     step: string
>   }[]
> }[]
> ```

***

### orderbook

`markets.orderbook`

Get the order book for a market

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.markets.orderbook({ ticker: 'KXHIGHNY-26NOV12-T60', depth: 10 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ticker` | `string` | Yes | — |
| `depth` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `orderbook_fp` | `object` | Yes | — |

> [accordion] orderbook\_fp full type
>
> ```ts theme={null}
> {
>   yes_dollars: string[][],
>   no_dollars: string[][]
> }
> ```

***

### trades

`markets.trades`

List recent trades, optionally for one market

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.markets.trades({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ticker` | `string` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `min_ts` | `number` | No | — |
| `max_ts` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `trades` | `object[]` | Yes | — |
| `cursor` | `string \| null` | No | — |

> [accordion] trades full type
>
> ```ts theme={null}
> {
>   trade_id: string,
>   ticker: string,
>   count_fp: string,
>   yes_price_dollars: string,
>   no_price_dollars: string,
>   taker_outcome_side?: string,
>   created_time: string
> }[]
> ```

***

## Orders

### amend

`orders.amend`

Change an existing order's price or size; a new price can fill at once and spend real money in production

**Risk:** `destructive`

```ts theme={null}
await corsair.kalshi.api.orders.amend({ order_id: '<order-id>', ticker: 'KXHIGHNY-26NOV12-T60', side: 'bid', price: '0.5800', count: '10.00' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `order_id` | `string` | Yes | — |
| `ticker` | `string` | Yes | — |
| `side` | `bid \| ask` | Yes | — |
| `price` | `string` | Yes | — |
| `count` | `string` | Yes | — |
| `client_order_id` | `string` | No | — |
| `updated_client_order_id` | `string` | No | — |
| `expiration_time` | `number` | No | — |
| `subaccount` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `order_id` | `string` | Yes | — |
| `client_order_id` | `string` | No | — |
| `remaining_count` | `string \| null` | No | — |
| `fill_count` | `string \| null` | No | — |
| `average_fill_price` | `string \| null` | No | — |
| `average_fee_paid` | `string \| null` | No | — |
| `ts_ms` | `number` | Yes | — |

***

### batchCreate

`orders.batchCreate`

Place several orders in one request. Spends real money when the environment is production

**Risk:** `destructive`

```ts theme={null}
await corsair.kalshi.api.orders.batchCreate({ orders: [{ ticker: 'KXHIGHNY-26NOV12-T60', side: 'bid', count: '10.00', price: '0.5600', time_in_force: 'good_till_canceled' }] });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `orders` | `object[]` | Yes | — |

> [accordion] orders full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   client_order_id?: string,
>   side: bid | ask,
>   count: string,
>   price: string,
>   expiration_time?: number,
>   time_in_force: fill_or_kill | good_till_canceled | immediate_or_cancel,
>   post_only?: boolean,
>   self_trade_prevention_type: taker_at_cross | maker,
>   cancel_order_on_pause?: boolean,
>   reduce_only?: boolean,
>   subaccount?: number
> }[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `orders` | `object[]` | Yes | — |

> [accordion] orders full type
>
> ```ts theme={null}
> {
>   order_id?: string,
>   client_order_id?: string | null,
>   fill_count?: string,
>   remaining_count?: string,
>   ts_ms?: number | null,
>   error?: any
> }[]
> ```

***

### cancel

`orders.cancel`

Cancel a resting order's remaining contracts; a cancelled order can't be restored

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.kalshi.api.orders.cancel({ order_id: '<order-id>', market_ticker: 'KXHIGHNY-26NOV12-T60' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `order_id` | `string` | Yes | — |
| `subaccount` | `number` | No | — |
| `market_ticker` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `order_id` | `string` | Yes | — |
| `client_order_id` | `string` | No | — |
| `reduced_by` | `string` | Yes | — |
| `ts_ms` | `number` | Yes | — |

***

### create

`orders.create`

Place an order. Spends real money when the environment is production

**Risk:** `destructive`

```ts theme={null}
await corsair.kalshi.api.orders.create({ ticker: 'KXHIGHNY-26NOV12-T60', side: 'bid', count: '10.00', price: '0.5600', time_in_force: 'good_till_canceled' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ticker` | `string` | Yes | — |
| `client_order_id` | `string` | No | — |
| `side` | `bid \| ask` | Yes | — |
| `count` | `string` | Yes | — |
| `price` | `string` | Yes | — |
| `expiration_time` | `number` | No | — |
| `time_in_force` | `fill_or_kill \| good_till_canceled \| immediate_or_cancel` | Yes | — |
| `post_only` | `boolean` | No | — |
| `self_trade_prevention_type` | `taker_at_cross \| maker` | No | Defaults to "taker\_at\_cross". |
| `cancel_order_on_pause` | `boolean` | No | — |
| `reduce_only` | `boolean` | No | — |
| `subaccount` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `order_id` | `string` | Yes | — |
| `client_order_id` | `string` | No | — |
| `fill_count` | `string` | Yes | — |
| `remaining_count` | `string` | Yes | — |
| `average_fill_price` | `string` | No | — |
| `average_fee_paid` | `string` | No | — |
| `ts_ms` | `number` | Yes | — |

***

### get

`orders.get`

Get a single order by ID

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.orders.get({ order_id: '<order-id>' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `order_id` | `string` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `order` | `object` | Yes | — |

> [accordion] order full type
>
> ```ts theme={null}
> {
>   order_id: string,
>   client_order_id?: string,
>   ticker: string,
>   status: string,
>   outcome_side?: string,
>   book_side?: string,
>   type?: string,
>   yes_price_dollars?: string,
>   no_price_dollars?: string,
>   initial_count_fp?: string,
>   fill_count_fp?: string,
>   remaining_count_fp?: string,
>   created_time?: string | null
> }
> ```

***

### list

`orders.list`

List orders, optionally filtered by status or market

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.orders.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ticker` | `string` | No | — |
| `event_ticker` | `string` | No | — |
| `min_ts` | `number` | No | — |
| `max_ts` | `number` | No | — |
| `status` | `resting \| canceled \| executed` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `subaccount` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `orders` | `object[]` | Yes | — |
| `cursor` | `string \| null` | No | — |

> [accordion] orders full type
>
> ```ts theme={null}
> {
>   order_id: string,
>   client_order_id?: string,
>   ticker: string,
>   status: string,
>   outcome_side?: string,
>   book_side?: string,
>   type?: string,
>   yes_price_dollars?: string,
>   no_price_dollars?: string,
>   initial_count_fp?: string,
>   fill_count_fp?: string,
>   remaining_count_fp?: string,
>   created_time?: string | null
> }[]
> ```

***

## Portfolio

### balance

`portfolio.balance`

Get the account balance and portfolio value

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.portfolio.balance({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `subaccount` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `balance` | `number` | Yes | — |
| `balance_dollars` | `string` | No | — |
| `portfolio_value` | `number` | No | — |
| `updated_ts` | `number` | No | — |

***

### fills

`portfolio.fills`

List order fills for the account

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.portfolio.fills({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `ticker` | `string` | No | — |
| `order_id` | `string` | No | — |
| `min_ts` | `number` | No | — |
| `max_ts` | `number` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `subaccount` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `fills` | `object[]` | Yes | — |
| `cursor` | `string \| null` | No | — |

> [accordion] fills full type
>
> ```ts theme={null}
> {
>   fill_id: string,
>   order_id: string,
>   ticker: string,
>   count_fp: string,
>   yes_price_dollars: string,
>   no_price_dollars: string,
>   is_taker?: boolean,
>   created_time?: string
> }[]
> ```

***

### positions

`portfolio.positions`

List market and event positions. Includes closed markets awaiting settlement and fully exited positions, so not every row is open exposure

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.portfolio.positions({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `count_filter` | `string` | No | — |
| `settlement_status` | `string` | No | — |
| `ticker` | `string` | No | — |
| `event_ticker` | `string` | No | — |
| `subaccount` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `market_positions` | `object[]` | Yes | — |
| `event_positions` | `object[]` | Yes | — |
| `cursor` | `string \| null` | No | — |

> [accordion] market\_positions full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   position_fp: string,
>   market_exposure_dollars?: string,
>   realized_pnl_dollars?: string,
>   fees_paid_dollars?: string
> }[]
> ```

> [accordion] event\_positions full type
>
> ```ts theme={null}
> {
>   event_ticker: string,
>   event_exposure_dollars?: string,
>   realized_pnl_dollars?: string
> }[]
> ```

***

### settlements

`portfolio.settlements`

List settled positions for the account

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.portfolio.settlements({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `ticker` | `string` | No | — |
| `event_ticker` | `string` | No | — |
| `min_ts` | `number` | No | — |
| `max_ts` | `number` | No | — |
| `subaccount` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `settlements` | `object[]` | Yes | — |
| `cursor` | `string \| null` | No | — |

> [accordion] settlements full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   event_ticker?: string,
>   market_result?: string,
>   settled_time?: string,
>   revenue?: number
> }[]
> ```

***

## Series

### get

`series.get`

Get a series by ticker

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.series.get({ series_ticker: 'KXHIGHNY' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `series_ticker` | `string` | Yes | — |
| `include_volume` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `series` | `object` | Yes | — |

> [accordion] series full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   title: string,
>   frequency?: string,
>   category?: string,
>   tags?: string[] | null,
>   volume_fp?: string
> }
> ```

***

### list

`series.list`

List event series, optionally by category or tags

**Risk:** `read`

```ts theme={null}
await corsair.kalshi.api.series.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `category` | `string` | No | — |
| `tags` | `string` | No | — |
| `include_volume` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `series` | `object[]` | Yes | — |

> [accordion] series full type
>
> ```ts theme={null}
> {
>   ticker: string,
>   title: string,
>   frequency?: string,
>   category?: string,
>   tags?: string[] | null,
>   volume_fp?: string
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.