Vortex Indicator

Vortex Indicator Javascript 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:
SecurityApi
Instance Method:
getSecurityPriceTechnicalsVi()

Stock Price Code Example

Use my API Key
var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;
var security = new intrinioSDK.SecurityApi();
var identifier = "AAPL";
var opts = {
'period': 14,
'startDate': "2018-01-01",
'endDate': "2019-01-01",
'pageSize': 100,
'nextPage': null
};
security.getSecurityPriceTechnicalsVi(identifier, opts).then(function(data) {
data = JSON.stringify(data, null, 2)
console.log(data);
}, function(error) {
console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringA Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) 
periodNumberThe number of observations, per period, to calculate Vortex Indicator[optional] [default to 14]  
startDateStringReturn technical indicator values on or after the date[optional]  
endDateStringReturn technical indicator values on or before the date[optional]  
pageSizeNumberThe number of results to return[optional] [default to 100]  
nextPageStringGets the next page of data from a previous API call[optional]  


Return Type

object
ApiResponseSecurityVortexIndicator

Properties

NameTypeDescription
technicals[VortexIndicatorTechnicalValue] 
indicatorTechnicalIndicatorThe name and symbol of the technical indicator  
securitySecuritySummaryThe Security of the Stock Price  
nextPageStringThe token required to request the next page of the data. If null, no further results are available.  
object
VortexIndicatorTechnicalValue

Properties

NameTypeDescription
dateTimeDateThe date_time of the observation  
negativeViNumberThe negative Vortex Indicator value  
positiveViNumberThe positive Vortex Indicator value  
object
TechnicalIndicator

Properties

NameTypeDescription
nameStringThe name of the Technical Indicator  
symbolStringThe symbol of the Technical Indicator  
object
SecuritySummary

Properties

NameTypeDescription
idStringThe Intrinio ID for Security  
companyIdStringThe Intrinio ID for the Company for which the Security is issued  
exchangeStringThe exchange's MIC  
exchangeMicStringThe security's exchange MIC  
stockExchangeIdStringThe exchange's Intrinio ID  
nameStringThe name of the Security  
codeStringA 2-3 digit code classifying the Security (reference)  
currencyStringThe currency in which the Security is traded on the exchange  
tickerStringThe common/local ticker of the Security  
compositeTickerStringThe country-composite ticker of the Security  
figiStringThe OpenFIGI identifier  
compositeFigiStringThe country-composite OpenFIGI identifier  
shareClassFigiStringThe global-composite OpenFIGI identifier  
primaryListingBooleanIf true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange