# Depth Heatmap · Pro

Liquidity across price and time, painted column by column on a canvas, with the traded price traced on top and a readout of depth at the pointer.

This is a Charcoal UI Pro component. Its source and examples are available with a Pro seat: https://charcoalui.com/pricing

## With a Pro seat

1. Add the registry to components.json:

```json
{
  "registries": {
    "@charcoal": {
      "url": "https://charcoalui.com/r/{name}.json",
      "headers": {
        "Authorization": "Bearer ${CHARCOAL_LICENSE_KEY}"
      }
    }
  }
}
```

2. Copy your licence key from https://charcoalui.com/dashboard and put it in .env.local as CHARCOAL_LICENSE_KEY, then:

```bash
npx shadcn@latest add @charcoal/depth-heatmap
```

To read Pro source through this MCP server, reconnect it with the header "Authorization: Bearer <licence key>".

## API — Depth Heatmap
| Prop | Type | Default | Notes |
| --- | --- | --- | --- |
| `grid` | `number[][]` | — | Liquidity per [time][priceLevel]. |
| `price` | `number[]` | — |  |
| `levels` | `string[]` | — |  |
| `height` | `number` | `300` |  |
| `color` | `string` | `"var(--ember)"` |  |

See it live: https://charcoalui.com/docs/components/depth-heatmap