Vortex Indicator

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
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

NameTypeDescriptionNotes
identifierCharacterA Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) 
periodIntegerThe number of observations, per period, to calculate Vortex Indicator[optional] [default to 14]  
start_dateCharacterReturn technical indicator values on or after the date[optional]  
end_dateCharacterReturn technical indicator values on or before the date[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 100]  
next_pageCharacterGets the next page of data from a previous API call[optional]  


Return Type

object
IntrinioSDK::ApiResponseSecurityVortexIndicator

Properties

NameTypeDescription
technicalsList of VortexIndicatorTechnicalValue 
technicals_data_frameData FrameData frame representation of technicals
indicatorTechnicalIndicatorThe name and symbol of the technical indicator  
securitySecuritySummaryThe Security of the Stock Price  
next_pageCharacterThe token required to request the next page of the data. If null, no further results are available.  
object
IntrinioSDK::VortexIndicatorTechnicalValue

Properties

NameTypeDescription
date_timePOSIXltThe date_time of the observation  
negative_viNumericThe negative Vortex Indicator value  
positive_viNumericThe positive Vortex Indicator value  
object
IntrinioSDK::TechnicalIndicator

Properties

NameTypeDescription
nameCharacterThe name of the Technical Indicator  
symbolCharacterThe symbol of the Technical Indicator  
object
IntrinioSDK::SecuritySummary

Properties

NameTypeDescription
idCharacterThe Intrinio ID for Security  
company_idCharacterThe Intrinio ID for the Company for which the Security is issued  
exchangeCharacterThe exchange’s MIC  
exchange_micCharacterThe security’s exchange MIC  
stock_exchange_idCharacterThe exchange’s Intrinio ID  
nameCharacterThe name of the Security  
codeCharacterA 2-3 digit code classifying the Security (<a href=&quot;https://docs.intrinio.com/documentation/security_codes&quot; target=&quot;_blank&quot;>reference</a>)  
currencyCharacterThe currency in which the Security is traded on the exchange  
tickerCharacterThe common/local ticker of the Security  
composite_tickerCharacterThe country-composite ticker of the Security  
figiCharacterThe OpenFIGI identifier  
composite_figiCharacterThe country-composite OpenFIGI identifier  
share_class_figiCharacterThe global-composite OpenFIGI identifier  
primary_listingLogicalIf TRUE, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange