symbol | str | For this function, it is the series_group ID or series ID. If the symbol provided is for a series_group, set the is_series_group parameter to True. Not all series that are in FRED have geographical data. | | False |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
limit | int | The number of data entries to return. | 100000 | True |
provider | Literal['fred'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fred' if there is no default. | fred | True |
is_series_group | bool | When True, the symbol provided is for a series_group, else it is for a series ID. | False | True |
region_type | Literal['bea', 'msa', 'frb', 'necta', 'state', 'country', 'county', 'censusregion'] | The type of regional data. Parameter is only valid when is_series_group is True. | None | True |
season | Literal['SA', 'NSA', 'SSA'] | The seasonal adjustments to the data. Parameter is only valid when is_series_group is True. | NSA | True |
units | str | The units of the data. This should match the units returned from searching by series ID. An incorrect field will not necessarily return an error. Parameter is only valid when is_series_group is True. | None | True |
frequency | Literal['d', 'w', 'bw', 'm', 'q', 'sa', 'a', 'wef', 'weth', 'wew', 'wetu', 'wem', 'wesu', 'wesa', 'bwew', 'bwem'] | Frequency aggregation to convert high frequency data to lower frequency. Parameter is only valid when is_series_group is True. a = Annual sa= Semiannual q = Quarterly m = Monthly w = Weekly d = Daily 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 | None | True |
aggregation_method | Literal['avg', 'sum', 'eop'] | A key that indicates the aggregation method used for frequency aggregation. This parameter has no affect if the frequency parameter is not set. Only valid when is_series_group is True. avg = Average sum = Sum eop = End of Period | avg | True |
transform | Literal['lin', 'chg', 'ch1', 'pch', 'pc1', 'pca', 'cch', 'cca', 'log'] | Transformation type. Only valid when is_series_group is True. 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 | lin | True |