Vortex Indicator R API Documentation

The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.

API Class:

IntrinioSDK::SecurityApi

Instance Method:

get_security_price_technicals_vi()

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
25
26
27
28
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
SecurityApi <- IntrinioSDK::SecurityApi$new(client)
# Required params
identifier <- "AAPL"
# Optional params
opts <- list(
  period = 14,
  start_date = "2018-01-01",
  end_date = "2019-01-01",
  page_size = 100,
  next_page = NULL
)
response <- SecurityApi$get_security_price_technicals_vi(identifier, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
identifier	Character	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	Character	Return technical indicator values on or after the date	[optional]
end_date	Character	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	Character	Gets the next page of data from a previous API call	[optional]

Return Type

object

IntrinioSDK::ApiResponseSecurityVortexIndicator

Properties

Name	Type	Description
technicals	List of VortexIndicatorTechnicalValue
technicals_data_frame	Data Frame	Data frame representation of technicals
indicator	TechnicalIndicator	The name and symbol of the technical indicator
security	SecuritySummary	The Security of the Stock Price
next_page	Character	The token required to request the next page of the data. If null, no further results are available.

object

IntrinioSDK::VortexIndicatorTechnicalValue

Properties

Name	Type	Description
date_time	POSIXlt	The date_time of the observation
negative_vi	Numeric	The negative Vortex Indicator value
positive_vi	Numeric	The positive Vortex Indicator value

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

object

IntrinioSDK::SecuritySummary

Properties

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