Catalog

Get one chart's full API surface

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.

get/api/charts/{slug}.json

Request

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

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
Example:sparkline

The chart's slug, as listed by listCharts.

Response

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

packagestring required
homepagestring uri
howToReadstring required
apistring uri
docsstring uri
markdownstring uri
sharedPropsSharedProps required(unresolved $ref)
chartItems required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.