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 options = new intrinioSDK.OptionsApi();
var identifier = "AAPL__261218C00230000";
var opts = {
'source': null,
'stockPriceSource': null,
'model': null,
'showExtendedPrice': null
};
options.getOptionsPricesRealtime(identifier, opts).then(function(data) {
data = JSON.stringify(data, null, 2)
console.log(data);
}, function(error) {
console.error(error);
});
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
identifierStringThe Intrinio ID or code of the options contract to request prices for. 
sourceStringRealtime or 15-minute delayed contracts.[optional]  
stockPriceSourceStringSource for underlying price for calculating Greeks.[optional]  
modelStringModel for calculating Greek values. Default is black_scholes.[optional]  
showExtendedPriceBooleanWhether to include open close high low type fields.[optional]  


Return Type

object
ApiResponseOptionsPriceRealtime

Properties

NameTypeDescription
priceOptionPriceRealtime 
statsOptionStatsRealtime 
optionOptionRealtime 
extendedPriceOptionPriceRealtimeExtended 
object
OptionPriceRealtime

Properties

NameTypeDescription
lastNumberThe price of the last trade  
lastSizeNumberThe size of the last trade  
lastTimestampDateThe time of the last trade  
volumeNumberThe cumulative volume of this options contract that traded that day.  
askNumberThe price of the top ask order  
askSizeNumberThe size of the top ask order  
askTimestampDateThe timestamp of the top ask order  
bidNumberThe price of the top bid order  
bidSizeNumberThe size of the top bid order  
bidTimestampDateThe time of the top bid order  
openInterestNumberThe total number of this options contract that are still open.  
exerciseStyleStringThe exercise style of the option. ("A" = "American", "E" = "European")  
object
OptionStatsRealtime

Properties

NameTypeDescription
impliedVolatilityNumberThe implied volatility of the contract calculated using the Black-Scholes Model.  
deltaNumberDelta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
gammaNumberGamma represents the rate of change between an option's delta and the underlying asset's price.  
thetaNumberTheta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
vegaNumberVega represents the rate of change between an option's value and the underlying asset's implied volatility.  
underlyingPriceNumberThe most recent trade price of the underlying asset.  
object
OptionRealtime

Properties

NameTypeDescription
codeStringThe Intrinio Code for the Option.  
tickerStringThe ticker symbol of the Security for the Option.  
expirationDateThe date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
strikeNumberThe strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative's underlying asset. In a call option, the strike price is the price at which the option holder can purchase the underlying security. For a put option, the strike price is the price at which the option holder can sell the underlying security.  
typeStringThe type of Option (put or call).  
object
OptionPriceRealtimeExtended

Properties

NameTypeDescription
bidOpenNumberThe price of the bid at open  
bidHighNumberThe high bid so far today  
bidLowNumberThe low bid so far today  
askOpenNumberThe price of the ask at open  
askHighNumberThe high ask so far today  
askLowNumberThe low ask so far today  
tradeOpenNumberThe price of the trade at open  
tradeHighNumberThe high trade so far today  
tradeLowNumberThe low trade so far today  
askCloseNumberThe price of ask at close today  
bidCloseNumberThe price of bid at close today  
tradeCloseNumberThe price of the last trade of the day  
markNumberThe mark price  
View Documentation for Option Prices Realtime 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