# Order book depth

> Buy and sell orders stacked away from the price. Sample data: an order book around a mid of 64,210.

- Type 053 · Distribution
- Component: `<OrderBookDepth>`, the same name as the Figma component
- Install: `npx shadcn add @chartory/order-book-depth` (free in Hearth: the public registry, no token; Signal with Code and Complete)
- Type page: https://usechartory.com/charts/order-book-depth

## Installation

1. **Set up the registry once.** This chart is free in Hearth and MIT licensed: no token. Add @chartory to components.json once (the URL alone, no headers), or skip this when another chart is already installed. [Installation guide](https://usechartory.com/docs/installation)

2. **Add the chart.** One command adds the Order book depth component to your project.

```bash
npx shadcn add @chartory/order-book-depth
```

3. **Use it.** Pass your rows. The props are the Figma properties.

usage.tsx:

```tsx
import { OrderBookDepth }
  from "@/components/chartory/order-book-depth"

<OrderBookDepth
  data={btcDepth}
  size="m"
  legend
/>
```

## Props

### `<OrderBookDepth>`

Every prop but data is a Figma property with the same name and values.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | OrderBookDepthData | Required | The chart's data. The tables below list every field. |
| size | "xs" \| "s" \| "m" \| "l" | "m" | The size class. Each one is laid out again from the data. |
| legend | boolean | true | Shows the legend row under the plot. |

### OrderBookDepthData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| bids | [number, number][] | Required | The bids: [price, quantity]. |
| asks | [number, number][] | Required | The asks: [price, quantity]. |
| mid | number | Required | The mid price. |
| min | number | Required | The bottom of the value scale. |
| max | number | Required | The top of the value scale. |
| qmax | number | Required | The top of the quantity scale. |
| ticks | string[] | Required | The axis tick labels. |
| midText | string | Required | The mid price's label. |
| xt | [number, string][] | Required | The x axis ticks: [value, label] pairs. |

## Order book depth chart: a React and Figma chart in four sizes

### What does an order book depth chart show?

An order book depth chart shows cumulative bids on one side of the mid price and asks on the other, so you see how much the price could move before it hits a wall. Use it for exchanges, trading desks and liquidity reviews.

Chartory ships it as a Figma component and a React component with the same name. The code installs from the shadcn registry with one command and lands in your project as a file you own.

### What is the Order book depth component?

It is one **<OrderBookDepth>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is bids and asks with price and cumulative size.

Sizes **XS**, **S**, **M** and **L** re-lay the chart out from the data instead of scaling it, so labels stay readable at every size.

### When should I use it?

- **Are bids and asks shown?** Yes means the order book depth fits.
- **Is it now, not over a day?** Yes means the order book depth fits.
- **Is it one pair?** Yes means the order book depth fits.

### When does another type fit better?

- **Price over time.** Use Candlestick instead.
- **Volume by price over time.** Use Volume profile instead.
- **Many pairs compared.** Use Correlation triangle instead.

## Depth chart questions

### Does the Order book depth chart work with shadcn/ui?

Yes. It installs through the shadcn registry with the shadcn CLI, and the file lands in your project.

### How do I install it?

It is free in Hearth and MIT licensed: add the @chartory registry URL once, no token, then run npx shadcn add @chartory/order-book-depth. The Installation guide has the steps.

### Can my coding agent install it?

Yes. Connect the Chartory MCP server and ask for the order book depth chart; the agent runs the same command and you review the diff.

### What data does it expect?

Bids and asks with price and cumulative size. The sample data comes with the component, and the props table lists every field.

### Which sizes does it ship in?

XS, S, M and L, in Figma and in code. Each size is laid out again from the data, so text and lines keep their size.

### Is it in the Figma file too?

Yes. chart/053-depth-order-book has the same properties as the component.

### Does it follow light and dark mode?

Yes. Every paint is a token, so the chart follows light and dark mode and the collection you pick.

### Which plan has the code?

None for Hearth: it is free in the public registry, no token. The Signal collection (@chartory/signal) comes with Code and Complete.