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

# Kalshi Get Market Orderbook

Get the orderbook for a Kalshi market showing Yes and No price levels with quantities. Returns bid/ask depth for both sides. Requires Kalshi API authentication. Ideal for: liquidity analysis, spread monitoring, trading strategy development, market depth assessment.

![Kalshi Get Market Orderbook logo](https://cdn.b3.fun/kalshi-logo.png)
Catalog action Utility kalshi

Get the orderbook for a Kalshi market showing Yes and No price levels with quantities. Returns bid/ask depth for both sides. Requires Kalshi API authentication. Ideal for: liquidity analysis, spread monitoring, trading strategy development, market depth assessment.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `kalshi-get-market-orderbook` |
| Category | Utility |
| Connector | `kalshi` |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `kalshi`, `prediction-market`, `market-data`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ticker` | `string` | Yes | The market ticker to get the orderbook for \(e.g., 'KXBTC-25MAR14-B95500'\) |
| `depth` | `number` | No | Maximum number of price levels to return per side \(0-100\). Omit for full depth. |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `yes_dollars` | `array` | Yes | Yes-side orderbook levels sorted by price |
| `no_dollars` | `array` | Yes | No-side orderbook levels sorted by price |
| `yesLevels` | `number` | No | Number of Yes price levels |
| `noLevels` | `number` | No | Number of No price levels |
| `ticker` | `string` | No | Market ticker |

## Examples

**Workflow node**

```json
{
  "type": "kalshi-get-market-orderbook",
  "payload": {
    "ticker": "example-ticker"
  },
  "children": [],
  "connector": {
    "type": "kalshi",
    "id": "conn_kalshi"
  }
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/kalshi-get-market-orderbook/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "ticker": "example-ticker"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.