# Volume profile

> Where the trading happened, by price. Sample data: spot price, Oct 8 to now, point of control at 150.5.

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

## 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 Volume profile component to your project.

```bash
npx shadcn add @chartory/volume-profile
```

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

usage.tsx:

```tsx
import { VolumeProfile }
  from "@/components/chartory/volume-profile"

<VolumeProfile
  data={solVolume}
  size="m"
  legend
/>
```

## Props

### `<VolumeProfile>`

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

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| data | VolumeProfileData | 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. |
| color | "cat-1" \| "cat-2" \| "cat-3" \| "cat-4" | "cat-1" | The data colour of the primary marks (data/primary). |

### VolumeProfileData

The data prop: one object for the whole chart.

| Prop | Type | Default | Note |
| --- | --- | --- | --- |
| price | number[] | Required | The prices. |
| vol | number[] | Required | The volume per price level. |
| min | number | Required | The bottom of the value scale. |
| max | number | Required | The top of the value scale. |
| ticks | string[] | Required | The axis tick labels. |
| poc | number | Required | The point of control. |
| va | [number, number] | Required | The value area: [low, high]. |
| xl | Record<number, string> | Required | The x axis labels, by index. |
| pocText? | string | — | The point of control's label. |

## Volume profile chart: a React and Figma chart in four sizes

### What does a volume profile chart show?

A volume profile chart adds a sideways histogram of traded volume at each price next to the price line, with the busiest price and the value area marked. Use it for trading charts where support and resistance levels matter.

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 Volume profile component?

It is one **<VolumeProfile>** component. Its props are the Figma properties with the same names and values, and the props table above lists them. The data is price over time and volume per price level.

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?

- **Is volume by price the point?** Yes means the volume profile fits.
- **Is it a time range?** Yes means the volume profile fits.
- **Is it one asset?** Yes means the volume profile fits.

### When does another type fit better?

- **Price candles per period.** Use Candlestick instead.
- **The order book now.** Use Order book depth instead.
- **Many assets by volume.** Use Packed bubbles instead.

## Volume profile questions

### Does the Volume profile 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/volume-profile. The Installation guide has the steps.

### Can my coding agent install it?

Yes. Connect the Chartory MCP server and ask for the volume profile chart; the agent runs the same command and you review the diff.

### What data does it expect?

Price over time and volume per price level. 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/071-volume-profile-sol 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.
