intrinioSDK.SecurityApi

All URIs are relative to https://api-v2.intrinio.com

Method	HTTP request	Description
getAllSecurities	GET /securities	All Securities
getSecurityById	GET /securities/{identifier}	Lookup Security
getSecurityDataPointNumber	GET /securities/{identifier}/data_point/{tag}/number	Data Point (Number) for Security
getSecurityDataPointText	GET /securities/{identifier}/data_point/{tag}/text	Data Point (Text) for Security
getSecurityHistoricalData	GET /securities/{identifier}/historical_data/{tag}	Historical Data for Security
getSecurityHistoryByIdentifier	GET /securities/history-by-identifier/{identifier}	Security History By Identifier
getSecurityHistoryByTicker	GET /securities/history-by-ticker/{ticker}	Security History By Ticker
getSecurityInsiderOwnership	GET /securities/{identifier}/institutional_ownership	Institutional Ownership by Security
getSecurityIntervalMovers	GET /securities/market_movers	Security Intervals Movers
getSecurityIntervalMoversChange	GET /securities/market_movers/change	Security Intervals Movers By Change
getSecurityIntervalMoversVolume	GET /securities/market_movers/volume	Security Intervals Movers By Volume
getSecurityIntervalPrices	GET /securities/{identifier}/prices/intervals	Interval Stock Prices for Security
getSecurityIntradayPrices	GET /securities/{identifier}/prices/intraday	Intraday Stock Prices for Security
getSecurityLatestDividendRecord	GET /securities/{identifier}/dividends/latest	Latest Dividend Record for Security
getSecurityLatestEarningsRecord	GET /securities/{identifier}/earnings/latest	Latest Earnings Record for Security
getSecurityPriceTechnicalsAdi	GET /securities/{identifier}/prices/technicals/adi	Accumulation/Distribution Index
getSecurityPriceTechnicalsAdtv	GET /securities/{identifier}/prices/technicals/adtv	Average Daily Trading Volume
getSecurityPriceTechnicalsAdx	GET /securities/{identifier}/prices/technicals/adx	Average Directional Index
getSecurityPriceTechnicalsAo	GET /securities/{identifier}/prices/technicals/ao	Awesome Oscillator
getSecurityPriceTechnicalsAtr	GET /securities/{identifier}/prices/technicals/atr	Average True Range
getSecurityPriceTechnicalsBb	GET /securities/{identifier}/prices/technicals/bb	Bollinger Bands
getSecurityPriceTechnicalsCci	GET /securities/{identifier}/prices/technicals/cci	Commodity Channel Index
getSecurityPriceTechnicalsCmf	GET /securities/{identifier}/prices/technicals/cmf	Chaikin Money Flow
getSecurityPriceTechnicalsDc	GET /securities/{identifier}/prices/technicals/dc	Donchian Channel
getSecurityPriceTechnicalsDpo	GET /securities/{identifier}/prices/technicals/dpo	Detrended Price Oscillator
getSecurityPriceTechnicalsEom	GET /securities/{identifier}/prices/technicals/eom	Ease of Movement
getSecurityPriceTechnicalsFi	GET /securities/{identifier}/prices/technicals/fi	Force Index
getSecurityPriceTechnicalsIchimoku	GET /securities/{identifier}/prices/technicals/ichimoku	Ichimoku Kinko Hyo
getSecurityPriceTechnicalsKc	GET /securities/{identifier}/prices/technicals/kc	Keltner Channel
getSecurityPriceTechnicalsKst	GET /securities/{identifier}/prices/technicals/kst	Know Sure Thing
getSecurityPriceTechnicalsMacd	GET /securities/{identifier}/prices/technicals/macd	Moving Average Convergence Divergence
getSecurityPriceTechnicalsMfi	GET /securities/{identifier}/prices/technicals/mfi	Money Flow Index
getSecurityPriceTechnicalsMi	GET /securities/{identifier}/prices/technicals/mi	Mass Index
getSecurityPriceTechnicalsNvi	GET /securities/{identifier}/prices/technicals/nvi	Negative Volume Index
getSecurityPriceTechnicalsObv	GET /securities/{identifier}/prices/technicals/obv	On-balance Volume
getSecurityPriceTechnicalsObvMean	GET /securities/{identifier}/prices/technicals/obv_mean	On-balance Volume Mean
getSecurityPriceTechnicalsRsi	GET /securities/{identifier}/prices/technicals/rsi	Relative Strength Index
getSecurityPriceTechnicalsSma	GET /securities/{identifier}/prices/technicals/sma	Simple Moving Average
getSecurityPriceTechnicalsSr	GET /securities/{identifier}/prices/technicals/sr	Stochastic Oscillator
getSecurityPriceTechnicalsTrix	GET /securities/{identifier}/prices/technicals/trix	Triple Exponential Average
getSecurityPriceTechnicalsTsi	GET /securities/{identifier}/prices/technicals/tsi	True Strength Index
getSecurityPriceTechnicalsUo	GET /securities/{identifier}/prices/technicals/uo	Ultimate Oscillator
getSecurityPriceTechnicalsVi	GET /securities/{identifier}/prices/technicals/vi	Vortex Indicator
getSecurityPriceTechnicalsVpt	GET /securities/{identifier}/prices/technicals/vpt	Volume-price Trend
getSecurityPriceTechnicalsVwap	GET /securities/{identifier}/prices/technicals/vwap	Volume Weighted Average Price
getSecurityPriceTechnicalsWr	GET /securities/{identifier}/prices/technicals/wr	Williams %R
getSecurityQuote	GET /securities/{identifier}/quote	Quote for a Security
getSecurityRealtimePrice	GET /securities/{identifier}/prices/realtime	Realtime Stock Price for Security
getSecurityReplayFile	GET /securities/replay	Security Replay File
getSecuritySnapshots	GET /securities/snapshots	Realtime Stock Prices Snapshot
getSecurityStockPriceAdjustments	GET /securities/{identifier}/prices/adjustments	Stock Price Adjustments by Security
getSecurityStockPrices	GET /securities/{identifier}/prices	Stock Prices by Security
getSecurityTrades	GET /securities/trades	Security Trades
getSecurityTradesBySymbol	GET /securities/{identifier}/trades	Security Trades By Symbol
getSecurityZacksAnalystRatings	GET /securities/{identifier}/zacks/analyst_ratings	Zacks Analyst Ratings for Security
getSecurityZacksAnalystRatingsSnapshot	GET /securities/{identifier}/zacks/analyst_ratings/snapshot	Zacks Analyst Ratings Snapshot
getSecurityZacksEpsSurprises	GET /securities/{identifier}/zacks/eps_surprises	Zacks EPS Surprises for Security
getSecurityZacksSalesSurprises	GET /securities/{identifier}/zacks/sales_surprises	Zacks Sales Surprises for Security
screenSecurities	POST /securities/screen	Screen Securities
searchSecurities	GET /securities/search	Search Securities

