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 = {
'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);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringA Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) 
startDateDateReturn prices on or after the date[optional]  
endDateDateReturn prices on or before the date[optional]  
frequencyStringReturn stock prices in the given frequency[optional] [default to daily]  
pageSizeNumberThe number of results to return[optional] [default to 100]  
nextPageStringGets the next page of data from a previous API call[optional]  


Return Type

object
ApiResponseSecurityStockPrices

Properties

NameTypeDescription
stockPrices[StockPriceSummary]The stock prices for the Security  
securitySecuritySummaryThe Security resolved from the given identifier  
nextPageStringThe token required to request the next page of the data. If null, no further results are available.  
object
StockPriceSummary

Properties

NameTypeDescription
dateDateThe calendar date that the stock price represents. For non-daily stock prices, this represents the last day in the period (end of the week, month, quarter, year, etc)  
intraperiodBooleanIf true, the stock price represents an unfinished period (be it day, week, quarter, month, or year), meaning that the close price is the latest price available, not the official close price for the period  
frequencyStringThe type of period that the stock price represents  
openNumberThe price at the beginning of the period  
highNumberThe highest price over the span of the period  
lowNumberThe lowest price over the span of the period  
closeNumberThe price at the end of the period  
volumeNumberThe number of shares exchanged during the period  
adjOpenNumberThe price at the beginning of the period, adjusted for splits and dividends  
adjHighNumberThe highest price over the span of the period, adjusted for splits and dividends  
adjLowNumberThe lowest price over the span of the period, adjusted for splits and dividends  
adjCloseNumberThe price at the end of the period, adjusted for splits and dividends  
adjVolumeNumberThe number of shares exchanged during the period, adjusted for splits and dividends  
factorNumberThe factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices.  
splitRatioNumberThe ratio of the stock split, if a stock split occurred.  
dividendNumberThe dividend amount, if a dividend was paid.  
changeNumberThe difference in price from the last price for this frequency  
percentChangeNumberThe percent difference in price from the last price for this frequency  
fiftyTwoWeekHighNumberThe 52 week high price (daily only)  
fiftyTwoWeekLowNumberThe 52 week low price (daily only)  
object
SecuritySummary

Properties

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