intrinio-sdk 5.19.0 → 6.21.0

data/docs/SecurityApi.md

@@ -46,6 +46,7 @@ Method | HTTP request | Description
 [**get_security_price_technicals_vwap**](SecurityApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
 [**get_security_price_technicals_wr**](SecurityApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
 [**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
+[**get_security_snapshots**](SecurityApi.md#get_security_snapshots) | **GET** /securities/snapshots | Realtime Stock Prices Snapshot
 [**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
 [**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
 [**get_security_zacks_analyst_ratings**](SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security
@@ -86,7 +87,7 @@ Method | HTTP request | Description
 #### All Securities
 
 
-Returns all Securities to which you have access. When parameters are specified, returns matching Securities.
+Returns a list of all securities available. Delisted securities included.
 
 [//]: # (END_OVERVIEW)
 
@@ -202,7 +203,7 @@ Name | Type | Description  | Notes
 #### Lookup Security
 
 
-Returns the Security with the given `identifier`
+Returns security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.
 
 [//]: # (END_OVERVIEW)
 
@@ -956,7 +957,7 @@ Name | Type | Description  | Notes
 #### Accumulation/Distribution Index
 
 
-Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
+The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock`s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.
 
 [//]: # (END_OVERVIEW)
 
@@ -1044,7 +1045,7 @@ Name | Type | Description  | Notes
 #### Average Daily Trading Volume
 
 
-Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
+Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.
 
 [//]: # (END_OVERVIEW)
 
@@ -1134,7 +1135,7 @@ Name | Type | Description  | Notes
 #### Average Directional Index
 
 
-Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
+The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).
 
 [//]: # (END_OVERVIEW)
 
@@ -1224,7 +1225,7 @@ Name | Type | Description  | Notes
 #### Awesome Oscillator
 
 
-Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
+The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period`s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.
 
 [//]: # (END_OVERVIEW)
 
@@ -1316,7 +1317,7 @@ Name | Type | Description  | Notes
 #### Average True Range
 
 
-Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
+The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.
 
 [//]: # (END_OVERVIEW)
 
@@ -1406,7 +1407,7 @@ Name | Type | Description  | Notes
 #### Bollinger Bands
 
 
-Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
+Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying`s price moves towards the upper band and oversold as the underlying price moves towards the lower band.
 
 [//]: # (END_OVERVIEW)
 
@@ -1500,7 +1501,7 @@ Name | Type | Description  | Notes
 #### Commodity Channel Index
 
 
-Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
+The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.
 
 [//]: # (END_OVERVIEW)
 
@@ -1592,7 +1593,7 @@ Name | Type | Description  | Notes
 #### Chaikin Money Flow
 
 
-Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
+The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.
 
 [//]: # (END_OVERVIEW)
 
@@ -1682,7 +1683,7 @@ Name | Type | Description  | Notes
 #### Donchian Channel
 
 
-Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
+The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).
 
 [//]: # (END_OVERVIEW)
 
@@ -1774,7 +1775,7 @@ Name | Type | Description  | Notes
 #### Detrended Price Oscillator
 
 
-Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
+The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.
 
 [//]: # (END_OVERVIEW)
 
@@ -1866,7 +1867,7 @@ Name | Type | Description  | Notes
 #### Ease of Movement
 
 
-Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
+The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol`s price is rising with relative ease and negative value indicates the underlying symbol`s price is failing with relative ease.
 
 [//]: # (END_OVERVIEW)
 
@@ -1956,7 +1957,7 @@ Name | Type | Description  | Notes
 #### Force Index
 
 
-Returns the Force Index values of Stock Prices for the Security with the given `identifier`
+The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol`s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.
 
 [//]: # (END_OVERVIEW)
 
@@ -2044,7 +2045,7 @@ Name | Type | Description  | Notes
 #### Ichimoku Kinko Hyo
 
 
-Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
+The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.
 
 [//]: # (END_OVERVIEW)
 
@@ -2138,7 +2139,7 @@ Name | Type | Description  | Notes
 #### Keltner Channel
 
 
-Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
+The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.
 
 [//]: # (END_OVERVIEW)
 
@@ -2228,7 +2229,7 @@ Name | Type | Description  | Notes
 #### Know Sure Thing
 
 
-Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
+The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.
 
 [//]: # (END_OVERVIEW)
 
@@ -2334,7 +2335,7 @@ Name | Type | Description  | Notes
 #### Moving Average Convergence Divergence
 
 
-Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
+Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security`s price.
 
 [//]: # (END_OVERVIEW)
 
@@ -2430,7 +2431,7 @@ Name | Type | Description  | Notes
 #### Money Flow Index
 
 
-Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
+The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.
 
 [//]: # (END_OVERVIEW)
 
@@ -2520,7 +2521,7 @@ Name | Type | Description  | Notes
 #### Mass Index
 
 
-Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
+The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.
 
 [//]: # (END_OVERVIEW)
 
@@ -2612,7 +2613,7 @@ Name | Type | Description  | Notes
 #### Negative Volume Index
 
 
-Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
+The negative volume index (NVI) is often referred to as the `smart money indicator.` It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.
 
 [//]: # (END_OVERVIEW)
 
@@ -2700,7 +2701,7 @@ Name | Type | Description  | Notes
 #### On-balance Volume
 
 
-Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
+On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
 
 [//]: # (END_OVERVIEW)
 
@@ -2788,7 +2789,7 @@ Name | Type | Description  | Notes
 #### On-balance Volume Mean
 
 
-Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
+On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period.  When both OBVM and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
 
 [//]: # (END_OVERVIEW)
 
@@ -2878,7 +2879,7 @@ Name | Type | Description  | Notes
 #### Relative Strength Index
 
 
-Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
+Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.
 
 [//]: # (END_OVERVIEW)
 
@@ -2970,7 +2971,7 @@ Name | Type | Description  | Notes
 #### Simple Moving Average
 
 
-Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
+A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal`s abilities.
 
 [//]: # (END_OVERVIEW)
 
@@ -3062,7 +3063,7 @@ Name | Type | Description  | Notes
 #### Stochastic Oscillator
 
 
-Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
+The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period`s high-low range and vice versa if the reading is below 20.
 
 [//]: # (END_OVERVIEW)
 
@@ -3154,7 +3155,7 @@ Name | Type | Description  | Notes
 #### Triple Exponential Average
 
 
-Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
+The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security`s moving average, the TEA  filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.
 
 [//]: # (END_OVERVIEW)
 
@@ -3244,7 +3245,7 @@ Name | Type | Description  | Notes
 #### True Strength Index
 
 
-Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
+The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.
 
 [//]: # (END_OVERVIEW)
 
@@ -3338,7 +3339,7 @@ Name | Type | Description  | Notes
 #### Ultimate Oscillator
 
 
-Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
+The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO`s value is above 70 a security is categorized as overbought and when UO`s value is below 30 a security is categorized as oversold.
 
 [//]: # (END_OVERVIEW)
 
@@ -3438,7 +3439,7 @@ Name | Type | Description  | Notes
 #### Vortex Indicator
 
 
-Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
+The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.
 
 [//]: # (END_OVERVIEW)
 
@@ -3528,7 +3529,7 @@ Name | Type | Description  | Notes
 #### Volume-price Trend
 
 
-Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
+The volume price trend (VPT) is a technical indicator that uses price & volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.
 
 [//]: # (END_OVERVIEW)
 
@@ -3616,7 +3617,7 @@ Name | Type | Description  | Notes
 #### Volume Weighted Average Price
 
 
-Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
+Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security`s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.
 
 [//]: # (END_OVERVIEW)
 
@@ -3704,7 +3705,7 @@ Name | Type | Description  | Notes
 #### Williams %R
 
 
-Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
+Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.
 
 [//]: # (END_OVERVIEW)
 
@@ -3847,6 +3848,86 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::SecurityApi)
+
+[//]: # (METHOD:get_security_snapshots)
+
+[//]: # (RETURN_TYPE:Intrinio::SecuritySnapshotsResult)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:SecuritySnapshotsResult.md)
+
+[//]: # (OPERATION:get_security_snapshots_v2)
+
+[//]: # (ENDPOINT:/securities/snapshots)
+
+[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_snapshots)
+
+## **get_security_snapshots**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_snapshots_v2)
+
+[//]: # (START_OVERVIEW)
+
+> SecuritySnapshotsResult get_security_snapshots(opts)
+
+#### Realtime Stock Prices Snapshot
+
+
+Returns all security snapshots for the queried interval with links to download.
+
+[//]: # (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
+
+opts = {
+  at_datetime: DateTime.parse(nil)
+}
+
+result = security_api.get_security_snapshots(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **at_datetime** | DateTime| The UTC date and time (with url-encoded spaces) the snapshot will cover. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**SecuritySnapshotsResult**](SecuritySnapshotsResult.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::SecurityApi)
@@ -4519,7 +4600,7 @@ Name | Type | Description  | Notes
 #### Search Securities
 
 
-Searches for Securities matching the text `query`
+Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.
 
 [//]: # (END_OVERVIEW)
 

data/docs/SecuritySnapshotGroup.md

@@ -0,0 +1,21 @@
+
+
+[//]: # (CLASS:Intrinio::SecuritySnapshotGroup)
+
+[//]: # (KIND:object)
+
+### Intrinio::SecuritySnapshotGroup
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**time** | DateTime | The UTC timestamp of this snapshot group.  
+**files** | Array<Object> | List of all the snapshot parts of this group.  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/SecuritySnapshotsResult.md

@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:Intrinio::SecuritySnapshotsResult)
+
+[//]: # (KIND:object)
+
+### Intrinio::SecuritySnapshotsResult
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**snapshots** | [**Array<SecuritySnapshotGroup>**](SecuritySnapshotGroup.md) | List of all the snapshot groups comprising the queried result.  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::SecuritySnapshotGroup)
+
+
+