FRED — Get Series Observations
fred_get_fred_series_observationsFRED — Get Series Observations Uses the caller's OpenAny gateway credentials. Charges and authorization are determined by the gateway.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | The maximum number of results to return. integer between 1 and 100000, optional, default: 100000 | |
| units | No | A key that indicates a data value transformation. string, optional, default: lin (No transformation) One of the following values: 'lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log' lin = Levels (No transformation) chg = Change ch1 = Change from Year Ago pch = Percent Change pc1 = Percent Change from Year Ago pca = Compounded Annual Rate of Change cch = Continuously Compounded Rate of Change cca = Continuously Compounded Annual Rate of Change log = Natural Log For unit transformation formulas, see: https://alfred.stlouisfed.org/help#growth_formulas | |
| offset | No | non-negative integer, optional, default: 0 | |
| file_type | Yes | A key or file extension that indicates the type of file to send. string, optional, default: xml One of the following values: 'xml', 'json', 'xlsx', 'csv' xml = Extensible Markup Language json = JavaScript Object Notation xlsx = Excel Spreadsheet csv = Comma-Separated Values Text Format (File is returned as compressed zip file. The zip file contains the specified file format csv and a text README file.) OpenAny import profile requires json explicitly; original XML/download formats remain in official documentation. | |
| frequency | No | An optional parameter that indicates a lower frequency to aggregate values to. The FRED frequency aggregation feature converts higher frequency data series into lower frequency data series (e.g. converts a monthly data series into an annual data series). In FRED, the highest frequency data is daily, and the lowest frequency data is annual. There are 3 aggregation methods available- average, sum, and end of period. See the aggregation_method parameter. string, optional, default: no value for no frequency aggregation One of the following values: 'd', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem' Frequencies without period descriptions: d = Daily w = Weekly bw = Biweekly m = Monthly q = Quarterly sa = Semiannual a = Annual Frequencies with period descriptions: wef = Weekly, Ending Friday weth = Weekly, Ending Thursday wew = Weekly, Ending Wednesday wetu = Weekly, Ending Tuesday wem = Weekly, Ending Monday wesu = Weekly, Ending Sunday wesa = Weekly, Ending Saturday bwew = Biweekly, Ending Wednesday bwem = Biweekly, Ending Monday Note that an error will be returned if a frequency is specified that is higher than the native frequency of the series. For instance if a series has the native frequency 'Monthly' (as returned by the fred/series request), it is not possible to aggregate the series to the higher 'Daily' frequency using the frequency parameter value 'd'. No frequency aggregation will occur if the frequency specified by the frequency parameter matches the native frequency [Import field summary truncated to fit the backend description limit. Complete original text is retained in officialOperation.parameters[].originalText and the documentation.] | |
| series_id | Yes | The id for a series. string, required | |
| sort_order | No | Sort results is ascending or descending observation_date order. One of the following strings: 'asc', 'desc'. optional, default: asc | |
| output_type | No | An integer that indicates an output type. integer, optional, default: 1 One of the following values: '1', '2', '3', '4' 1 = Observations by Real-Time Period 2 = Observations by Vintage Date, All Observations 3 = Observations by Vintage Date, New and Revised Observations Only 4 = Observations, Initial Release Only For output types '2' and '3', some XML attribute names start with the series ID which may have a first character that is a number (i.e. 0 through 9). In this case only, the XML attribute name starts with an underscore then the series ID in order to avoid invalid XML. If the series ID starts with a letter (i.e. A through Z) then an underscore is not prepended. For more information, read: https://alfred.stlouisfed.org/help/downloaddata#outputformats | |
| realtime_end | No | The end of the real-time period. For more information, see Real-Time Periods, vintage_dates. YYYY-MM-DD formatted string, optional, default: today's date | |
| vintage_dates | No | A comma separated string of YYYY-MM-DD formatted dates in history (e.g. 2000-01-01,2005-02-24). Vintage dates are used to download data as it existed on these specified dates in history. Vintage dates can be specified instead of a real-time period using realtime_start and realtime_end. Sometimes it may be useful to enter a vintage date that is not a date when the data values were revised. For instance you may want to know the latest available revisions on a particular date. Entering a vintage date is also useful to compare series on different releases with different release dates. string, optional, no vintage dates are set by default. Your query will be limited to a specific number of vintage dates depending on the series_id, file_type and output_type specified. output_type=2, series_id=USRECD: 110 csv, 55 xlsx output_type=2, any daily series: 450 csv, 225 xlsx any output_type or other series: 1000 csv, 1000 xlsx, 2000 json, 2000 xml | |
| realtime_start | No | The start of the real-time period. For more information, see Real-Time Periods, vintage_dates. YYYY-MM-DD formatted string, optional, default: today's date | |
| observation_end | No | The end of the observation period. YYYY-MM-DD formatted string, optional, default: 9999-12-31 (latest available) | |
| observation_start | No | The start of the observation period. YYYY-MM-DD formatted string, optional, default: 1776-07-04 (earliest available) | |
| aggregation_method | No | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. string, optional, default: avg One of the following values: 'avg', 'sum', 'eop' avg = Average sum = Sum eop = End of Period |