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 zacks = new intrinioSDK.ZacksApi();
var opts = {
'startDate': null,
'endDate': null,
'salesActualGreater': null,
'salesActualLess': null,
'salesMeanEstimateGreater': null,
'salesMeanEstimateLess': null,
'salesAmountDiffGreater': null,
'salesAmountDiffLess': null,
'salesPercentDiffGreater': null,
'salesPercentDiffLess': null,
'salesCountEstimateGreater': null,
'salesCountEstimateLess': null,
'salesStdDevEstimateGreater': null,
'salesStdDevEstimateLess': null,
'pageSize': 100,
'nextPage': null
};
zacks.getZacksSalesSurprises(opts).then(function(data) {
data = JSON.stringify(data, null, 2)
console.log(data);
}, function(error) {
console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
startDateDateLimit sales surprises to those on or after this date[optional]  
endDateDateLimit sales surprises to those on or before this date[optional]  
salesActualGreaterNumberReturn only records with an actual sales higher than this value[optional]  
salesActualLessNumberReturn only records with an actual sales lower than this value[optional]  
salesMeanEstimateGreaterNumberReturn only records with a sales mean estimate greater than this value[optional]  
salesMeanEstimateLessNumberReturn only records with a sales mean estimate lower than this value[optional]  
salesAmountDiffGreaterNumberReturn only records with a sales amount difference greater than this value[optional]  
salesAmountDiffLessNumberReturn only records with a sales amount difference less than this value[optional]  
salesPercentDiffGreaterNumberReturn only records with a sales percent difference greater than this value[optional]  
salesPercentDiffLessNumberReturn only records with a sales percent difference less than this value[optional]  
salesCountEstimateGreaterNumberReturn only records with a sales count estimate greater than this value[optional]  
salesCountEstimateLessNumberReturn only records with a sales count estimate less than this value[optional]  
salesStdDevEstimateGreaterNumberReturn only records with a sales standard deviation greater than this value[optional]  
salesStdDevEstimateLessNumberReturn only records with a sales standard deviation less than this value[optional]  
pageSizeNumberThe number of results to return[optional] [default to 100]  
nextPageStringGets the next page of data from a previous API call[optional]  


Return Type

object
ApiResponseZacksSalesSurprises

Properties

NameTypeDescription
salesSurprises[ZacksSalesSurprise]Zacks Sales Surprise data for a Security in descending order by actual reported date  
nextPageStringThe token required to request the next page of the data. If null, no further results are available.  
object
ZacksSalesSurprise

Properties

NameTypeDescription
idStringThe Intrinio ID for the record  
fiscalYearNumberThe company's fiscal year for the reported period  
fiscalQuarterStringThe company's fiscal quarter for the reported period  
calendarYearNumberThe closest calendar year for the company's fiscal year  
calendarQuarterStringThe closest calendar quarter for the company's fiscal year  
actualReportedDateDateThe actual report date for the earnings release  
actualReportedTimeStringThe actual report time for the earnings release  
actualReportedCodeStringThe code cooresponding to the earnings release BTO = BEFORE THE OPENDTM = DURING THE MARKETAMC = AFTER MARKET CLOSE  
actualReportedDescStringThe description for the type of earnings release  
lastRevDateDateThe last revision date for the analyst estimates  
salesActualNumberThe actual Non-GAAP sales figure released by the company, interpreted by Zacks.  
salesActualZacksAdjNumberThe adjustments Zacks made to get to Non-GAAP sales to reconcile with GAAP sales.  
salesActualGaapNumberThe actual GAAP sales figured released by the company  
salesMeanEstimateNumberThe pre-earnings release mean sales estimate for the company sales_count_estimate; the pre-earnings release number of estimates by analysts  
salesAmountDiffNumberThe sales surprise amount difference  
salesPercentDiffNumberThe sales surprise percent difference  
salesStdDevEstimateNumberThe pre-earnings release standard deviation of sales estimates  
View Documentation for Zacks Sales Surprises 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