Average Directional Index Ruby API Documentation

The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).

API Class:

Intrinio::SecurityApi

Instance Method:

get_security_price_technicals_adx()

Stock Price Code Example

Use my API Key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Load the gem
require 'intrinio-sdk'
require 'pp'
# Setup authorization
Intrinio.configure do |config|
  config.api_key['api_key'] = 'YOUR_API_KEY'
  config.allow_retries = true
end
security_api = Intrinio::SecurityApi.new
identifier = "AAPL"
opts = {
  period: 14,
  start_date: "2018-01-01",
  end_date: "2019-01-01",
  page_size: 100,
  next_page: nil
}
result = security_api.get_security_price_technicals_adx(identifier, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Integer	The number of observations, per period, to calculate Average Directional Index	[optional] [default to 14]
start_date	String	Return technical indicator values on or after the date	[optional]
end_date	String	Return technical indicator values on or before the date	[optional]
page_size	Integer	The number of results to return	[optional] [default to 100]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return Type

object

Intrinio::ApiResponseSecurityAverageDirectionalIndex

Properties

Name	Type	Description
technicals	Array
indicator	TechnicalIndicator	The name and symbol of the technical indicator
security	SecuritySummary	The Security of the Stock Price
next_page	String	The token required to request the next page of the data. If null, no further results are available.

object

Intrinio::AverageDirectionalIndexTechnicalValue

Properties

Name	Type	Description
date_time	DateTime	The date_time of the observation
adx	Float	The Average Directional Index value
di_neg	Float	The Minus Directional Indicator value
di_pos	Float	The Plus Directional Indicator value

Name	Type	Description
name	String	The name of the Technical Indicator
symbol	String	The symbol of the Technical Indicator

object

Intrinio::SecuritySummary

Properties

Name	Type	Description
id	String	The Intrinio ID for Security
company_id	String	The Intrinio ID for the Company for which the Security is issued
exchange	String	The exchange's MIC
exchange_mic	String	The security's exchange MIC
stock_exchange_id	String	The exchange's Intrinio ID
name	String	The name of the Security
code	String	A 2-3 digit code classifying the Security (reference)
currency	String	The currency in which the Security is traded on the exchange
ticker	String	The common/local ticker of the Security
composite_ticker	String	The country-composite ticker of the Security
figi	String	The OpenFIGI identifier
composite_figi	String	The country-composite OpenFIGI identifier
share_class_figi	String	The global-composite OpenFIGI identifier
primary_listing	BOOLEAN	If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange