Javascript SDK

  6.35.0

The Intrinio Javascript SDK wraps all API endpoints into an easy-to-use set of classes, methods, and response objects.

Javascript SDK Installation

To install the SDK use NPM:

npm install intrinio-sdk --save

Be sure to require the SDK in your code as follows:

var intrinioSDK = require('intrinio-sdk');
View Javascript SDK on GitHub

Stock Price Code Example

Use my API Key
var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;
var security = new intrinioSDK.SecurityApi();
var identifier = "AAPL";
var opts = {
'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);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

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

object
RealtimeStockPrice

Properties

NameTypeDescription
lastPriceNumberThe price of the last trade.  
lastTimeDateThe date and time when the last trade occurred.  
lastSizeNumberThe size of the last trade.  
bidPriceNumberThe price of the top bid order.  
bidSizeNumberThe size of the top bid order.  
bidTimeDateThe date and time when the last bid occurred.  
askPriceNumberThe price of the top ask order.  
askSizeNumberThe size of the top ask order.  
askTimeDateThe date and time when the last ask occurred.  
openPriceNumberThe price at the open of the trading day.  
closePriceNumberThe price at the close of the trading day. (IEX only)  
highPriceNumberThe high price for the trading day.  
lowPriceNumberThe low price for the trading day.  
exchangeVolumeNumberThe number of shares exchanged during the trading day on the exchange.  
marketVolumeNumberThe number of shares exchanged during the trading day for the whole market.  
updatedOnDateThe date and time when the data was last updated.  
eodClosePriceNumberThe previous trading session's closing price.  
eodCloseDateDateThe date of the previous trading session's closing price.  
normalMarketHoursLastTimeDateThe date and time of the last trade that qualifies for last price consideration during normal market hours according to exchange rules on trade conditions.  
normalMarketHoursLastPriceNumberThe price of the last that qualifies for last price consideration during normal market hours according to exchange rules on trade conditions.  
normalMarketHoursLastSizeNumberThe size of the last trade that qualifies for last price consideration during normal market hours according to exchange rules on trade conditions.  
qualifiedLastPriceNumberThe price of the last trade that qualifies for last price consideration according to exchange rules on trade conditions.  
qualifiedLastTimeDateThe date and time of the last trade that qualifies for last price consideration according to exchange rules on trade conditions.  
qualifiedLastSizeNumberThe size of the last trade that qualifies for last price consideration according to exchange rules on trade conditions.  
sourceStringThe source of the data.  
listingVenueStringThe listing venue where the trade took place. Available only where source is SIP. Listing Venue Modifiers include: Q – NasdaqN – NYSEA – NYSE AmericanP – NYSE Arcau – Other OTC MarketsV – Investors Exchange LLC  
salesConditionsStringWhen applicable, indicates any sales condition modifiers associated with the trade. Sales Condition Modifers include: @ – Regular SaleA – AcquisitionB – Bunched TradeC – Cash SaleD – DistributionE – PlaceholderF – Intermarket SweepG – Bunched Sold TradeH – Priced Variation TradeI – Odd Lot TradeK – Rule 155 Trade (AMEX)L – Sold LastM – Market Center Official CloseN – Next DayO – Opening PrintsP – Prior Reference PriceQ – Market Center Official OpenR – SellerS – Split TradeT – Form TU – Extended Trading Hours (Sold Out of Sequence)V – Contingent TradeW – Average Price TradeX – Cross/Periodic Auction TradeY – Yellow Flag Regular TradeZ – Sold (Out of Sequence)1 – Stopped Stock (Regular Trade)4 – Derivatively Priced5 – Re-Opening Prints6 – Closing Prints7 – Qualified Contingent Trade (QCT)8 – Placeholder for 611 Exempt9 – Corrected Consolidated Close (Per Listing Market)  
quoteConditionsStringWhen applicable, indicates any quote condition modifiers associated with the trade. Quote Condition Modifiers include: R – RegularA – Slow on Ask– Slow on BidC – ClosingD – News DisseminationF – Slow on ASK (LRP or Gap Quote)E – Slow on Bid (LRP or Gap Quote)G – Trading Range IndicationH – Slow on Bid and AskI – Order ImbalanceJ – Due to Related - News DisseminationK – Due to Related - News PendingO – OpenL – ClosedM – Volatility Trading PauseN – Non-Firm QuoteO – OpeningP – News PendingS – Due to RelatedT – ResumeU – Slow on Bid and Ask (LRP or Gap Quote)V – In View of CommonW – Slow on Bid and Ask (LRP or Gap Quote)X – Equipment ChangeoverY – Sub-Penny TradingZ – No Open / No ResumeF – Fast TradingU – Slow on Bid and Ask (Non-Firm)One-Sided – One-SidedX – Order Influx0 – Special Opening QuoteHalted – HaltedBenchmark – BenchmarkImplied – ImpliedExchange Best – Exchange Best1 – Market Wide Circuit Breaker Level 12 – Market Wide Circuit Breaker Level 23 – Market Wide Circuit Breaker Level 3Rotation – RotationAuto Exec Eligible – Auto Exec EligibleBid Side Firm – Bid Side FirmAsk Side Firm – Ask Side Firm4 – On Demand Intraday AuctionI – Indicative Value (OPRA)45 – Additional Information Required (CTS)46 – Regulatory Concern (CTS)47 – Merger Effective49 – Corporate Action (CTS)50 – New Security Offering (CTS)51 – Intraday Indicative Value Unavailable (CTS)  
marketCenterCodeStringThe market center character code.  
isDarkpoolBooleanWhether or not the current trade is from a darkpool or not.  
securityRealtimeStockPriceSecurity 
object
RealtimeStockPriceSecurity

Properties

NameTypeDescription
idStringThe Intrinio ID for Security  
tickerStringThe common/local ticker of the Security  
exchangeTickerStringThe exchange-level ticker  
figiStringThe OpenFIGI identifier  
compositeFigiStringThe country-composite OpenFIGI identifier  
View Documentation for Realtime Stock Price for Security Example

Release History

6.35.0

Released 02/26/2025

No release notes for this build.

javascript-sdk-source-code-6.35.0.zip

6.34.0

Released 11/27/2024

No release notes for this build.

javascript-sdk-source-code-6.34.0.zip

6.33.0

Released 11/21/2024

No release notes for this build.

javascript-sdk-source-code-6.33.0.zip

6.32.0

Released 10/31/2024
javascript-sdk-source-code-6.32.0.zip

6.31.0

Released 09/19/2024

Added stock exchange quote endpoint

javascript-sdk-source-code-6.31.0.zip

6.30.0

Released 08/23/2024

Fix type on one endpoint.
Add quote type fields to equity intervals.

javascript-sdk-source-code-6.30.0.zip

6.29.1

Released 08/10/2024

No release notes for this build.

javascript-sdk-source-code-6.29.1.zip

6.29.0

Released 08/02/2024

Quote endpoint
Allow multiple tickers on specific endpoint

javascript-sdk-source-code-6.29.0.zip

6.28.1

Released 07/22/2024
javascript-sdk-source-code-6.28.1.zip

6.28.0

Released 07/22/2024

No release notes for this build.

javascript-sdk-source-code-6.28.0.zip

6.27.4

Released 06/25/2024

No release notes for this build.

javascript-sdk-source-code-6.27.4.zip

6.27.3

Released 06/05/2024

No release notes for this build.

javascript-sdk-source-code-6.27.3.zip

6.27.2

Released 04/10/2024
javascript-sdk-source-code-6.27.2.zip

6.27.0

Released 03/11/2024

No release notes for this build.

javascript-sdk-source-code-6.27.0.zip

6.26.8

Released 02/20/2024

Added Zacks Sales Estimate Endpoint

javascript-sdk-source-code-6.26.8.zip

6.26.7

Released 02/06/2024

No release notes for this build.

javascript-sdk-source-code-6.26.7.zip

6.26.6

Released 02/01/2024

No release notes for this build.

javascript-sdk-source-code-6.26.6.zip

6.26.5

Released 12/21/2023

Add extended price fields to options realtime calls
Add bid/ask time and size to options eod calls

javascript-sdk-source-code-6.26.5.zip

6.26.3

Released 12/05/2023

Documentation updates and fixes

javascript-sdk-source-code-6.26.3.zip

6.26.2

Released 11/08/2023

-Adjusting and releasing Company Public Float endpoint.

javascript-sdk-source-code-6.26.2.zip

6.26.1

Released 10/03/2023

Added missing preexisting parameters to SDK methods.

javascript-sdk-source-code-6.26.1.zip

6.26.0

Released 09/08/2023

Add extra hint message to a Trade Alerts endpoint if user doesn’t have access
Fix enum on depreciated intraday endpoint docs
Add date filters to shares outstanding endpoint
Allow either datetime format for param on snapshot endpoints
Add missing next page param to docs for institutional ownership endpoint
Add documentation for market status endpoint

javascript-sdk-source-code-6.26.0.zip

6.25.0

Released 08/01/2023

Can specify greeks underlying price source in some options calls
Can specify greeks IV method of calculation in some options calls
Update intervals syntax so it can pull from more performant source

javascript-sdk-source-code-6.25.0.zip

6.24.1

Released 07/12/2023
javascript-sdk-source-code-6.24.1.zip

6.24.0

Released 06/14/2023

No release notes for this build

javascript-sdk-source-code-6.24.0.zip

6.23.1

Released 03/28/2023

Added next_page param to SDK that already exists for REST calls for a specific options endpoint.

javascript-sdk-source-code-6.23.1.zip

6.23.0

Released 03/17/2023

Added intervals endpoints and movers endpoints.

javascript-sdk-source-code-6.23.0.zip

6.22.3

Released 01/11/2023

Added options intervals and equitites delayed SIP endpoints
Added Intervals Movers endpoints

javascript-sdk-source-code-6.22.3.zip

6.22.2

Released 09/19/2022
javascript-sdk-source-code-6.22.2.zip

6.21.2

Released 09/17/2022
javascript-sdk-source-code-6.21.2.zip