docs/HistoricalDataApi.md in intrinio-sdk-3.0.0 vs docs/HistoricalDataApi.md in intrinio-sdk-3.1.0
- old
+ new
@@ -5,25 +5,55 @@
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_historical_data**](HistoricalDataApi.md#get_historical_data) | **GET** /historical_data/{identifier}/{tag} | Historical Data
-# **get_historical_data**
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::HistoricalDataApi)
+
+[//]: # (METHOD:get_historical_data)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseHistoricalData)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseHistoricalData.md)
+
+[//]: # (OPERATION:get_historical_data_v2)
+
+[//]: # (ENDPOINT:/historical_data/{identifier}/{tag})
+
+[//]: # (DOCUMENT_LINK:HistoricalDataApi.md#get_historical_data)
+
+## **get_historical_data**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_historical_data_v2)
+
+[//]: # (START_OVERVIEW)
+
> ApiResponseHistoricalData get_historical_data(identifier, tag, opts)
-Historical Data
+#### Historical Data
+
Returns historical values for the given `tag` and the entity represented by the given `identifier`
+[//]: # (END_OVERVIEW)
+
### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
```ruby
# Load the gem
require 'intrinio-sdk'
# Setup authorization
Intrinio.configure do |config|
- config.api_key['api_key'] = 'YOUR API KEY'
+ config.api_key['api_key'] = 'YOUR_API_KEY'
end
historicalData_api = Intrinio::HistoricalDataApi.new
identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
@@ -46,23 +76,35 @@
rescue Intrinio::ApiError => e
puts "Exception when calling HistoricalDataApi->get_historical_data: #{e}"
end
```
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
### Parameters
+[//]: # (START_PARAMETERS)
+
+
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **identifier** | **String**| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |
- **tag** | **String**| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
- **frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily]
- **type** | **String**| Filter by type, when applicable | [optional]
- **start_date** | **Date**| Get historical data on or after this date | [optional]
- **end_date** | **Date**| Get historical date on or before this date | [optional]
- **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
- **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
- **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
+ **identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |
+ **tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
+ **frequency** | String| Return historical data in the given frequency | [optional] [default to daily]
+ **type** | String| Filter by type, when applicable | [optional]
+ **start_date** | Date| Get historical data on or after this date | [optional]
+ **end_date** | Date| Get historical date on or before this date | [optional]
+ **sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]
+<br/>
+[//]: # (END_PARAMETERS)
+
### Return type
[**ApiResponseHistoricalData**](ApiResponseHistoricalData.md)
+
+[//]: # (END_OPERATION)