getAllSecurities

View Intrinio API Documentation

ApiResponseSecurities getAllSecurities(opts)

All Securities

Returns a list of all securities available. Delisted securities included.

Example

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 opts = { 
  'active': true,
  'delisted': false,
  'code': null,
  'currency': null,
  'ticker': null,
  'name': null,
  'compositeMic': null,
  'exchangeMic': null,
  'stockPricesAfter': null,
  'stockPricesBefore': null,
  'cik': null,
  'figi': null,
  'compositeFigi': null,
  'shareClassFigi': null,
  'figiUniqueId': null,
  'includeNonFigi': false,
  'pageSize': 100,
  'primaryListing': null,
  'nextPage': null
};

security.getAllSecurities(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
active	Boolean	When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).	[optional]
delisted	Boolean	When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.	[optional]
code	String	Return securities classified with the given code (<a href="https://docs.intrinio.com/documentation/security_codes\" target="_blank">reference</a>).	[optional]
currency	String	Return securities traded in the given 3-digit ISO 4217 currency code (<a href="https://en.wikipedia.org/wiki/ISO_4217\" target="_blank">reference</a>).	[optional]
ticker	String	Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity.	[optional]
name	String	Return securities with the given text in their name (not case sensitive).	[optional]
compositeMic	String	Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below.	[optional]
exchangeMic	String	The MIC code of the exchange where the security is actually traded.	[optional]
stockPricesAfter	Date	Return securities with end-of-day stock prices on or after this date.	[optional]
stockPricesBefore	Date	Return securities with end-of-day stock prices on or before this date.	[optional]
cik	String	Return securities belonging to the company with the given Central Index Key (CIK).	[optional]
figi	String	Return securities with the given Exchange Level FIGI (<a href="https://www.openfigi.com/about\" target="_blank">reference</a>).	[optional]
compositeFigi	String	Return securities with the given Country Composite FIGI (<a href="https://www.openfigi.com/about\" target="_blank">reference</a>).	[optional]
shareClassFigi	String	Return securities with the given Global Share Class FIGI (<a href="https://www.openfigi.com/about\" target="_blank">reference</a>).	[optional]
figiUniqueId	String	Return securities with the given FIGI Unique ID (<a href="https://www.openfigi.com/about\" target="_blank">reference</a>).	[optional]
includeNonFigi	Boolean	When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned.	[optional] [default to false]
pageSize	Number	The number of results to return	[optional] [default to 100]
primaryListing	Boolean	If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange. Returns both if omitted.	[optional]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurities

getSecurityById

View Intrinio API Documentation

Security getSecurityById(identifier)

Lookup Security

Returns security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.

Example

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


security.getSecurityById(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)

Return type

Security

getSecurityDataPointNumber

View Intrinio API Documentation

'Number' getSecurityDataPointNumber(identifier, tag)

Data Point (Number) for Security

Returns a numeric value for the given `tag` for the Security with the given `identifier`

Example

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 tag = "close_price";


security.getSecurityDataPointNumber(identifier, tag).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
tag	String	An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)

Return type

'Number'

getSecurityDataPointText

View Intrinio API Documentation

'String' getSecurityDataPointText(identifier, tag)

Data Point (Text) for Security

Returns a text value for the given `tag` for the Security with the given `identifier`

Example

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 tag = "figi";


security.getSecurityDataPointText(identifier, tag).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
tag	String	An Intrinio data tag ID or code-name

Return type

'String'

getSecurityHistoricalData

View Intrinio API Documentation

ApiResponseSecurityHistoricalData getSecurityHistoricalData(identifier, tag, opts)

Historical Data for Security

Returns historical values for the given `tag` and the Security with the given `identifier`

Example

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 tag = "adj_close_price";


var opts = { 
  'frequency': "daily",
  'type': null,
  'startDate': new Date("2018-01-01"),
  'endDate': null,
  'sortOrder': "desc",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityHistoricalData(identifier, tag, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
tag	String	An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
frequency	String	Return historical data in the given frequency	[optional] [default to daily]
type	String	Filter by type, when applicable	[optional]
startDate	Date	Get historical data on or after this date	[optional]
endDate	Date	Get historical date on or before this date	[optional]
sortOrder	String	Sort by date `asc` or `desc`	[optional] [default to desc]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityHistoricalData

getSecurityHistoryByIdentifier

View Intrinio API Documentation

SecurityHistoryListResult getSecurityHistoryByIdentifier(identifier)

Security History By Identifier

Lists the tickers a company has used over time.

Example

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 = "037833100";


security.getSecurityHistoryByIdentifier(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (FIGI, COMPOSITE FIGI, SHARE CLASS FIGI, ISIN, CUSIP, Intrinio ID)

Return type

SecurityHistoryListResult

getSecurityHistoryByTicker

View Intrinio API Documentation

SecurityHistoryListResult getSecurityHistoryByTicker(ticker)

Security History By Ticker

Lists the tickers a company has used over time.

Example

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 ticker = "AAPL";


security.getSecurityHistoryByTicker(ticker).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
ticker	String	A Security ticker symbol

Return type

SecurityHistoryListResult

getSecurityInsiderOwnership

View Intrinio API Documentation

ApiResponseSecurityInstitutionalOwnership getSecurityInsiderOwnership(identifier, opts)

Institutional Ownership by Security

Returns a list of all institutional owners of a given security.

Example

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 = { 
  'nextPage': null
};

security.getSecurityInsiderOwnership(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityInstitutionalOwnership

getSecurityIntervalMovers

View Intrinio API Documentation

SecurityIntervalsMoversResult getSecurityIntervalMovers(opts)

Security Intervals Movers

Returns a list of intervals for the biggest movers over the last hour interval.

Example

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 opts = { 
  'source': null,
  'openTime': null
};

security.getSecurityIntervalMovers(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
source	String	Realtime or 15-minute delayed contracts.	[optional]
openTime	Date	The inclusive UTC date and time the interval opens at.	[optional]

Return type

SecurityIntervalsMoversResult

getSecurityIntervalMoversChange

View Intrinio API Documentation

SecurityIntervalsMoversResult getSecurityIntervalMoversChange(opts)

Security Intervals Movers By Change

Returns a list of intervals for the biggest movers by change over the last hour interval.

Example

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 opts = { 
  'source': null,
  'openTime': null
};

security.getSecurityIntervalMoversChange(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
source	String	Realtime or 15-minute delayed contracts.	[optional]
openTime	Date	The inclusive UTC date and time the interval opens at.	[optional]

Return type

SecurityIntervalsMoversResult

getSecurityIntervalMoversVolume

View Intrinio API Documentation

SecurityIntervalsMoversResult getSecurityIntervalMoversVolume(opts)

Security Intervals Movers By Volume

Returns a list of intervals for the biggest movers by volume over the last hour interval.

Example

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 opts = { 
  'source': null,
  'openTime': null
};

security.getSecurityIntervalMoversVolume(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
source	String	Realtime or 15-minute delayed contracts.	[optional]
openTime	Date	The inclusive UTC date and time the interval opens at.	[optional]

Return type

SecurityIntervalsMoversResult

getSecurityIntervalPrices

View Intrinio API Documentation

ApiResponseSecurityIntervalPrices getSecurityIntervalPrices(identifier, intervalSize, opts)

Interval Stock Prices for Security

Return open, close, high, low, volume, average price, and change ratio for a particular interval for the Security with the given `identifier`

Example

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 intervalSize = "15m";


var opts = { 
  'source': null,
  'startDate': new Date("2023-01-01"),
  'startTime': "33300",
  'endDate': new Date("2023-02-01"),
  'endTime': "33300",
  'timezone': "UTC",
  'pageSize': 100,
  'splitAdjusted': false,
  'includeQuoteOnlyBars': false,
  'nextPage': null
};

security.getSecurityIntervalPrices(identifier, intervalSize, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
intervalSize	String	The interval for which to return stock prices	[default to 15m]
source	String	Return intervals from the specified data source	[optional]
startDate	Date	Return intervals starting at the specified date	[optional]
startTime	String	Return intervals starting at the specified time on the `start_date` (24-hour in 'hh:mm:ss' format)	[optional]
endDate	Date	Return intervals stopping at the specified date	[optional]
endTime	String	Return intervals stopping at the specified time on the `end_date` (24-hour in 'hh:mm:ss' format)	[optional]
timezone	String	Interprets the input times in this time zone, as well as returns times in this timezone.	[optional] [default to UTC]
pageSize	Number	The number of results to return	[optional] [default to 100]
splitAdjusted	Boolean	Whether to return the values adjusted for splits or not. Default is false.	[optional] [default to false]
includeQuoteOnlyBars	Boolean	If true, also include bars where no trades occurred but quotes did.	[optional] [default to false]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityIntervalPrices

getSecurityIntradayPrices

View Intrinio API Documentation

ApiResponseSecurityIntradayPrices getSecurityIntradayPrices(identifier, opts)

Intraday Stock Prices for Security

Deprecated. Return intraday stock prices for the Security with the given `identifier`

Example

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 = { 
  'source': null,
  'startDate': new Date("2018-01-01"),
  'startTime': null,
  'endDate': new Date("2019-01-01"),
  'endTime': null,
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityIntradayPrices(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
source	String	Return intraday prices from the specified data source	[optional]
startDate	Date	Return intraday prices starting at the specified date	[optional]
startTime	String	Return intraday prices starting at the specified time on the `start_date` (24-hour in 'hh:mm' format, UTC timezone)	[optional]
endDate	Date	Return intraday prices stopping at the specified date	[optional]
endTime	String	Return intraday prices stopping at the specified time on the `end_date` (24-hour in 'hh:mm' format, UTC timezone)	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityIntradayPrices

getSecurityLatestDividendRecord

View Intrinio API Documentation

DividendRecord getSecurityLatestDividendRecord(identifier)

Latest Dividend Record for Security

Returns the latest available dividend information for the Security with the given `identifier`

Example

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


security.getSecurityLatestDividendRecord(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)

Return type

DividendRecord

getSecurityLatestEarningsRecord

View Intrinio API Documentation

EarningsRecord getSecurityLatestEarningsRecord(identifier)

Latest Earnings Record for Security

Returns latest available earnings information for the Security with the given `identifier`

Example

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


security.getSecurityLatestEarningsRecord(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)

Return type

EarningsRecord

getSecurityPriceTechnicalsAdi

View Intrinio API Documentation

ApiResponseSecurityAccumulationDistributionIndex getSecurityPriceTechnicalsAdi(identifier, opts)

Accumulation/Distribution Index

The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock`s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.

Example

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 = { 
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsAdi(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityAccumulationDistributionIndex

getSecurityPriceTechnicalsAdtv

View Intrinio API Documentation

ApiResponseSecurityAverageDailyTradingVolume getSecurityPriceTechnicalsAdtv(identifier, opts)

Average Daily Trading Volume

Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.

Example

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': 22,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsAdtv(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Average Daily Trading Volume	[optional] [default to 22]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityAverageDailyTradingVolume

getSecurityPriceTechnicalsAdx

View Intrinio API Documentation

ApiResponseSecurityAverageDirectionalIndex getSecurityPriceTechnicalsAdx(identifier, opts)

Average Directional Index

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

Example

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.getSecurityPriceTechnicalsAdx(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

ApiResponseSecurityAverageDirectionalIndex

getSecurityPriceTechnicalsAo

View Intrinio API Documentation

ApiResponseSecurityAwesomeOscillator getSecurityPriceTechnicalsAo(identifier, opts)

Awesome Oscillator

The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period`s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.

Example

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 = { 
  'shortPeriod': 5,
  'longPeriod': 34,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsAo(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
shortPeriod	Number	The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator	[optional] [default to 5]
longPeriod	Number	The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator	[optional] [default to 34]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityAwesomeOscillator

getSecurityPriceTechnicalsAtr

View Intrinio API Documentation

ApiResponseSecurityAverageTrueRange getSecurityPriceTechnicalsAtr(identifier, opts)

Average True Range

The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.

Example

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.getSecurityPriceTechnicalsAtr(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Average True Range	[optional] [default to 14]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityAverageTrueRange

getSecurityPriceTechnicalsBb

View Intrinio API Documentation

ApiResponseSecurityBollingerBands getSecurityPriceTechnicalsBb(identifier, opts)

Bollinger Bands

Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying`s price moves towards the upper band and oversold as the underlying price moves towards the lower band.

Example

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': 20,
  'standardDeviations': 2.0,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsBb(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Bollinger Bands	[optional] [default to 20]
standardDeviations	Number	The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands	[optional] [default to 2.0]
priceKey	String	The Stock Price field to use when calculating Bollinger Bands	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityBollingerBands

getSecurityPriceTechnicalsCci

View Intrinio API Documentation

ApiResponseSecurityCommodityChannelIndex getSecurityPriceTechnicalsCci(identifier, opts)

Commodity Channel Index

The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.

Example

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': 20,
  'constant': 0.015,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsCci(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Commodity Channel Index	[optional] [default to 20]
constant	Number	The number of observations, per period, to calculate Commodity Channel Index	[optional] [default to 0.015]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityCommodityChannelIndex

getSecurityPriceTechnicalsCmf

View Intrinio API Documentation

ApiResponseSecurityChaikinMoneyFlow getSecurityPriceTechnicalsCmf(identifier, opts)

Chaikin Money Flow

The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.

Example

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': 20,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsCmf(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Chaikin Money Flow	[optional] [default to 20]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityChaikinMoneyFlow

getSecurityPriceTechnicalsDc

View Intrinio API Documentation

ApiResponseSecurityDonchianChannel getSecurityPriceTechnicalsDc(identifier, opts)

Donchian Channel

The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).

Example

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': 20,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsDc(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Donchian Channel	[optional] [default to 20]
priceKey	String	The Stock Price field to use when calculating Donchian Channel	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityDonchianChannel

getSecurityPriceTechnicalsDpo

View Intrinio API Documentation

ApiResponseSecurityDetrendedPriceOscillator getSecurityPriceTechnicalsDpo(identifier, opts)

Detrended Price Oscillator

The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.

Example

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': 20,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsDpo(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Detrended Price Oscillator	[optional] [default to 20]
priceKey	String	The Stock Price field to use when calculating Detrended Price Oscillator	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityDetrendedPriceOscillator

getSecurityPriceTechnicalsEom

View Intrinio API Documentation

ApiResponseSecurityEaseOfMovement getSecurityPriceTechnicalsEom(identifier, opts)

Ease of Movement

The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol`s price is rising with relative ease and negative value indicates the underlying symbol`s price is failing with relative ease.

Example

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': 20,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsEom(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Ease of Movement	[optional] [default to 20]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityEaseOfMovement

getSecurityPriceTechnicalsFi

View Intrinio API Documentation

ApiResponseSecurityForceIndex getSecurityPriceTechnicalsFi(identifier, opts)

Force Index

The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol`s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.

Example

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 = { 
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsFi(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityForceIndex

getSecurityPriceTechnicalsIchimoku

View Intrinio API Documentation

ApiResponseSecurityIchimokuKinkoHyo getSecurityPriceTechnicalsIchimoku(identifier, opts)

Ichimoku Kinko Hyo

The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.

Example

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 = { 
  'lowPeriod': 9,
  'mediumPeriod': 26,
  'highPeriod': 52,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsIchimoku(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
lowPeriod	Number	The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo	[optional] [default to 9]
mediumPeriod	Number	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]
highPeriod	Number	The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo	[optional] [default to 52]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityIchimokuKinkoHyo

getSecurityPriceTechnicalsKc

View Intrinio API Documentation

ApiResponseSecurityKeltnerChannel getSecurityPriceTechnicalsKc(identifier, opts)

Keltner Channel

The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.

Example

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': 10,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsKc(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Kelter Channel	[optional] [default to 10]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityKeltnerChannel

getSecurityPriceTechnicalsKst

View Intrinio API Documentation

ApiResponseSecurityKnowSureThing getSecurityPriceTechnicalsKst(identifier, opts)

Know Sure Thing

The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.

Example

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 = { 
  'roc1': 10,
  'roc2': 15,
  'roc3': 20,
  'roc4': 30,
  'sma1': 10,
  'sma2': 10,
  'sma3': 10,
  'sma4': 15,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsKst(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
roc1	Number	The number of observations, per period, to calculate the rate-of-change for RCMA1	[optional] [default to 10]
roc2	Number	The number of observations, per period, to calculate the rate-of-change for RCMA2	[optional] [default to 15]
roc3	Number	The number of observations, per period, to calculate the rate-of-change for RCMA3	[optional] [default to 20]
roc4	Number	The number of observations, per period, to calculate the rate-of-change for RCMA4	[optional] [default to 30]
sma1	Number	The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1	[optional] [default to 10]
sma2	Number	The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2	[optional] [default to 10]
sma3	Number	The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3	[optional] [default to 10]
sma4	Number	The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4	[optional] [default to 15]
priceKey	String	The Stock Price field to use when calculating Know Sure Thing	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityKnowSureThing

getSecurityPriceTechnicalsMacd

View Intrinio API Documentation

ApiResponseSecurityMovingAverageConvergenceDivergence getSecurityPriceTechnicalsMacd(identifier, opts)

Moving Average Convergence Divergence

Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security`s price.

Example

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 = { 
  'fastPeriod': 12,
  'slowPeriod': 26,
  'signalPeriod': 9,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsMacd(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
fastPeriod	Number	The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence	[optional] [default to 12]
slowPeriod	Number	The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence	[optional] [default to 26]
signalPeriod	Number	The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence	[optional] [default to 9]
priceKey	String	The Stock Price field to use when calculating Moving Average Convergence Divergence	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityMovingAverageConvergenceDivergence

getSecurityPriceTechnicalsMfi

View Intrinio API Documentation

ApiResponseSecurityMoneyFlowIndex getSecurityPriceTechnicalsMfi(identifier, opts)

Money Flow Index

The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.

Example

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.getSecurityPriceTechnicalsMfi(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Money Flow Index	[optional] [default to 14]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityMoneyFlowIndex

getSecurityPriceTechnicalsMi

View Intrinio API Documentation

ApiResponseSecurityMassIndex getSecurityPriceTechnicalsMi(identifier, opts)

Mass Index

The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.

Example

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 = { 
  'emaPeriod': 9,
  'sumPeriod': 25,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsMi(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
emaPeriod	Number	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]
sumPeriod	Number	The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index	[optional] [default to 25]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityMassIndex

getSecurityPriceTechnicalsNvi

View Intrinio API Documentation

ApiResponseSecurityNegativeVolumeIndex getSecurityPriceTechnicalsNvi(identifier, opts)

Negative Volume Index

The negative volume index (NVI) is often referred to as the `smart money indicator.` It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.

Example

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 = { 
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsNvi(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityNegativeVolumeIndex

getSecurityPriceTechnicalsObv

View Intrinio API Documentation

ApiResponseSecurityOnBalanceVolume getSecurityPriceTechnicalsObv(identifier, opts)

On-balance Volume

On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.

Example

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 = { 
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsObv(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityOnBalanceVolume

getSecurityPriceTechnicalsObvMean

View Intrinio API Documentation

ApiResponseSecurityOnBalanceVolumeMean getSecurityPriceTechnicalsObvMean(identifier, opts)

On-balance Volume Mean

On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period. When both OBVM and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.

Example

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': 10,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsObvMean(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate On-balance Volume Mean	[optional] [default to 10]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityOnBalanceVolumeMean

getSecurityPriceTechnicalsRsi

View Intrinio API Documentation

ApiResponseSecurityRelativeStrengthIndex getSecurityPriceTechnicalsRsi(identifier, opts)

Relative Strength Index

Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.

Example

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,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsRsi(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Relative Strength Index	[optional] [default to 14]
priceKey	String	The Stock Price field to use when calculating Relative Strength Index	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityRelativeStrengthIndex

getSecurityPriceTechnicalsSma

View Intrinio API Documentation

ApiResponseSecuritySimpleMovingAverage getSecurityPriceTechnicalsSma(identifier, opts)

Simple Moving Average

A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal`s abilities.

Example

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': 20,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsSma(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Simple Moving Average	[optional] [default to 20]
priceKey	String	The Stock Price field to use when calculating Simple Moving Average	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecuritySimpleMovingAverage

getSecurityPriceTechnicalsSr

View Intrinio API Documentation

ApiResponseSecurityStochasticOscillator getSecurityPriceTechnicalsSr(identifier, opts)

Stochastic Oscillator

The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period`s high-low range and vice versa if the reading is below 20.

Example

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,
  'signalPeriod': 3,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsSr(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate %K of Stochastic Oscillator	[optional] [default to 14]
signalPeriod	Number	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]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityStochasticOscillator

getSecurityPriceTechnicalsTrix

View Intrinio API Documentation

ApiResponseSecurityTripleExponentialAverage getSecurityPriceTechnicalsTrix(identifier, opts)

Triple Exponential Average

The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security`s moving average, the TEA filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.

Example

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': 15,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsTrix(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average	[optional] [default to 15]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityTripleExponentialAverage

getSecurityPriceTechnicalsTsi

View Intrinio API Documentation

ApiResponseSecurityTrueStrengthIndex getSecurityPriceTechnicalsTsi(identifier, opts)

True Strength Index

The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.

Example

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 = { 
  'lowPeriod': 13,
  'highPeriod': 25,
  'priceKey': "close",
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsTsi(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
lowPeriod	Number	The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index	[optional] [default to 13]
highPeriod	Number	The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index	[optional] [default to 25]
priceKey	String	The Stock Price field to use when calculating True Strength Index	[optional] [default to close]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityTrueStrengthIndex

getSecurityPriceTechnicalsUo

View Intrinio API Documentation

ApiResponseSecurityUltimateOscillator getSecurityPriceTechnicalsUo(identifier, opts)

Ultimate Oscillator

The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO`s value is above 70 a security is categorized as overbought and when UO`s value is below 30 a security is categorized as oversold.

Example

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 = { 
  'shortPeriod': 7,
  'mediumPeriod': 14,
  'longPeriod': 28,
  'shortWeight': 4.0,
  'mediumWeight': 2.0,
  'longWeight': 1.0,
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsUo(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
shortPeriod	Number	The number of observations, per period, to calculate the short period for Ultimate Oscillator	[optional] [default to 7]
mediumPeriod	Number	The number of observations, per period, to calculate the medium period for Ultimate Oscillator	[optional] [default to 14]
longPeriod	Number	The number of observations, per period, to calculate the long period for Ultimate Oscillator	[optional] [default to 28]
shortWeight	Number	The weight of short Buying Pressure average for Ultimate Oscillator	[optional] [default to 4.0]
mediumWeight	Number	The weight of medium Buying Pressure average for Ultimate Oscillator	[optional] [default to 2.0]
longWeight	Number	The weight of long Buying Pressure average for Ultimate Oscillator	[optional] [default to 1.0]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityUltimateOscillator

getSecurityPriceTechnicalsVi

View Intrinio API Documentation

ApiResponseSecurityVortexIndicator getSecurityPriceTechnicalsVi(identifier, opts)

Vortex Indicator

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.

Example

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);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to calculate Vortex Indicator	[optional] [default to 14]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityVortexIndicator

getSecurityPriceTechnicalsVpt

View Intrinio API Documentation

ApiResponseSecurityVolumePriceTrend getSecurityPriceTechnicalsVpt(identifier, opts)

Volume-price Trend

The volume price trend (VPT) is a technical indicator that uses price & volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.

Example

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 = { 
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsVpt(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityVolumePriceTrend

getSecurityPriceTechnicalsVwap

View Intrinio API Documentation

ApiResponseSecurityVolumeWeightedAveragePrice getSecurityPriceTechnicalsVwap(identifier, opts)

Volume Weighted Average Price

Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security`s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.

Example

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 = { 
  'startDate': "2018-01-01",
  'endDate': "2019-01-01",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityPriceTechnicalsVwap(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityVolumeWeightedAveragePrice

getSecurityPriceTechnicalsWr

View Intrinio API Documentation

ApiResponseSecurityWilliamsR getSecurityPriceTechnicalsWr(identifier, opts)

Williams %R

Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.

Example

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.getSecurityPriceTechnicalsWr(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
period	Number	The number of observations, per period, to look-back when calculating Williams %R	[optional] [default to 14]
startDate	String	Return technical indicator values on or after the date	[optional]
endDate	String	Return technical indicator values on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityWilliamsR

getSecurityQuote

View Intrinio API Documentation

ApiResponseSecurityQuote getSecurityQuote(identifier, opts)

Quote for a Security

Returns many popular metrics for a security from multiple products conveniently in one API. Realtime stock price data requires at least one realtime product subscription (IEX, NASDAQ Basic, and/or Delayed SIP). If you are subscribed to multiple realtime stock price products, the api will return the most recent realtime stock price. Previous close price and percent change fields require both an EoD US Stock Price subscription and a realtime stock price subscription. Market_cap, price_to_earnings, and dividendyield data fields require a fundamentals subscription.

Example

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 = { 
  'activeOnly': false,
  'source': "delayed_sip",
  'nextPage': null
};

security.getSecurityQuote(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
activeOnly	Boolean	Whether to return only realtime prices from today.	[optional] [default to false]
source	String	Return the realtime price from the specified source instead of the most recent.	[optional]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityQuote

getSecurityRealtimePrice

View Intrinio API Documentation

RealtimeStockPrice getSecurityRealtimePrice(identifier, opts)

Realtime Stock Price for Security

Return the realtime stock price for the Security with the given `identifier`

Example

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 = { 
  'source': ["iex,delayed_sip"]
};

security.getSecurityRealtimePrice(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
source	[String]	Return the realtime price from the specified comma-delimited data sources. If no source is specified, the best source available is used.	[optional]

Return type

RealtimeStockPrice

getSecurityReplayFile

View Intrinio API Documentation

SecurityReplayFileResult getSecurityReplayFile(subsource, date)

Security Replay File

Returns a url where the requested replay file may be downloaded from.

Example

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 subsource = null;
var date = null;


security.getSecurityReplayFile(subsource, date).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
subsource	String	The specific source of the data being requested.
date	Date	The date for the data being requested.

Return type

SecurityReplayFileResult

getSecuritySnapshots

View Intrinio API Documentation

SecuritySnapshotsResult getSecuritySnapshots(opts)

Realtime Stock Prices Snapshot

Returns all security snapshots for the queried interval with links to download.

Example

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 opts = { 
  'atDatetime': null
};

security.getSecuritySnapshots(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
atDatetime	Date	The UTC date and time (with url-encoded spaces) the snapshot will cover.	[optional]

Return type

SecuritySnapshotsResult

getSecurityStockPriceAdjustments

View Intrinio API Documentation

ApiResponseSecurityStockPriceAdjustments getSecurityStockPriceAdjustments(identifier, opts)

Stock Price Adjustments by Security

Returns stock price adjustments for the Security with the given `identifier`

Example

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 = { 
  'startDate': new Date("2018-01-01"),
  'endDate': new Date("2019-01-01"),
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityStockPriceAdjustments(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	Date	Return price adjustments on or after the date	[optional]
endDate	Date	Return price adjustments on or before the date	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityStockPriceAdjustments

getSecurityStockPrices

View Intrinio API Documentation

ApiResponseSecurityStockPrices getSecurityStockPrices(identifier, opts)

Stock Prices by Security

Return end-of-day stock prices for the Security with the given `identifier`

Example

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 = { 
  'startDate': new Date("2018-01-01"),
  'endDate': new Date("2019-01-01"),
  'frequency': "daily",
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityStockPrices(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	Date	Return prices on or after the date	[optional]
endDate	Date	Return prices on or before the date	[optional]
frequency	String	Return stock prices in the given frequency	[optional] [default to daily]
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityStockPrices

getSecurityTrades

View Intrinio API Documentation

SecurityTradesResult getSecurityTrades(source, opts)

Security Trades

Returns all trades between start time and end time, up to seven days ago for the specified source.

Example

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 source = null;


var opts = { 
  'startDate': null,
  'startTime': null,
  'endDate': null,
  'endTime': null,
  'timezone': "UTC",
  'pageSize': 100,
  'darkpoolOnly': false,
  'minSize': 100,
  'nextPage': null
};

security.getSecurityTrades(source, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
source	String	The specific source of the data being requested.
startDate	Date	The start date for the data being requested.	[optional]
startTime	String	The start time for the data being requested.	[optional]
endDate	Date	The end date for the data being requested.	[optional]
endTime	String	The end time for the data being requested.	[optional]
timezone	String	The timezone the start and end date/times use.	[optional] [default to UTC]
pageSize	Number	The maximum number of results to return per page.	[optional] [default to 100]
darkpoolOnly	Boolean	Set to true to show only darkpool trades	[optional] [default to false]
minSize	Number	Trades must be larger or equal to this size.	[optional]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

SecurityTradesResult

getSecurityTradesBySymbol

View Intrinio API Documentation

SecurityTradesResult getSecurityTradesBySymbol(identifier, source, opts)

Security Trades By Symbol

Returns all trades for a symbol between start time and end time, up to seven days ago for the specified source.

Example

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 source = null;


var opts = { 
  'startDate': null,
  'startTime': null,
  'endDate': null,
  'endTime': null,
  'timezone': "UTC",
  'darkpoolOnly': false,
  'pageSize': 100,
  'minSize': 100,
  'nextPage': null
};

security.getSecurityTradesBySymbol(identifier, source, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	The ticker symbol for which trades are being requested.
source	String	The specific source of the data being requested. Specifying delayed sip will result in the system automatically determining which delayed sip source (cta_delayed, cta_b_delayed, utp_delayed, otc_delayed) to use.
startDate	Date	The start date for the data being requested.	[optional]
startTime	String	The start time for the data being requested.	[optional]
endDate	Date	The end date for the data being requested.	[optional]
endTime	String	The end time for the data being requested.	[optional]
timezone	String	The timezone the start and end date/times use.	[optional] [default to UTC]
darkpoolOnly	Boolean	Set to true to show only darkpool trades	[optional] [default to false]
pageSize	Number	The maximum number of results to return per page.	[optional] [default to 100]
minSize	Number	Trades must be larger or equal to this size.	[optional]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

SecurityTradesResult

getSecurityZacksAnalystRatings

View Intrinio API Documentation

ApiResponseSecurityZacksAnalystRatings getSecurityZacksAnalystRatings(identifier, opts)

Zacks Analyst Ratings for Security

This database offers consensus analyst recommendations for over 5,000 US and Canadian listed companies.

Example

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 = { 
  'startDate': null,
  'endDate': null,
  'meanGreater': null,
  'meanLess': null,
  'strongBuysGreater': null,
  'strongBuysLess': null,
  'buysGreater': null,
  'buysLess': null,
  'holdsGreater': null,
  'holdsLess': null,
  'sellsGreater': null,
  'sellsLess': null,
  'strongSellsGreater': null,
  'strongSellsLess': null,
  'totalGreater': null,
  'totalLess': null,
  'pageSize': 100
};

security.getSecurityZacksAnalystRatings(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
startDate	String	Limit ratings to those on or after this date	[optional]
endDate	String	Limit ratings to those on or before this date	[optional]
meanGreater	Number	Return only records with a mean (average) higher than this value	[optional]
meanLess	Number	Return only records with a mean (average) lower than this value	[optional]
strongBuysGreater	Number	Return only records with more than this many Strong Buy recommendations	[optional]
strongBuysLess	Number	Return only records with fewer than this many Strong Buy recommendations	[optional]
buysGreater	Number	Return only records with more than this many Buy recommendations	[optional]
buysLess	Number	Return only records with fewer than this many Buy recommendations	[optional]
holdsGreater	Number	Return only records with more than this many Hold recommendations	[optional]
holdsLess	Number	Return only records with fewer than this many Hold recommendations	[optional]
sellsGreater	Number	Return only records with more than this many Sell recommendations	[optional]
sellsLess	Number	Return only records with fewer than this many Sell recommendations	[optional]
strongSellsGreater	Number	Return only records with more than this many Strong Sell recommendations	[optional]
strongSellsLess	Number	Return only records with fewer than this many Strong Sell recommendations	[optional]
totalGreater	Number	Return only records with more than this many recommendations, regardless of type	[optional]
totalLess	Number	Return only records with fewer than this many recommendations, regardless of type	[optional]
pageSize	Number	The number of results to return	[optional] [default to 100]

Return type

ApiResponseSecurityZacksAnalystRatings

getSecurityZacksAnalystRatingsSnapshot

View Intrinio API Documentation

ApiResponseSecurityZacksAnalystRatingsSnapshot getSecurityZacksAnalystRatingsSnapshot(identifier, opts)

Zacks Analyst Ratings Snapshot

This database offers current and historical consensus analyst recommendation snapshots for over 5,000 US and Canadian listed companies.

Example

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 = { 
  'date': null
};

security.getSecurityZacksAnalystRatingsSnapshot(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
date	String	Lookup a historical snapshot on the given date	[optional]

Return type

ApiResponseSecurityZacksAnalystRatingsSnapshot

getSecurityZacksEpsSurprises

View Intrinio API Documentation

ApiResponseSecurityZacksEPSSurprises getSecurityZacksEpsSurprises(identifier, opts)

Zacks EPS Surprises for Security

Returns historical estimated and actual earnings, guidance, and announcement dates for a specified symbol.

Example

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 = { 
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityZacksEpsSurprises(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityZacksEPSSurprises

getSecurityZacksSalesSurprises

View Intrinio API Documentation

ApiResponseSecurityZacksSalesSurprises getSecurityZacksSalesSurprises(identifier, opts)

Zacks Sales Surprises for Security

This database returns historical estimated and actual sales, guidance, and announcement dates for a specified US or Canadian company.

Example

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 = { 
  'pageSize': 100,
  'nextPage': null
};

security.getSecurityZacksSalesSurprises(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
identifier	String	A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
pageSize	Number	The number of results to return	[optional] [default to 100]
nextPage	String	Gets the next page of data from a previous API call	[optional]

Return type

ApiResponseSecurityZacksSalesSurprises

screenSecurities

View Intrinio API Documentation

[SecurityScreenResult] screenSecurities(opts)

Screen Securities

Screen Securities using complex logic. Use POST only. See <a href="https://docs.intrinio.com/documentation/screener_v2\" target="_blank">screener documentation</a> for details on how to construct conditions.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var security = new intrinioSDK.SecurityApi();

clauses = [
  {
    "field": "marketcap",
    "operator": "gt",
    "value": "10000000"
  },
  {
    "field": "beta",
    "operator": "lt",
    "value": "5"
  }
]

var logic = new intrinioSDK.SecurityScreenGroup()
logic.operator = "AND"
logic.clauses = clauses

var opts = { 
  'logic': logic,
  'orderColumn': "marketcap",
  'orderDirection': "asc",
  'primaryOnly': false,
  'pageSize': 100
};

security.screenSecurities(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
logic	SecurityScreenGroup	The logic to screen with, consisting of operators, clauses, and nested groups. </br> See <a href="https://docs.intrinio.com/documentation/screener_v2\" target="_blank">screener documentation</a> for details on how to construct conditions.	[optional]
orderColumn	String	Results returned sorted by this column	[optional]
orderDirection	String	Sort order to use with the order_column	[optional] [default to asc]
primaryOnly	Boolean	Return only primary securities	[optional] [default to false]
pageSize	Number	The number of results to return. Maximum for this endpoint is 50000.	[optional] [default to 100]

Return type

[SecurityScreenResult]

searchSecurities

View Intrinio API Documentation

ApiResponseSecuritiesSearch searchSecurities(query, opts)

Search Securities

Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.

Example

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 query = "Apple";


var opts = { 
  'pageSize': 100
};

security.searchSecurities(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
query	String
pageSize	Number	The number of results to return	[optional] [default to 100]

Return type

ApiResponseSecuritiesSearch

Files

SecurityApi.md

Latest commit

History

SecurityApi.md

File metadata and controls

intrinioSDK.SecurityApi

getAllSecurities

All Securities

Example

Parameters

Return type

getSecurityById

Lookup Security

Example

Parameters

Return type

getSecurityDataPointNumber

Data Point (Number) for Security

Example

Parameters

Return type

getSecurityDataPointText

Data Point (Text) for Security

Example

Parameters

Return type

getSecurityHistoricalData

Historical Data for Security

Example

Parameters

Return type

getSecurityHistoryByIdentifier

Security History By Identifier

Example

Parameters

Return type

getSecurityHistoryByTicker

Security History By Ticker

Example

Parameters

Return type

getSecurityInsiderOwnership

Institutional Ownership by Security

Example

Parameters

Return type

getSecurityIntervalMovers

Security Intervals Movers

Example

Parameters

Return type

getSecurityIntervalMoversChange

Security Intervals Movers By Change

Example

Parameters

Return type

getSecurityIntervalMoversVolume

Security Intervals Movers By Volume

Example

Parameters

Return type

getSecurityIntervalPrices

Interval Stock Prices for Security

Example

Parameters

Return type

getSecurityIntradayPrices

Intraday Stock Prices for Security

Example

Parameters

Return type

getSecurityLatestDividendRecord

Latest Dividend Record for Security

Example

Parameters

Return type

getSecurityLatestEarningsRecord

Latest Earnings Record for Security

Example