get_fred_series_observations
Retrieve economic time series observations from the Federal Reserve Bank of St. Louis (FRED) by specifying series ID, date ranges, frequency, and other parameters for data analysis.
Instructions
Get series observations from the Fred API.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
aggregation_method | No | Aggregation method for frequency. Options: 'avg', 'sum', 'eop'. Defaults to 'avg'. | avg |
frequency | No | Frequency of observations. Options: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'. Defaults to no value for no frequency aggregation. | |
limit | No | Maximum number of observations to return. Defaults to 10. | |
observation_end | No | End date of observations. Format: YYYY-MM-DD. | |
observation_start | No | Start date of observations. Format: YYYY-MM-DD. | |
offset | No | Number of observations to offset from first. Defaults to 0. | |
output_type | No | Output type of observations. Options: 1, 2, 3, 4. Defaults to 1. | |
realtime_end | No | The end of the real-time period. Format: YYYY-MM-DD. Defaults to today's date. | |
realtime_start | No | The start of the real-time period. Format: YYYY-MM-DD. Defaults to today's date. | |
series_id | Yes | The id for a series. | |
sort_order | No | Sort order of observations. Options: 'asc' or 'desc'. Defaults to 'asc'. | asc |
units | No | Data value transformation. Options: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'. Defaults to 'lin'. | lin |
vintage_dates | No | Comma-separated list of vintage dates. |