Compare series
compare_seriesRead-only
Compare 2-5 FRED series by aligning them on a single date axis, with frequency and transform options for accurate comparison.
Instructions
Align 2-5 series on one date axis for comparison.
`series_ids`: 2-5 FRED series IDs. Same `start`/`end`/`transform` as
`get_observations`. If the series have DIFFERENT native frequencies you
must pass `frequency` (a frequency at least as coarse as the coarsest
series) — mixing frequencies without it returns misaligned dates. Units
differ per series unless a relative transform (e.g. pct_change_yoy) is
used — check each entry's `units` before comparing levels.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | ||
| start | No | ||
| frequency | No | ||
| transform | No | level | |
| max_points | No | ||
| series_ids | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rows | Yes | Aligned values, oldest first | |
| series | Yes | The series compared | |
| transform | Yes | The transform applied to every series | |
| truncated | Yes | True if more rows exist than were returned |