# Intrinio::TechnicalApi
All URIs are relative to *https://api-v2.intrinio.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_crypto_price_technicals_adi**](TechnicalApi.md#get_crypto_price_technicals_adi) | **GET** /crypto/prices/technicals/adi | Accumulation/Distribution Index
[**get_crypto_price_technicals_adtv**](TechnicalApi.md#get_crypto_price_technicals_adtv) | **GET** /crypto/prices/technicals/adtv | Average Daily Trading Volume
[**get_crypto_price_technicals_adx**](TechnicalApi.md#get_crypto_price_technicals_adx) | **GET** /crypto/prices/technicals/adx | Average Directional Index
[**get_crypto_price_technicals_ao**](TechnicalApi.md#get_crypto_price_technicals_ao) | **GET** /crypto/prices/technicals/ao | Awesome Oscillator
[**get_crypto_price_technicals_atr**](TechnicalApi.md#get_crypto_price_technicals_atr) | **GET** /crypto/prices/technicals/atr | Average True Range
[**get_crypto_price_technicals_bb**](TechnicalApi.md#get_crypto_price_technicals_bb) | **GET** /crypto/prices/technicals/bb | Bollinger Bands
[**get_crypto_price_technicals_cci**](TechnicalApi.md#get_crypto_price_technicals_cci) | **GET** /crypto/prices/technicals/cci | Commodity Channel Index
[**get_crypto_price_technicals_cmf**](TechnicalApi.md#get_crypto_price_technicals_cmf) | **GET** /crypto/prices/technicals/cmf | Chaikin Money Flow
[**get_crypto_price_technicals_dc**](TechnicalApi.md#get_crypto_price_technicals_dc) | **GET** /crypto/prices/technicals/dc | Donchian Channel
[**get_crypto_price_technicals_dpo**](TechnicalApi.md#get_crypto_price_technicals_dpo) | **GET** /crypto/prices/technicals/dpo | Detrended Price Oscillator
[**get_crypto_price_technicals_eom**](TechnicalApi.md#get_crypto_price_technicals_eom) | **GET** /crypto/prices/technicals/eom | Ease of Movement
[**get_crypto_price_technicals_fi**](TechnicalApi.md#get_crypto_price_technicals_fi) | **GET** /crypto/prices/technicals/fi | Force Index
[**get_crypto_price_technicals_ichimoku**](TechnicalApi.md#get_crypto_price_technicals_ichimoku) | **GET** /crypto/prices/technicals/ichimoku | Ichimoku Kinko Hyo
[**get_crypto_price_technicals_kc**](TechnicalApi.md#get_crypto_price_technicals_kc) | **GET** /crypto/prices/technicals/kc | Keltner Channel
[**get_crypto_price_technicals_kst**](TechnicalApi.md#get_crypto_price_technicals_kst) | **GET** /crypto/prices/technicals/kst | Know Sure Thing
[**get_crypto_price_technicals_macd**](TechnicalApi.md#get_crypto_price_technicals_macd) | **GET** /crypto/prices/technicals/macd | Moving Average Convergence Divergence
[**get_crypto_price_technicals_mfi**](TechnicalApi.md#get_crypto_price_technicals_mfi) | **GET** /crypto/prices/technicals/mfi | Money Flow Index
[**get_crypto_price_technicals_mi**](TechnicalApi.md#get_crypto_price_technicals_mi) | **GET** /crypto/prices/technicals/mi | Mass Index
[**get_crypto_price_technicals_nvi**](TechnicalApi.md#get_crypto_price_technicals_nvi) | **GET** /crypto/prices/technicals/nvi | Negative Volume Index
[**get_crypto_price_technicals_obv**](TechnicalApi.md#get_crypto_price_technicals_obv) | **GET** /crypto/prices/technicals/obv | On-balance Volume
[**get_crypto_price_technicals_obv_mean**](TechnicalApi.md#get_crypto_price_technicals_obv_mean) | **GET** /crypto/prices/technicals/obv_mean | On-balance Volume Mean
[**get_crypto_price_technicals_rsi**](TechnicalApi.md#get_crypto_price_technicals_rsi) | **GET** /crypto/prices/technicals/rsi | Relative Strength Index
[**get_crypto_price_technicals_sma**](TechnicalApi.md#get_crypto_price_technicals_sma) | **GET** /crypto/prices/technicals/sma | Simple Moving Average
[**get_crypto_price_technicals_sr**](TechnicalApi.md#get_crypto_price_technicals_sr) | **GET** /crypto/prices/technicals/sr | Stochastic Oscillator
[**get_crypto_price_technicals_trix**](TechnicalApi.md#get_crypto_price_technicals_trix) | **GET** /crypto/prices/technicals/trix | Triple Exponential Average
[**get_crypto_price_technicals_tsi**](TechnicalApi.md#get_crypto_price_technicals_tsi) | **GET** /crypto/prices/technicals/tsi | True Strength Index
[**get_crypto_price_technicals_uo**](TechnicalApi.md#get_crypto_price_technicals_uo) | **GET** /crypto/prices/technicals/uo | Ultimate Oscillator
[**get_crypto_price_technicals_vi**](TechnicalApi.md#get_crypto_price_technicals_vi) | **GET** /crypto/prices/technicals/vi | Vortex Indicator
[**get_crypto_price_technicals_vpt**](TechnicalApi.md#get_crypto_price_technicals_vpt) | **GET** /crypto/prices/technicals/vpt | Volume-price Trend
[**get_crypto_price_technicals_vwap**](TechnicalApi.md#get_crypto_price_technicals_vwap) | **GET** /crypto/prices/technicals/vwap | Volume Weighted Average Price
[**get_crypto_price_technicals_wr**](TechnicalApi.md#get_crypto_price_technicals_wr) | **GET** /crypto/prices/technicals/wr | Williams %R
[**get_security_price_technicals_adi**](TechnicalApi.md#get_security_price_technicals_adi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index
[**get_security_price_technicals_adtv**](TechnicalApi.md#get_security_price_technicals_adtv) | **GET** /securities/{identifier}/prices/technicals/adtv | Average Daily Trading Volume
[**get_security_price_technicals_adx**](TechnicalApi.md#get_security_price_technicals_adx) | **GET** /securities/{identifier}/prices/technicals/adx | Average Directional Index
[**get_security_price_technicals_ao**](TechnicalApi.md#get_security_price_technicals_ao) | **GET** /securities/{identifier}/prices/technicals/ao | Awesome Oscillator
[**get_security_price_technicals_atr**](TechnicalApi.md#get_security_price_technicals_atr) | **GET** /securities/{identifier}/prices/technicals/atr | Average True Range
[**get_security_price_technicals_bb**](TechnicalApi.md#get_security_price_technicals_bb) | **GET** /securities/{identifier}/prices/technicals/bb | Bollinger Bands
[**get_security_price_technicals_cci**](TechnicalApi.md#get_security_price_technicals_cci) | **GET** /securities/{identifier}/prices/technicals/cci | Commodity Channel Index
[**get_security_price_technicals_cmf**](TechnicalApi.md#get_security_price_technicals_cmf) | **GET** /securities/{identifier}/prices/technicals/cmf | Chaikin Money Flow
[**get_security_price_technicals_dc**](TechnicalApi.md#get_security_price_technicals_dc) | **GET** /securities/{identifier}/prices/technicals/dc | Donchian Channel
[**get_security_price_technicals_dpo**](TechnicalApi.md#get_security_price_technicals_dpo) | **GET** /securities/{identifier}/prices/technicals/dpo | Detrended Price Oscillator
[**get_security_price_technicals_eom**](TechnicalApi.md#get_security_price_technicals_eom) | **GET** /securities/{identifier}/prices/technicals/eom | Ease of Movement
[**get_security_price_technicals_fi**](TechnicalApi.md#get_security_price_technicals_fi) | **GET** /securities/{identifier}/prices/technicals/fi | Force Index
[**get_security_price_technicals_ichimoku**](TechnicalApi.md#get_security_price_technicals_ichimoku) | **GET** /securities/{identifier}/prices/technicals/ichimoku | Ichimoku Kinko Hyo
[**get_security_price_technicals_kc**](TechnicalApi.md#get_security_price_technicals_kc) | **GET** /securities/{identifier}/prices/technicals/kc | Keltner Channel
[**get_security_price_technicals_kst**](TechnicalApi.md#get_security_price_technicals_kst) | **GET** /securities/{identifier}/prices/technicals/kst | Know Sure Thing
[**get_security_price_technicals_macd**](TechnicalApi.md#get_security_price_technicals_macd) | **GET** /securities/{identifier}/prices/technicals/macd | Moving Average Convergence Divergence
[**get_security_price_technicals_mfi**](TechnicalApi.md#get_security_price_technicals_mfi) | **GET** /securities/{identifier}/prices/technicals/mfi | Money Flow Index
[**get_security_price_technicals_mi**](TechnicalApi.md#get_security_price_technicals_mi) | **GET** /securities/{identifier}/prices/technicals/mi | Mass Index
[**get_security_price_technicals_nvi**](TechnicalApi.md#get_security_price_technicals_nvi) | **GET** /securities/{identifier}/prices/technicals/nvi | Negative Volume Index
[**get_security_price_technicals_obv**](TechnicalApi.md#get_security_price_technicals_obv) | **GET** /securities/{identifier}/prices/technicals/obv | On-balance Volume
[**get_security_price_technicals_obv_mean**](TechnicalApi.md#get_security_price_technicals_obv_mean) | **GET** /securities/{identifier}/prices/technicals/obv_mean | On-balance Volume Mean
[**get_security_price_technicals_rsi**](TechnicalApi.md#get_security_price_technicals_rsi) | **GET** /securities/{identifier}/prices/technicals/rsi | Relative Strength Index
[**get_security_price_technicals_sma**](TechnicalApi.md#get_security_price_technicals_sma) | **GET** /securities/{identifier}/prices/technicals/sma | Simple Moving Average
[**get_security_price_technicals_sr**](TechnicalApi.md#get_security_price_technicals_sr) | **GET** /securities/{identifier}/prices/technicals/sr | Stochastic Oscillator
[**get_security_price_technicals_trix**](TechnicalApi.md#get_security_price_technicals_trix) | **GET** /securities/{identifier}/prices/technicals/trix | Triple Exponential Average
[**get_security_price_technicals_tsi**](TechnicalApi.md#get_security_price_technicals_tsi) | **GET** /securities/{identifier}/prices/technicals/tsi | True Strength Index
[**get_security_price_technicals_uo**](TechnicalApi.md#get_security_price_technicals_uo) | **GET** /securities/{identifier}/prices/technicals/uo | Ultimate Oscillator
[**get_security_price_technicals_vi**](TechnicalApi.md#get_security_price_technicals_vi) | **GET** /securities/{identifier}/prices/technicals/vi | Vortex Indicator
[**get_security_price_technicals_vpt**](TechnicalApi.md#get_security_price_technicals_vpt) | **GET** /securities/{identifier}/prices/technicals/vpt | Volume-price Trend
[**get_security_price_technicals_vwap**](TechnicalApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
[**get_security_price_technicals_wr**](TechnicalApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_adi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoAccumulationDistributionIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoAccumulationDistributionIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_adi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/adi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_adi)
## **get_crypto_price_technicals_adi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_adi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoAccumulationDistributionIndex get_crypto_price_technicals_adi(opts)
#### Accumulation/Distribution Index
Returns the Accumulation/Distribution Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_adi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_adi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoAccumulationDistributionIndex**](ApiResponseCryptoAccumulationDistributionIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_adtv)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoAverageDailyTradingVolume)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoAverageDailyTradingVolume.md)
[//]: # (OPERATION:get_crypto_price_technicals_adtv_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/adtv)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_adtv)
## **get_crypto_price_technicals_adtv**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_adtv_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoAverageDailyTradingVolume get_crypto_price_technicals_adtv(opts)
#### Average Daily Trading Volume
Returns the Average Daily Trading Volume values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 22, # Integer | The number of observations, per period, to calculate Average Daily Trading Volume.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_adtv(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_adtv: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Average Daily Trading Volume. | [optional] [default to 22]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoAverageDailyTradingVolume**](ApiResponseCryptoAverageDailyTradingVolume.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_adx)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoAverageDirectionalIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoAverageDirectionalIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_adx_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/adx)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_adx)
## **get_crypto_price_technicals_adx**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_adx_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoAverageDirectionalIndex get_crypto_price_technicals_adx(opts)
#### Average Directional Index
Returns the Average Directional Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 22, # Integer | The number of observations, per period, to calculate Average Directional Index.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_adx(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_adx: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Average Directional Index. | [optional] [default to 22]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoAverageDirectionalIndex**](ApiResponseCryptoAverageDirectionalIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_ao)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoAwesomeOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoAwesomeOscillator.md)
[//]: # (OPERATION:get_crypto_price_technicals_ao_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/ao)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_ao)
## **get_crypto_price_technicals_ao**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_ao_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoAwesomeOscillator get_crypto_price_technicals_ao(opts)
#### Awesome Oscillator
Returns the Awesome Oscillator values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_ao(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_ao: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoAwesomeOscillator**](ApiResponseCryptoAwesomeOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_atr)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoAverageTrueRange)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoAverageTrueRange.md)
[//]: # (OPERATION:get_crypto_price_technicals_atr_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/atr)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_atr)
## **get_crypto_price_technicals_atr**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_atr_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoAverageTrueRange get_crypto_price_technicals_atr(opts)
#### Average True Range
Returns the Average True Range values of Crypto Currency Prices for Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 22, # Integer | The number of observations, per period, to calculate Average True Range.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_atr(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_atr: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Average True Range. | [optional] [default to 22]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoAverageTrueRange**](ApiResponseCryptoAverageTrueRange.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_bb)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoBollingerBands)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoBollingerBands.md)
[//]: # (OPERATION:get_crypto_price_technicals_bb_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/bb)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_bb)
## **get_crypto_price_technicals_bb**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_bb_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoBollingerBands get_crypto_price_technicals_bb(opts)
#### Bollinger Bands
Returns the Bollinger Bands values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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 Crypto Currency Price field to use when calculating Bollinger Bands.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_bb(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_bb: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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 Crypto Currency Price field to use when calculating Bollinger Bands. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoBollingerBands**](ApiResponseCryptoBollingerBands.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_cci)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoCommodityChannelIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoCommodityChannelIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_cci_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/cci)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_cci)
## **get_crypto_price_technicals_cci**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_cci_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoCommodityChannelIndex get_crypto_price_technicals_cci(opts)
#### Commodity Channel Index
Returns the Commodity Channel Index values of Crypto Currency Prices for Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_cci(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_cci: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoCommodityChannelIndex**](ApiResponseCryptoCommodityChannelIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_cmf)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoChaikinMoneyFlow)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoChaikinMoneyFlow.md)
[//]: # (OPERATION:get_crypto_price_technicals_cmf_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/cmf)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_cmf)
## **get_crypto_price_technicals_cmf**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_cmf_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoChaikinMoneyFlow get_crypto_price_technicals_cmf(opts)
#### Chaikin Money Flow
Returns the Chaikin Money Flow values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 20, # Integer | The number of observations, per period, to calculate Chaikin Money Flow.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_cmf(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_cmf: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Chaikin Money Flow. | [optional] [default to 20]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoChaikinMoneyFlow**](ApiResponseCryptoChaikinMoneyFlow.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_dc)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoDonchianChannel)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoDonchianChannel.md)
[//]: # (OPERATION:get_crypto_price_technicals_dc_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/dc)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_dc)
## **get_crypto_price_technicals_dc**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_dc_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoDonchianChannel get_crypto_price_technicals_dc(opts)
#### Donchian Channel
Returns the Donchian Channel values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 20, # Integer | The number of observations, per period, to calculate Donchian Channel.
price_key: "close", # String | The Crypto Currency Price field to use when calculating Donchian Channel.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_dc(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_dc: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Donchian Channel. | [optional] [default to 20]
**price_key** | String| The Crypto Currency Price field to use when calculating Donchian Channel. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoDonchianChannel**](ApiResponseCryptoDonchianChannel.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_dpo)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoDetrendedPriceOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoDetrendedPriceOscillator.md)
[//]: # (OPERATION:get_crypto_price_technicals_dpo_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/dpo)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_dpo)
## **get_crypto_price_technicals_dpo**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_dpo_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoDetrendedPriceOscillator get_crypto_price_technicals_dpo(opts)
#### Detrended Price Oscillator
Returns the Detrended Price Oscillator values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 20, # Integer | The number of observations, per period, to calculate Detrended Price Oscillator.
price_key: "close", # String | The Crypto Currency Price field to use when calculating Detrended Price Oscillator.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_dpo(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_dpo: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Detrended Price Oscillator. | [optional] [default to 20]
**price_key** | String| The Crypto Currency Price field to use when calculating Detrended Price Oscillator. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoDetrendedPriceOscillator**](ApiResponseCryptoDetrendedPriceOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_eom)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoEaseOfMovement)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoEaseOfMovement.md)
[//]: # (OPERATION:get_crypto_price_technicals_eom_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/eom)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_eom)
## **get_crypto_price_technicals_eom**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_eom_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoEaseOfMovement get_crypto_price_technicals_eom(opts)
#### Ease of Movement
Returns the Ease of Movement values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 20, # Integer | The number of observations, per period, to calculate Ease of Movement.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_eom(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_eom: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Ease of Movement. | [optional] [default to 20]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoEaseOfMovement**](ApiResponseCryptoEaseOfMovement.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_fi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoForceIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoForceIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_fi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/fi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_fi)
## **get_crypto_price_technicals_fi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_fi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoForceIndex get_crypto_price_technicals_fi(opts)
#### Force Index
Returns the Force Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_fi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_fi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoForceIndex**](ApiResponseCryptoForceIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_ichimoku)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoIchimokuKinkoHyo)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoIchimokuKinkoHyo.md)
[//]: # (OPERATION:get_crypto_price_technicals_ichimoku_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/ichimoku)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_ichimoku)
## **get_crypto_price_technicals_ichimoku**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_ichimoku_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoIchimokuKinkoHyo get_crypto_price_technicals_ichimoku(opts)
#### Ichimoku Kinko Hyo
Returns the Ichimoku Kinko Hyo values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_ichimoku(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_ichimoku: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoIchimokuKinkoHyo**](ApiResponseCryptoIchimokuKinkoHyo.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_kc)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoKeltnerChannel)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoKeltnerChannel.md)
[//]: # (OPERATION:get_crypto_price_technicals_kc_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/kc)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_kc)
## **get_crypto_price_technicals_kc**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_kc_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoKeltnerChannel get_crypto_price_technicals_kc(opts)
#### Keltner Channel
Returns the Keltner Channel values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 10, # Integer | The number of observations, per period, to calculate Kelter Channel.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_kc(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_kc: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Kelter Channel. | [optional] [default to 10]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoKeltnerChannel**](ApiResponseCryptoKeltnerChannel.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_kst)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoKnowSureThing)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoKnowSureThing.md)
[//]: # (OPERATION:get_crypto_price_technicals_kst_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/kst)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_kst)
## **get_crypto_price_technicals_kst**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_kst_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoKnowSureThing get_crypto_price_technicals_kst(opts)
#### Know Sure Thing
Returns the Know Sure Thing values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3.
roc4: 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 Crypto Currency Price field to use when calculating Know Sure Thing.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_kst(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_kst: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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 RCMA3. | [optional] [default to 20]
**roc4** | 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 Crypto Currency Price field to use when calculating Know Sure Thing. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoKnowSureThing**](ApiResponseCryptoKnowSureThing.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_macd)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoMovingAverageConvergenceDivergence)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoMovingAverageConvergenceDivergence.md)
[//]: # (OPERATION:get_crypto_price_technicals_macd_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/macd)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_macd)
## **get_crypto_price_technicals_macd**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_macd_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoMovingAverageConvergenceDivergence get_crypto_price_technicals_macd(opts)
#### Moving Average Convergence Divergence
Returns the Moving Average Convergence Divergence values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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 Crypto Currency Price field to use when calculating Moving Average Convergence Divergence.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_macd(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_macd: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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 Crypto Currency Price field to use when calculating Moving Average Convergence Divergence. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoMovingAverageConvergenceDivergence**](ApiResponseCryptoMovingAverageConvergenceDivergence.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_mfi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoMoneyFlowIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoMoneyFlowIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_mfi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/mfi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_mfi)
## **get_crypto_price_technicals_mfi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_mfi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoMoneyFlowIndex get_crypto_price_technicals_mfi(opts)
#### Money Flow Index
Returns the Money Flow Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 14, # Integer | The number of observations, per period, to calculate Money Flow Index.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_mfi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_mfi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Money Flow Index. | [optional] [default to 14]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoMoneyFlowIndex**](ApiResponseCryptoMoneyFlowIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_mi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoMassIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoMassIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_mi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/mi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_mi)
## **get_crypto_price_technicals_mi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_mi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoMassIndex get_crypto_price_technicals_mi(opts)
#### Mass Index
Returns the Mass Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_mi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_mi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoMassIndex**](ApiResponseCryptoMassIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_nvi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoNegativeVolumeIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoNegativeVolumeIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_nvi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/nvi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_nvi)
## **get_crypto_price_technicals_nvi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_nvi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoNegativeVolumeIndex get_crypto_price_technicals_nvi(opts)
#### Negative Volume Index
Returns the Negative Volume Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_nvi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_nvi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoNegativeVolumeIndex**](ApiResponseCryptoNegativeVolumeIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_obv)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoOnBalanceVolume)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoOnBalanceVolume.md)
[//]: # (OPERATION:get_crypto_price_technicals_obv_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/obv)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_obv)
## **get_crypto_price_technicals_obv**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_obv_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoOnBalanceVolume get_crypto_price_technicals_obv(opts)
#### On-balance Volume
Returns the On-balance Volume values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_obv(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_obv: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoOnBalanceVolume**](ApiResponseCryptoOnBalanceVolume.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_obv_mean)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoOnBalanceVolumeMean)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoOnBalanceVolumeMean.md)
[//]: # (OPERATION:get_crypto_price_technicals_obv_mean_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/obv_mean)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_obv_mean)
## **get_crypto_price_technicals_obv_mean**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_obv_mean_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoOnBalanceVolumeMean get_crypto_price_technicals_obv_mean(opts)
#### On-balance Volume Mean
Returns the On-balance Volume Mean values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 10, # Integer | The number of observations, per period, to calculate On-balance Volume Mean.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_obv_mean(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_obv_mean: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate On-balance Volume Mean. | [optional] [default to 10]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoOnBalanceVolumeMean**](ApiResponseCryptoOnBalanceVolumeMean.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_rsi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoRelativeStrengthIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoRelativeStrengthIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_rsi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/rsi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_rsi)
## **get_crypto_price_technicals_rsi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_rsi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoRelativeStrengthIndex get_crypto_price_technicals_rsi(opts)
#### Relative Strength Index
Returns the Relative Strength Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 14, # Integer | The number of observations, per period, to calculate Relative Strength Index.
price_key: "close", # String | The Crypto Currency Price field to use when calculating Relative Strength Index.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_rsi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_rsi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Relative Strength Index. | [optional] [default to 14]
**price_key** | String| The Crypto Currency Price field to use when calculating Relative Strength Index. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoRelativeStrengthIndex**](ApiResponseCryptoRelativeStrengthIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_sma)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoSimpleMovingAverage)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoSimpleMovingAverage.md)
[//]: # (OPERATION:get_crypto_price_technicals_sma_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/sma)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_sma)
## **get_crypto_price_technicals_sma**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_sma_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoSimpleMovingAverage get_crypto_price_technicals_sma(opts)
#### Simple Moving Average
Returns the Simple Moving Average values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 20, # Integer | The number of observations, per period, to calculate Simple Moving Average.
price_key: "close", # String | The Crypto Currency Price field to use when calculating Simple Moving Average.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_sma(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_sma: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Simple Moving Average. | [optional] [default to 20]
**price_key** | String| The Crypto Currency Price field to use when calculating Simple Moving Average. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoSimpleMovingAverage**](ApiResponseCryptoSimpleMovingAverage.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_sr)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoStochasticOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoStochasticOscillator.md)
[//]: # (OPERATION:get_crypto_price_technicals_sr_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/sr)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_sr)
## **get_crypto_price_technicals_sr**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_sr_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoStochasticOscillator get_crypto_price_technicals_sr(opts)
#### Stochastic Oscillator
Returns the Stochastic Oscillator values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_sr(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_sr: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoStochasticOscillator**](ApiResponseCryptoStochasticOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_trix)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoTripleExponentialAverage)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoTripleExponentialAverage.md)
[//]: # (OPERATION:get_crypto_price_technicals_trix_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/trix)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_trix)
## **get_crypto_price_technicals_trix**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_trix_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoTripleExponentialAverage get_crypto_price_technicals_trix(opts)
#### Triple Exponential Average
Returns the Simple Moving Average values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 15, # Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_trix(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_trix: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average. | [optional] [default to 15]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoTripleExponentialAverage**](ApiResponseCryptoTripleExponentialAverage.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_tsi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoTrueStrengthIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoTrueStrengthIndex.md)
[//]: # (OPERATION:get_crypto_price_technicals_tsi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/tsi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_tsi)
## **get_crypto_price_technicals_tsi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_tsi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoTrueStrengthIndex get_crypto_price_technicals_tsi(opts)
#### True Strength Index
Returns the True Strength Index values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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 Crypto Currency Price field to use when calculating True Strength Index.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_tsi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_tsi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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 Crypto Currency Price field to use when calculating True Strength Index. | [optional] [default to close]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoTrueStrengthIndex**](ApiResponseCryptoTrueStrengthIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_uo)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoUltimateOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoUltimateOscillator.md)
[//]: # (OPERATION:get_crypto_price_technicals_uo_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/uo)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_uo)
## **get_crypto_price_technicals_uo**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_uo_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoUltimateOscillator get_crypto_price_technicals_uo(opts)
#### Ultimate Oscillator
Returns the Ultimate Oscillator values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
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.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_uo(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_uo: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**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]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoUltimateOscillator**](ApiResponseCryptoUltimateOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_vi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoVortexIndicator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoVortexIndicator.md)
[//]: # (OPERATION:get_crypto_price_technicals_vi_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/vi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_vi)
## **get_crypto_price_technicals_vi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_vi_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoVortexIndicator get_crypto_price_technicals_vi(opts)
#### Vortex Indicator
Returns the Vortex Indicator values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 14, # Integer | The number of observations, per period, to calculate Vortex Indicator.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_vi(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_vi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to calculate Vortex Indicator. | [optional] [default to 14]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoVortexIndicator**](ApiResponseCryptoVortexIndicator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_vpt)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoVolumePriceTrend)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoVolumePriceTrend.md)
[//]: # (OPERATION:get_crypto_price_technicals_vpt_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/vpt)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_vpt)
## **get_crypto_price_technicals_vpt**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_vpt_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoVolumePriceTrend get_crypto_price_technicals_vpt(opts)
#### Volume-price Trend
Returns the Volume-price Trend values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_vpt(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_vpt: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoVolumePriceTrend**](ApiResponseCryptoVolumePriceTrend.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_vwap)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoVolumeWeightedAveragePrice)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoVolumeWeightedAveragePrice.md)
[//]: # (OPERATION:get_crypto_price_technicals_vwap_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/vwap)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_vwap)
## **get_crypto_price_technicals_vwap**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_vwap_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoVolumeWeightedAveragePrice get_crypto_price_technicals_vwap(opts)
#### Volume Weighted Average Price
Returns the Volume Weighted Average Price values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_vwap(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_vwap: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoVolumeWeightedAveragePrice**](ApiResponseCryptoVolumeWeightedAveragePrice.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_crypto_price_technicals_wr)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseCryptoWilliamsR)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseCryptoWilliamsR.md)
[//]: # (OPERATION:get_crypto_price_technicals_wr_v2)
[//]: # (ENDPOINT:/crypto/prices/technicals/wr)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_crypto_price_technicals_wr)
## **get_crypto_price_technicals_wr**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_crypto_price_technicals_wr_v2)
[//]: # (START_OVERVIEW)
> ApiResponseCryptoWilliamsR get_crypto_price_technicals_wr(opts)
#### Williams %R
Returns the Williams %R values of Crypto Currency Prices for a Crypto Currency Pair
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
opts = {
pair: "btcusd", # String | Return technicals for the given Crypto Currency Pair.
exchange: "binance", # String | Return technicals for a Crypto Currency on the given Crypto Exchange.
currency: "BTC", # String | Return technicals for the given Crypto Currency.
period: 14, # Integer | The number of observations, per period, to look-back when calculating Williams %R.
timeframe: "d1", # String | The time interval for the prices when calculating technicals.
timezone: "UTC", # String | Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone.
start_date: nil, # Date | Return technicals on or after this date.
start_time: nil, # String | Return technicals at or after this time (24-hour).
end_date: nil, # Date | Return technicals on or before this date.
end_time: nil, # String | Return technicals at or before this time (24-hour).
page_size: 100, # Integer | An integer greater than or equal to 1 for specifying the number of results on each page.
next_page: nil # String | Gets the next page of data from a previous API call
}
begin
result = technical_api.get_crypto_price_technicals_wr(opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_crypto_price_technicals_wr: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_PARAMETERS)
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pair** | String| Return technicals for the given Crypto Currency Pair. | [optional]
**exchange** | String| Return technicals for a Crypto Currency on the given Crypto Exchange. | [optional]
**currency** | String| Return technicals for the given Crypto Currency. | [optional]
**period** | Integer| The number of observations, per period, to look-back when calculating Williams %R. | [optional] [default to 14]
**timeframe** | String| The time interval for the prices when calculating technicals. | [optional] [default to d1]
**timezone** | String| Return technical date/times in this timezone, also interpret start/end date/time parameters in this timezone. | [optional] [default to UTC]
**start_date** | Date| Return technicals on or after this date. | [optional]
**start_time** | String| Return technicals at or after this time (24-hour). | [optional]
**end_date** | Date| Return technicals on or before this date. | [optional]
**end_time** | String| Return technicals at or before this time (24-hour). | [optional]
**page_size** | Integer| An integer greater than or equal to 1 for specifying the number of results on each page. | [optional] [default to 100]
**next_page** | String| Gets the next page of data from a previous API call | [optional]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseCryptoWilliamsR**](ApiResponseCryptoWilliamsR.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_adi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAccumulationDistributionIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAccumulationDistributionIndex.md)
[//]: # (OPERATION:get_security_price_technicals_adi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_adi)
## **get_security_price_technicals_adi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_adi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_adi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_adi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_adtv)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageDailyTradingVolume)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDailyTradingVolume.md)
[//]: # (OPERATION:get_security_price_technicals_adtv_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_adtv)
## **get_security_price_technicals_adtv**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_adtv_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_adtv(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_adtv: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_adx)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageDirectionalIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDirectionalIndex.md)
[//]: # (OPERATION:get_security_price_technicals_adx_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_adx)
## **get_security_price_technicals_adx**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_adx_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_adx(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_adx: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_ao)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAwesomeOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAwesomeOscillator.md)
[//]: # (OPERATION:get_security_price_technicals_ao_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_ao)
## **get_security_price_technicals_ao**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_ao_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_ao(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_ao: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_atr)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageTrueRange)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageTrueRange.md)
[//]: # (OPERATION:get_security_price_technicals_atr_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_atr)
## **get_security_price_technicals_atr**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_atr_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_atr(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_atr: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_bb)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityBollingerBands)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityBollingerBands.md)
[//]: # (OPERATION:get_security_price_technicals_bb_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_bb)
## **get_security_price_technicals_bb**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_bb_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_bb(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_bb: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_cci)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityCommodityChannelIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityCommodityChannelIndex.md)
[//]: # (OPERATION:get_security_price_technicals_cci_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_cci)
## **get_security_price_technicals_cci**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_cci_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_cci(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_cci: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_cmf)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityChaikinMoneyFlow)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityChaikinMoneyFlow.md)
[//]: # (OPERATION:get_security_price_technicals_cmf_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_cmf)
## **get_security_price_technicals_cmf**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_cmf_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_cmf(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_cmf: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_dc)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityDonchianChannel)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDonchianChannel.md)
[//]: # (OPERATION:get_security_price_technicals_dc_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_dc)
## **get_security_price_technicals_dc**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_dc_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_dc(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_dc: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_dpo)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityDetrendedPriceOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDetrendedPriceOscillator.md)
[//]: # (OPERATION:get_security_price_technicals_dpo_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_dpo)
## **get_security_price_technicals_dpo**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_dpo_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_dpo(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_dpo: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_eom)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityEaseOfMovement)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityEaseOfMovement.md)
[//]: # (OPERATION:get_security_price_technicals_eom_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_eom)
## **get_security_price_technicals_eom**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_eom_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_eom(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_eom: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_fi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityForceIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityForceIndex.md)
[//]: # (OPERATION:get_security_price_technicals_fi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_fi)
## **get_security_price_technicals_fi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_fi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_fi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_fi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_ichimoku)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityIchimokuKinkoHyo)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIchimokuKinkoHyo.md)
[//]: # (OPERATION:get_security_price_technicals_ichimoku_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_ichimoku)
## **get_security_price_technicals_ichimoku**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_ichimoku_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_ichimoku(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_ichimoku: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_kc)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityKeltnerChannel)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKeltnerChannel.md)
[//]: # (OPERATION:get_security_price_technicals_kc_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_kc)
## **get_security_price_technicals_kc**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_kc_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_kc(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_kc: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_kst)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityKnowSureThing)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKnowSureThing.md)
[//]: # (OPERATION:get_security_price_technicals_kst_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_kst)
## **get_security_price_technicals_kst**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_kst_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3
roc4: 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 = technical_api.get_security_price_technicals_kst(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_kst: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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 RCMA3 | [optional] [default to 20]
**roc4** | 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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_macd)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMovingAverageConvergenceDivergence)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMovingAverageConvergenceDivergence.md)
[//]: # (OPERATION:get_security_price_technicals_macd_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_macd)
## **get_security_price_technicals_macd**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_macd_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_macd(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_macd: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_mfi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMoneyFlowIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMoneyFlowIndex.md)
[//]: # (OPERATION:get_security_price_technicals_mfi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_mfi)
## **get_security_price_technicals_mfi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_mfi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_mfi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_mfi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_mi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMassIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMassIndex.md)
[//]: # (OPERATION:get_security_price_technicals_mi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_mi)
## **get_security_price_technicals_mi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_mi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_mi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_mi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_nvi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityNegativeVolumeIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityNegativeVolumeIndex.md)
[//]: # (OPERATION:get_security_price_technicals_nvi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_nvi)
## **get_security_price_technicals_nvi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_nvi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_nvi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_nvi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_obv)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityOnBalanceVolume)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolume.md)
[//]: # (OPERATION:get_security_price_technicals_obv_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_obv)
## **get_security_price_technicals_obv**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_obv_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_obv(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_obv: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_obv_mean)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityOnBalanceVolumeMean)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolumeMean.md)
[//]: # (OPERATION:get_security_price_technicals_obv_mean_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_obv_mean)
## **get_security_price_technicals_obv_mean**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_obv_mean_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_obv_mean(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_obv_mean: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_rsi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityRelativeStrengthIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityRelativeStrengthIndex.md)
[//]: # (OPERATION:get_security_price_technicals_rsi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_rsi)
## **get_security_price_technicals_rsi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_rsi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_rsi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_rsi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_sma)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecuritySimpleMovingAverage)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritySimpleMovingAverage.md)
[//]: # (OPERATION:get_security_price_technicals_sma_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_sma)
## **get_security_price_technicals_sma**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_sma_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_sma(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_sma: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_sr)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityStochasticOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStochasticOscillator.md)
[//]: # (OPERATION:get_security_price_technicals_sr_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_sr)
## **get_security_price_technicals_sr**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_sr_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_sr(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_sr: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_trix)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityTripleExponentialAverage)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTripleExponentialAverage.md)
[//]: # (OPERATION:get_security_price_technicals_trix_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_trix)
## **get_security_price_technicals_trix**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_trix_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_trix(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_trix: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_tsi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityTrueStrengthIndex)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTrueStrengthIndex.md)
[//]: # (OPERATION:get_security_price_technicals_tsi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_tsi)
## **get_security_price_technicals_tsi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_tsi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_tsi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_tsi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_uo)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityUltimateOscillator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityUltimateOscillator.md)
[//]: # (OPERATION:get_security_price_technicals_uo_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_uo)
## **get_security_price_technicals_uo**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_uo_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_uo(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_uo: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_vi)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVortexIndicator)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVortexIndicator.md)
[//]: # (OPERATION:get_security_price_technicals_vi_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_vi)
## **get_security_price_technicals_vi**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_vi_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_vi(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_vi: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_vpt)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVolumePriceTrend)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumePriceTrend.md)
[//]: # (OPERATION:get_security_price_technicals_vpt_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_vpt)
## **get_security_price_technicals_vpt**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_vpt_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_vpt(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_vpt: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_vwap)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVolumeWeightedAveragePrice)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumeWeightedAveragePrice.md)
[//]: # (OPERATION:get_security_price_technicals_vwap_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_vwap)
## **get_security_price_technicals_vwap**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_vwap_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_vwap(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_vwap: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md)
[//]: # (END_OPERATION)
[//]: # (START_OPERATION)
[//]: # (CLASS:Intrinio::TechnicalApi)
[//]: # (METHOD:get_security_price_technicals_wr)
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityWilliamsR)
[//]: # (RETURN_TYPE_KIND:object)
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityWilliamsR.md)
[//]: # (OPERATION:get_security_price_technicals_wr_v2)
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr)
[//]: # (DOCUMENT_LINK:TechnicalApi.md#get_security_price_technicals_wr)
## **get_security_price_technicals_wr**
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_price_technicals_wr_v2)
[//]: # (START_OVERVIEW)
> 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`
[//]: # (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'
end
technical_api = Intrinio::TechnicalApi.new
identifier = "AAPL" # 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 = technical_api.get_security_price_technicals_wr(identifier, opts)
pp result
rescue Intrinio::ApiError => e
puts "Exception when calling TechnicalApi->get_security_price_technicals_wr: #{e}"
end
```
[//]: # (END_CODE_EXAMPLE)
[//]: # (START_DEFINITION)
### Parameters
[//]: # (START_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]
[//]: # (END_PARAMETERS)
### Return type
[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md)
[//]: # (END_OPERATION)