Get observations
get_observationsRead-only
Get current post-revision observations for a FRED series within a date window, with optional transformations or frequency aggregation.
Instructions
A series' values in a date window, optionally transformed/downsampled.
`series_id`: a FRED series ID. `start`/`end`: ISO dates bounding the
window. `transform`: level | change | pct_change | pct_change_yoy | log.
`frequency`: optionally downsample to daily/weekly/monthly/quarterly/
semiannual/annual (with `aggregation` avg | sum | eop); only coarser than
the native frequency is valid. `max_points` caps the result, keeping the
most RECENT points (`truncated` tells you when the cap bit).
Values are CURRENT (post-revision) data. For numbers as originally
published, use `get_series_as_of` / `get_revision_history`.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| series_id | Yes | ||
| start | No | ||
| end | No | ||
| transform | No | level | |
| frequency | No | ||
| aggregation | No | avg | |
| max_points | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| series_id | Yes | The FRED series ID | |
| title | Yes | Series title | |
| units | Yes | Units of the VALUES RETURNED — the native units when transform='level', otherwise the transform (e.g. '% change from year ago') | |
| transform | Yes | The transform applied (level if none) | |
| frequency | Yes | Frequency of the values returned | |
| observations | Yes | The data points, oldest first | |
| truncated | Yes | True if more observations exist than were returned — narrow the date range or raise max_points for more |