docs/SecurityApi.md in intrinio-sdk-5.7.0 vs docs/SecurityApi.md in intrinio-sdk-5.8.0
- old
+ new
@@ -7,10 +7,11 @@
[**get_all_securities**](SecurityApi.md#get_all_securities) | **GET** /securities | All Securities
[**get_security_by_id**](SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Lookup Security
[**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security
[**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security
[**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security
+[**get_security_interval_prices**](SecurityApi.md#get_security_interval_prices) | **GET** /securities/{identifier}/prices/intervals | Interval Stock Prices for Security
[**get_security_intraday_prices**](SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
[**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security
[**get_security_latest_earnings_record**](SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Latest Earnings Record for Security
[**get_security_price_technicals_adi**](SecurityApi.md#get_security_price_technicals_adi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index
[**get_security_price_technicals_adtv**](SecurityApi.md#get_security_price_technicals_adtv) | **GET** /securities/{identifier}/prices/technicals/adtv | Average Daily Trading Volume
@@ -157,11 +158,11 @@
**composite_figi** | String| Return securities with the given Country Composite FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]
**share_class_figi** | String| Return securities with the given Global Share Class FIGI (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]
**figi_unique_id** | String| Return securities with the given FIGI Unique ID (<a href=\"https://www.openfigi.com/about\" target=\"_blank\">reference</a>). | [optional]
**include_non_figi** | BOOLEAN| When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. | [optional] [default to false]
**page_size** | Integer| The number of results to return | [optional] [default to 100]
- **primary_listing** | BOOLEAN| If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange | [optional]
+ **primary_listing** | BOOLEAN| If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange. Returns both if omitted. | [optional]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
@@ -496,9 +497,107 @@
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::SecurityApi)
+
+[//]: # (METHOD:get_security_interval_prices)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityIntervalPrices)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIntervalPrices.md)
+
+[//]: # (OPERATION:get_security_interval_prices_v2)
+
+[//]: # (ENDPOINT:/securities/{identifier}/prices/intervals)
+
+[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_interval_prices)
+
+## **get_security_interval_prices**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_interval_prices_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseSecurityIntervalPrices get_security_interval_prices(identifier, opts)
+
+#### Interval Stock Prices for Security
+
+
+Return Open, High, Low, Close, and Volume for a particular interval for the Security with the given `identifier`
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+require 'pp'
+
+# Setup authorization
+Intrinio.configure do |config|
+ config.api_key['api_key'] = 'YOUR_API_KEY'
+ config.allow_retries = true
+end
+
+security_api = Intrinio::SecurityApi.new
+identifier = "AAPL"
+
+opts = {
+ source: nil,
+ start_date: Date.parse("2018-01-01"),
+ start_time: nil,
+ end_date: Date.parse("2019-01-01"),
+ end_time: nil,
+ timezone: "UTC",
+ interval_size: 1d,
+ page_size: 100,
+ next_page: nil
+}
+
+result = security_api.get_security_interval_prices(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
+ **source** | String| Return intervals from the specified data source | [optional]
+ **start_date** | Date| Return intervals starting at the specified date | [optional]
+ **start_time** | String| Return intervals starting at the specified time on the `start_date` (24-hour in 'hh:mm' format, UTC timezone) | [optional]
+ **end_date** | Date| Return intervals stopping at the specified date | [optional]
+ **end_time** | String| Return intervals stopping at the specified time on the `end_date` (24-hour in 'hh:mm' format, UTC timezone) | [optional]
+ **timezone** | String| Returns trading times in this timezone | [optional] [default to UTC]
+ **interval_size** | String| The interval for which to return stock prices | [optional] [default to 1d]
+ **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]
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseSecurityIntervalPrices**](ApiResponseSecurityIntervalPrices.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)