get_alfred_series {alfred} | R Documentation |
Accessing ALFRED
Description
This function can pull time series from the ALFRED database: https://alfred.stlouisfed.org. Downloading different vintages for performing real-time analysis is provided.
Usage
get_alfred_series(
series_id,
series_name = NULL,
observation_start = NULL,
observation_end = NULL,
realtime_start = NULL,
realtime_end = NULL,
api_key = NULL
)
Arguments
series_id |
FRED times series ID. |
series_name |
Choose a name for the series column in output. Default: series_id. |
observation_start |
Date of first observation in "yyyy-mm-dd" format. Default: Earliest observation available. |
observation_end |
Date of last observation in "yyyy-mm-dd" format. Default: Last observation available. |
realtime_start |
Date of first real time period in "yyyy-mm-dd" format. Default: First vintage date available. |
realtime_end |
Date of last real time period in "yyyy-mm-dd" format. Default: Last vintage date available. |
api_key |
You can supply your own apikey obtained via https://fredaccount.stlouisfed.org/login/secure/) if you want to run a large batch of requests. Otherwise you might run into query limits of the API. |
Details
FRED time series IDs can be found on the respective site in ALFRED, e.g. https://alfred.stlouisfed.org/series?seid=CPIAUCSL.
Examples
## Not run:
get_alfred_series("INDPRO", "indpro")
## End(Not run)
## Not run:
get_alfred_series("INDPRO", "indpro",
realtime_start = "2008-10-31", realtime_end = "2009-10-31")
## End(Not run)