Historical Data for an Economic Index

Historical Data for an Economic Index R API Documentation

Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.

API Class:
IntrinioSDK::IndexApi
Instance Method:
get_economic_index_historical_data()

Stock Price Code Example

Use my API Key
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
IndexApi <- IntrinioSDK::IndexApi$new(client)
# Required params
identifier <- "$GDP"
tag <- "level"
# Optional params
opts <- list(
type = NULL,
start_date = as.Date("2018-01-01"),
end_date = NULL,
sort_order = "desc",
page_size = 100,
next_page = NULL
)
response <- IndexApi$get_economic_index_historical_data(identifier, tag, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierCharacterAn Index Identifier (symbol, Intrinio ID) 
tagCharacterAn Intrinio data tag reference 
typeCharacterFilter by type, when applicable[optional]  
start_dateDateGet historical data on or after this date[optional]  
end_dateDateGet historical data on or before this date[optional]  
sort_orderCharacterSort by date `asc` or `desc`[optional] [default to desc]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  
next_pageCharacterGets the next page of data from a previous API call[optional]  


Return Type

object
IntrinioSDK::ApiResponseEconomicIndexHistoricalData

Properties

NameTypeDescription
historical_dataList of HistoricalData 
historical_data_data_frameData FrameData frame representation of historical_data
indexEconomicIndexSummary 
next_pageCharacterThe token required to request the next page of the data. If null, no further results are available.  
object
IntrinioSDK::HistoricalData

Properties

NameTypeDescription
dateDateThe date that the value is present  
valueNumericThe historical value  
object
IntrinioSDK::EconomicIndexSummary

Properties

NameTypeDescription
idCharacterThe Intrinio ID for the Index  
symbolCharacterThe symbol used to identify the Index  
nameCharacterThe name of the Index  
continentCharacterThe continent of the country of focus for the Index  
countryCharacterThe country of focus for the Index  
update_frequencyCharacterHow often the Index is updated  
last_updatedPOSIXltWhen the Index was updated last  
observation_startDateThe earliest date for which data is available  
observation_endDateThe latest date for which data is available  
seasonal_adjustmentCharacterWhether the data is adjusted to account for seasonality  
unitsCharacterThe units of the data