docs/SecurityApi.md in intrinio-sdk-2.1.0 vs docs/SecurityApi.md in intrinio-sdk-2.2.0

- old
+ new

@@ -10,10 +10,41 @@ [**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_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 | Lastest Dividend Record for Security [**get_security_latest_earnings_record**](SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Lastest 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 +[**get_security_price_technicals_adx**](SecurityApi.md#get_security_price_technicals_adx) | **GET** /securities/{identifier}/prices/technicals/adx | Average Directional Index +[**get_security_price_technicals_ao**](SecurityApi.md#get_security_price_technicals_ao) | **GET** /securities/{identifier}/prices/technicals/ao | Awesome Oscillator +[**get_security_price_technicals_atr**](SecurityApi.md#get_security_price_technicals_atr) | **GET** /securities/{identifier}/prices/technicals/atr | Average True Range +[**get_security_price_technicals_bb**](SecurityApi.md#get_security_price_technicals_bb) | **GET** /securities/{identifier}/prices/technicals/bb | Bollinger Bands +[**get_security_price_technicals_cci**](SecurityApi.md#get_security_price_technicals_cci) | **GET** /securities/{identifier}/prices/technicals/cci | Commodity Channel Index +[**get_security_price_technicals_cmf**](SecurityApi.md#get_security_price_technicals_cmf) | **GET** /securities/{identifier}/prices/technicals/cmf | Chaikin Money Flow +[**get_security_price_technicals_dc**](SecurityApi.md#get_security_price_technicals_dc) | **GET** /securities/{identifier}/prices/technicals/dc | Donchian Channel +[**get_security_price_technicals_dpo**](SecurityApi.md#get_security_price_technicals_dpo) | **GET** /securities/{identifier}/prices/technicals/dpo | Detrended Price Oscillator +[**get_security_price_technicals_eom**](SecurityApi.md#get_security_price_technicals_eom) | **GET** /securities/{identifier}/prices/technicals/eom | Ease of Movement +[**get_security_price_technicals_fi**](SecurityApi.md#get_security_price_technicals_fi) | **GET** /securities/{identifier}/prices/technicals/fi | Force Index +[**get_security_price_technicals_ichimoku**](SecurityApi.md#get_security_price_technicals_ichimoku) | **GET** /securities/{identifier}/prices/technicals/ichimoku | Ichimoku Kinko Hyo +[**get_security_price_technicals_kc**](SecurityApi.md#get_security_price_technicals_kc) | **GET** /securities/{identifier}/prices/technicals/kc | Keltner Channel +[**get_security_price_technicals_kst**](SecurityApi.md#get_security_price_technicals_kst) | **GET** /securities/{identifier}/prices/technicals/kst | Know Sure Thing +[**get_security_price_technicals_macd**](SecurityApi.md#get_security_price_technicals_macd) | **GET** /securities/{identifier}/prices/technicals/macd | Moving Average Convergence Divergence +[**get_security_price_technicals_mfi**](SecurityApi.md#get_security_price_technicals_mfi) | **GET** /securities/{identifier}/prices/technicals/mfi | Money Flow Index +[**get_security_price_technicals_mi**](SecurityApi.md#get_security_price_technicals_mi) | **GET** /securities/{identifier}/prices/technicals/mi | Mass Index +[**get_security_price_technicals_nvi**](SecurityApi.md#get_security_price_technicals_nvi) | **GET** /securities/{identifier}/prices/technicals/nvi | Negative Volume Index +[**get_security_price_technicals_obv**](SecurityApi.md#get_security_price_technicals_obv) | **GET** /securities/{identifier}/prices/technicals/obv | On-balance Volume +[**get_security_price_technicals_obv_mean**](SecurityApi.md#get_security_price_technicals_obv_mean) | **GET** /securities/{identifier}/prices/technicals/obv_mean | On-balance Volume Mean +[**get_security_price_technicals_rsi**](SecurityApi.md#get_security_price_technicals_rsi) | **GET** /securities/{identifier}/prices/technicals/rsi | Relative Strength Index +[**get_security_price_technicals_sma**](SecurityApi.md#get_security_price_technicals_sma) | **GET** /securities/{identifier}/prices/technicals/sma | Simple Moving Average +[**get_security_price_technicals_sr**](SecurityApi.md#get_security_price_technicals_sr) | **GET** /securities/{identifier}/prices/technicals/sr | Stochastic Oscillator +[**get_security_price_technicals_trix**](SecurityApi.md#get_security_price_technicals_trix) | **GET** /securities/{identifier}/prices/technicals/trix | Triple Exponential Average +[**get_security_price_technicals_tsi**](SecurityApi.md#get_security_price_technicals_tsi) | **GET** /securities/{identifier}/prices/technicals/tsi | True Strength Index +[**get_security_price_technicals_uo**](SecurityApi.md#get_security_price_technicals_uo) | **GET** /securities/{identifier}/prices/technicals/uo | Ultimate Oscillator +[**get_security_price_technicals_vi**](SecurityApi.md#get_security_price_technicals_vi) | **GET** /securities/{identifier}/prices/technicals/vi | Vortex Indicator +[**get_security_price_technicals_vpt**](SecurityApi.md#get_security_price_technicals_vpt) | **GET** /securities/{identifier}/prices/technicals/vpt | Volume-price Trend +[**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_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 [**screen_securities**](SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities [**search_securities**](SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities @@ -22,10 +53,12 @@ # **get_all_securities** > ApiResponseSecurities get_all_securities(opts) All Securities +Returns all Securities to which you have access. + ### Example ```ruby # Load the gem require 'intrinio-sdk' @@ -77,11 +110,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) begin result = security_api.get_security_by_id(identifier) p result @@ -103,11 +136,11 @@ # **get_security_data_point_number** > Float get_security_data_point_number(identifier, tag) Data Point (Number) for Security -Returns a numeric value for the given `tag` for the Security with the given `identifier` +$$v2_security_data_point_number_description$$ ### Example ```ruby # Load the gem require 'intrinio-sdk' @@ -117,13 +150,13 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_security_data_point_identifier_default$$" # String | $$v2_security_data_point_identifier_description$$ -tag = "52_week_high" # String | An Intrinio data tag ID or code-name +tag = "$$v2_security_data_point_item_number_default$$" # String | $$v2_security_data_point_item_description$$ begin result = security_api.get_security_data_point_number(identifier, tag) p result @@ -134,23 +167,23 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | **String**| $$v2_security_data_point_identifier_description$$ | + **tag** | **String**| $$v2_security_data_point_item_description$$ | ### Return type **Float** # **get_security_data_point_text** > String get_security_data_point_text(identifier, tag) Data Point (Text) for Security -Returns a text value for the given `tag` for the Security with the given `identifier` +$$v2_security_data_point_text_description$$ ### Example ```ruby # Load the gem require 'intrinio-sdk' @@ -160,13 +193,13 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_security_data_point_identifier_default$$" # String | $$v2_security_data_point_identifier_description$$ -tag = "figi" # String | An Intrinio data tag ID or code-name +tag = "$$v2_security_data_point_item_text_default$$" # String | An Intrinio data tag ID or code-name begin result = security_api.get_security_data_point_text(identifier, tag) p result @@ -177,11 +210,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **identifier** | **String**| $$v2_security_data_point_identifier_description$$ | **tag** | **String**| An Intrinio data tag ID or code-name | ### Return type **String** @@ -189,11 +222,11 @@ # **get_security_historical_data** > ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts) Historical Data for Security -Returns historical values for the given `tag` and the Security with the given `identifier` +$$v2_security_historical_data_description$$ ### Example ```ruby # Load the gem require 'intrinio-sdk' @@ -203,13 +236,13 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_security_historical_data_identifier_default$$" # String | $$v2_security_historical_data_identifier_description$$ -tag = "volume" # String | An Intrinio data tag ID or code-name +tag = "$$v2_security_historical_data_item_default$$" # String | $$v2_security_data_point_item_description$$ opts = { frequency: "daily", # String | Return historical data in the given frequency type: nil, # String | Filter by type, when applicable start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date @@ -229,12 +262,12 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | **String**| $$v2_security_historical_data_identifier_description$$ | + **tag** | **String**| $$v2_security_data_point_item_description$$ | **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] @@ -248,11 +281,11 @@ # **get_security_intraday_prices** > ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts) Intraday Stock Prices for Security -Return intraday stock prices for the Security with the given `identifier` +$$v2_security_intraday_prices_description$$ ### Example ```ruby # Load the gem require 'intrinio-sdk' @@ -262,11 +295,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { source: nil, # String | Return intraday prices from the specified data source start_date: Date.parse("2018-01-01"), # Date | Return intraday prices starting at the specified date start_time: "4200", # String | Return intraday prices starting at the specified time on the `start_date` (timezone is UTC) @@ -314,11 +347,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) begin result = security_api.get_security_latest_dividend_record(identifier) p result @@ -354,11 +387,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) begin result = security_api.get_security_latest_earnings_record(identifier) p result @@ -375,10 +408,1672 @@ ### Return type [**EarningsRecord**](EarningsRecord.md) +# **get_security_price_technicals_adi** +> ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts) + +Accumulation/Distribution Index + +Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_adi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_adi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md) + +# **get_security_price_technicals_adtv** +> ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts) + +Average Daily Trading Volume + +Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 22, # Integer | The number of observations, per period, to calculate Average Daily Trading Volume + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_adtv(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_adtv: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md) + +# **get_security_price_technicals_adx** +> ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts) + +Average Directional Index + +Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 14, # Integer | The number of observations, per period, to calculate Average Directional Index + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_adx(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_adx: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md) + +# **get_security_price_technicals_ao** +> ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts) + +Awesome Oscillator + +Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + short_period: 5, # Integer | The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator + long_period: 34, # Integer | The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_ao(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_ao: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **short_period** | **Integer**| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5] + **long_period** | **Integer**| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md) + +# **get_security_price_technicals_atr** +> ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts) + +Average True Range + +Returns the Average True Range values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 14, # Integer | The number of observations, per period, to calculate Average True Range + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_atr(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_atr: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Average True Range | [optional] [default to 14] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md) + +# **get_security_price_technicals_bb** +> ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts) + +Bollinger Bands + +Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 20, # Integer | The number of observations, per period, to calculate Bollinger Bands + standard_deviations: 2.0, # Float | The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands + price_key: "close", # String | The Stock Price field to use when calculating Bollinger Bands + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_bb(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_bb: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20] + **standard_deviations** | **Float**| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0] + **price_key** | **String**| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md) + +# **get_security_price_technicals_cci** +> ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts) + +Commodity Channel Index + +Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 20, # Integer | The number of observations, per period, to calculate Commodity Channel Index + constant: 0.015, # Float | The number of observations, per period, to calculate Commodity Channel Index + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_cci(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_cci: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20] + **constant** | **Float**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md) + +# **get_security_price_technicals_cmf** +> ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts) + +Chaikin Money Flow + +Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 20, # Integer | The number of observations, per period, to calculate Chaikin Money Flow + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_cmf(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_cmf: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md) + +# **get_security_price_technicals_dc** +> ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts) + +Donchian Channel + +Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 20, # Integer | The number of observations, per period, to calculate Donchian Channel + price_key: "close", # String | The Stock Price field to use when calculating Donchian Channel + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_dc(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_dc: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Donchian Channel | [optional] [default to 20] + **price_key** | **String**| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md) + +# **get_security_price_technicals_dpo** +> ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts) + +Detrended Price Oscillator + +Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 20, # Integer | The number of observations, per period, to calculate Detrended Price Oscillator + price_key: "close", # String | The Stock Price field to use when calculating Detrended Price Oscillator + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_dpo(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_dpo: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20] + **price_key** | **String**| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md) + +# **get_security_price_technicals_eom** +> ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts) + +Ease of Movement + +Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 20, # Integer | The number of observations, per period, to calculate Ease of Movement + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_eom(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_eom: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md) + +# **get_security_price_technicals_fi** +> ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts) + +Force Index + +Returns the Force Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_fi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_fi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md) + +# **get_security_price_technicals_ichimoku** +> ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts) + +Ichimoku Kinko Hyo + +Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + low_period: 9, # Integer | The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo + medium_period: 26, # Integer | The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo + high_period: 52, # Integer | The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_ichimoku(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_ichimoku: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **low_period** | **Integer**| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [default to 9] + **medium_period** | **Integer**| The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo | [optional] [default to 26] + **high_period** | **Integer**| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md) + +# **get_security_price_technicals_kc** +> ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts) + +Keltner Channel + +Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 10, # Integer | The number of observations, per period, to calculate Kelter Channel + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_kc(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_kc: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md) + +# **get_security_price_technicals_kst** +> ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts) + +Know Sure Thing + +Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + roc1: 10, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA1 + roc2: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2 + roc3: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2 + roc4: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3 + roc5: 30, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4 + sma1: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 + sma2: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 + sma3: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 + sma4: 15, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 + price_key: "close", # String | The Stock Price field to use when calculating Know Sure Thing + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_kst(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_kst: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **roc1** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10] + **roc2** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15] + **roc3** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15] + **roc4** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20] + **roc5** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30] + **sma1** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 | [optional] [default to 10] + **sma2** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 | [optional] [default to 10] + **sma3** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 | [optional] [default to 10] + **sma4** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 | [optional] [default to 15] + **price_key** | **String**| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md) + +# **get_security_price_technicals_macd** +> ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts) + +Moving Average Convergence Divergence + +Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + fast_period: 12, # Integer | The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence + slow_period: 26, # Integer | The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence + signal_period: 9, # Integer | The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence + price_key: "close", # String | The Stock Price field to use when calculating Moving Average Convergence Divergence + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_macd(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_macd: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **fast_period** | **Integer**| The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 12] + **slow_period** | **Integer**| The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 26] + **signal_period** | **Integer**| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9] + **price_key** | **String**| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md) + +# **get_security_price_technicals_mfi** +> ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts) + +Money Flow Index + +Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 14, # Integer | The number of observations, per period, to calculate Money Flow Index + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_mfi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_mfi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md) + +# **get_security_price_technicals_mi** +> ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts) + +Mass Index + +Returns the Mass Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + ema_period: 9, # Integer | The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index + sum_period: 25, # Integer | The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_mi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_mi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **ema_period** | **Integer**| The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index | [optional] [default to 9] + **sum_period** | **Integer**| The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index | [optional] [default to 25] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md) + +# **get_security_price_technicals_nvi** +> ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts) + +Negative Volume Index + +Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_nvi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_nvi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md) + +# **get_security_price_technicals_obv** +> ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts) + +On-balance Volume + +Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_obv(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_obv: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md) + +# **get_security_price_technicals_obv_mean** +> ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts) + +On-balance Volume Mean + +Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 10, # Integer | The number of observations, per period, to calculate On-balance Volume Mean + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_obv_mean(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_obv_mean: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md) + +# **get_security_price_technicals_rsi** +> ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts) + +Relative Strength Index + +Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 14, # Integer | The number of observations, per period, to calculate Relative Strength Index + price_key: "close", # String | The Stock Price field to use when calculating Relative Strength Index + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_rsi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_rsi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14] + **price_key** | **String**| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md) + +# **get_security_price_technicals_sma** +> ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts) + +Simple Moving Average + +Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 20, # Integer | The number of observations, per period, to calculate Simple Moving Average + price_key: "close", # String | The Stock Price field to use when calculating Simple Moving Average + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_sma(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_sma: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20] + **price_key** | **String**| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md) + +# **get_security_price_technicals_sr** +> ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts) + +Stochastic Oscillator + +Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 14, # Integer | The number of observations, per period, to calculate %K of Stochastic Oscillator + signal_period: 3, # Integer | The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_sr(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_sr: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [default to 14] + **signal_period** | **Integer**| The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator | [optional] [default to 3] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md) + +# **get_security_price_technicals_trix** +> ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts) + +Triple Exponential Average + +Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 15, # Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_trix(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_trix: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md) + +# **get_security_price_technicals_tsi** +> ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts) + +True Strength Index + +Returns the True Strength Index values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + low_period: 13, # Integer | The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index + high_period: 25, # Integer | The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index + price_key: "close", # String | The Stock Price field to use when calculating True Strength Index + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_tsi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_tsi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **low_period** | **Integer**| The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 13] + **high_period** | **Integer**| The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 25] + **price_key** | **String**| The Stock Price field to use when calculating True Strength Index | [optional] [default to close] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md) + +# **get_security_price_technicals_uo** +> ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts) + +Ultimate Oscillator + +Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + short_period: 7, # Integer | The number of observations, per period, to calculate the short period for Ultimate Oscillator + medium_period: 14, # Integer | The number of observations, per period, to calculate the medium period for Ultimate Oscillator + long_period: 28, # Integer | The number of observations, per period, to calculate the long period for Ultimate Oscillator + short_weight: 4.0, # Float | The weight of short Buying Pressure average for Ultimate Oscillator + medium_weight: 2.0, # Float | The weight of medium Buying Pressure average for Ultimate Oscillator + long_weight: 1.0, # Float | The weight of long Buying Pressure average for Ultimate Oscillator + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_uo(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_uo: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **short_period** | **Integer**| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7] + **medium_period** | **Integer**| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14] + **long_period** | **Integer**| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28] + **short_weight** | **Float**| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0] + **medium_weight** | **Float**| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0] + **long_weight** | **Float**| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md) + +# **get_security_price_technicals_vi** +> ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts) + +Vortex Indicator + +Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 14, # Integer | The number of observations, per period, to calculate Vortex Indicator + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_vi(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_vi: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md) + +# **get_security_price_technicals_vpt** +> ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts) + +Volume-price Trend + +Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_vpt(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_vpt: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md) + +# **get_security_price_technicals_vwap** +> ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts) + +Volume Weighted Average Price + +Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_vwap(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_vwap: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **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] + +### Return type + +[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md) + +# **get_security_price_technicals_wr** +> ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts) + +Williams %R + +Returns the Williams %R values of Stock Prices for the Security with the given `identifier` + +### Example +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR API KEY' +end + +security_api = Intrinio::SecurityApi.new + +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) + +opts = { + period: 14, # Integer | The number of observations, per period, to look-back when calculating Williams %R + start_date: "2018-01-01", # String | Return technical indicator values on or after the date + end_date: "2019-01-01", # String | Return technical indicator values on or before the date + page_size: 100, # Float | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_price_technicals_wr(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_price_technicals_wr: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **period** | **Integer**| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14] + **start_date** | **String**| Return technical indicator values on or after the date | [optional] + **end_date** | **String**| Return technical indicator values on or before the date | [optional] + **page_size** | **Float**| 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] + +### Return type + +[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md) + # **get_security_realtime_price** > RealtimeStockPrice get_security_realtime_price(identifier, opts) Realtime Stock Price for Security @@ -394,11 +2089,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { source: nil # String | Return the realtime price from the specified data source } @@ -438,11 +2133,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: Date.parse("2018-01-01"), # Date | Return price adjustments on or after the date end_date: Date.parse("2019-01-01"), # Date | Return price adjustments on or before the date page_size: 100, # Float | The number of results to return @@ -488,10 +2183,10 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: Date.parse("2018-01-01"), # Date | Return prices on or after the date end_date: Date.parse("2019-01-01"), # Date | Return prices on or before the date frequency: "daily", # String | Return stock prices in the given frequency