---
title: "Get one chart's full API surface"
method: GET
path: "/api/charts/{slug}.json"
tags: ["Catalog"]
---

# Get one chart's full API surface

`GET /api/charts/{slug}.json`

## Request

- Base URL: `https://microcharts.dev`
- URL: `https://microcharts.dev/api/charts/{slug}.json`
- Auth: none declared

The chart's catalog entry, its shared props, and the instructions for combining the two. Self-contained: this is everything needed to write a correct chart, in about 8 kB rather than the 290 kB of the full catalog.

## Path parameters

- `slug` 'ab-strips' | 'activity-grid' | 'balance-beam' | 'benchmark-strip' | 'bias-strip' | 'breathing-dot' | 'bubble-row' | 'bullet' | 'bump-strip' | 'burn-chart' | 'calendar-strip' | 'calibration-strip' | 'change-point' | 'city-skyline' | 'cohort-triangle' | 'comet-trail' | 'confusion-grid' | 'constellation' | 'control-strip' | 'coverage-strip' | 'cycle-plot' | 'data-diff' | 'delta' | 'depth-wedge' | 'dice-pips' | 'dot-plot' | 'dual-sparkline' | 'dual-window-meter' | 'dumbbell' | 'ensemble-ghosts' | 'error-budget' | 'eta-bar' | 'event-raster' | 'event-timeline' | 'fat-digits' | 'fill-word' | 'folded-day-band' | 'forecast-cone' | 'funnel' | 'garden-grid' | 'grade-profile' | 'graded-band' | 'heartbeat-blip' | 'heat-cell' | 'heat-strip' | 'histogram-strip' | 'honeycomb' | 'horizon' | 'hourglass' | 'hypnogram' | 'icon-array' | 'likert-strip' | 'micro-box' | 'micro-donut' | 'micro-scatter' | 'mini-bar' | 'minimap-strip' | 'moon-phase' | 'music-staff' | 'net-flow' | 'ohlc' | 'orbit-status' | 'paired-bars' | 'pareto-strip' | 'partition-strip' | 'percentile-ladder' | 'percentile-trace' | 'phase-trace' | 'pictogram-row' | 'polar-clock' | 'progress' | 'progress-ring' | 'quadrant-dot' | 'quantile-dots' | 'queue-depth' | 'rate-volume' | 'retention-curve' | 'rubric-strip' | 'rug-strip' | 'segmented-bar' | 'seismogram' | 'shift-histogram' | 'slope' | 'sparkbar' | 'sparkline' | 'spiral-year' | 'spread-band' | 'sprout-row' | 'stacked-area' | 'star-spoke' | 'station-glyph' | 'status-dot' | 'streak-spark' | 'tally-marks' | 'tape-gauge' | 'thermometer' | 'time-in-range' | 'token-confidence' | 'trace-fold' | 'tree-rings' | 'trend-arrow' | 'volume-profile' | 'waterfall' | 'waveform' | 'win-prob-worm' | 'wind-barb', required

## Response `200`

The chart's props, imports, data shape, and caveats.

- ChartDocument: One chart's full API surface. A chart's props are `sharedProps` plus `chart.props`; `howToRead` states how they combine.
  - `package` string, required
  - `homepage` string, uri
  - `howToRead` string, required
  - `api` string, uri
  - `docs` string, uri
  - `markdown` string, uri
  - `sharedProps` SharedProps, required (unresolved $ref)
  - `chart` Items, required (unresolved $ref)

## Other responses

- `404`: Nothing is published at this URL. The body names the closest matching URLs and the site's entry points.

---

[API](https://skmtc.dev/microcharts/apis/microcharts-dev.md) · [All operations](https://skmtc.dev/microcharts/apis/microcharts-dev/llms.txt) · [OpenAPI document](https://skmtc.dev/microcharts/apis/microcharts-dev/revisions/10c7325c48bc?raw)