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

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

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

Name	Type	Description	Notes
identifier	String	The Intrinio ID or code of the options contract to request prices for.
source	String	Realtime or 15-minute delayed contracts.	[optional]
stockPriceSource	String	Source for underlying price for calculating Greeks.	[optional]
model	String	Model for calculating Greek values. Default is black_scholes.	[optional]
showExtendedPrice	Boolean	Whether to include open close high low type fields.	[optional]

Return Type

object

ApiResponseOptionsPriceRealtime

Properties

Name	Type	Description
price	OptionPriceRealtime
stats	OptionStatsRealtime
option	OptionRealtime
extendedPrice	OptionPriceRealtimeExtended

object

OptionPriceRealtime

Properties

Name	Type	Description
last	Number	The price of the last trade
lastSize	Number	The size of the last trade
lastTimestamp	Date	The time of the last trade
volume	Number	The cumulative volume of this options contract that traded that day.
ask	Number	The price of the top ask order
askSize	Number	The size of the top ask order
askTimestamp	Date	The timestamp of the top ask order
bid	Number	The price of the top bid order
bidSize	Number	The size of the top bid order
bidTimestamp	Date	The time of the top bid order
openInterest	Number	The total number of this options contract that are still open.
exerciseStyle	String	The exercise style of the option. ("A" = "American", "E" = "European")

object

OptionStatsRealtime

Properties

Name	Type	Description
impliedVolatility	Number	The implied volatility of the contract calculated using the Black-Scholes Model.
delta	Number	Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.
gamma	Number	Gamma represents the rate of change between an option's delta and the underlying asset's price.
theta	Number	Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.
vega	Number	Vega represents the rate of change between an option's value and the underlying asset's implied volatility.
underlyingPrice	Number	The most recent trade price of the underlying asset.

object

OptionRealtime

Properties

Name	Type	Description
code	String	The Intrinio Code for the Option.
ticker	String	The ticker symbol of the Security for the Option.
expiration	Date	The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.
strike	Number	The 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.
type	String	The type of Option (put or call).

object

OptionPriceRealtimeExtended

Properties

Name	Type	Description
bidOpen	Number	The price of the bid at open
bidHigh	Number	The high bid so far today
bidLow	Number	The low bid so far today
askOpen	Number	The price of the ask at open
askHigh	Number	The high ask so far today
askLow	Number	The low ask so far today
tradeOpen	Number	The price of the trade at open
tradeHigh	Number	The high trade so far today
tradeLow	Number	The low trade so far today
askClose	Number	The price of ask at close today
bidClose	Number	The price of bid at close today
tradeClose	Number	The price of the last trade of the day
mark	Number	The mark price

View Documentation for Option Prices Realtime Example

Release History

6.35.0

Released 02/26/2025

javascript-sdk-source-code-6.35.0.zip

6.34.0

Released 11/27/2024

javascript-sdk-source-code-6.34.0.zip

6.33.0

Released 11/21/2024

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

javascript-sdk-source-code-6.31.0.zip

6.30.0

Released 08/23/2024

javascript-sdk-source-code-6.30.0.zip

6.29.1

Released 08/10/2024

javascript-sdk-source-code-6.29.1.zip

6.29.0

Released 08/02/2024

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

javascript-sdk-source-code-6.28.0.zip

6.27.4

Released 06/25/2024

javascript-sdk-source-code-6.27.4.zip

6.27.3

Released 06/05/2024

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

javascript-sdk-source-code-6.27.0.zip

6.26.8

Released 02/20/2024

javascript-sdk-source-code-6.26.8.zip

6.26.7

Released 02/06/2024

javascript-sdk-source-code-6.26.7.zip

6.26.6

Released 02/01/2024

javascript-sdk-source-code-6.26.6.zip

6.26.5

Released 12/21/2023

javascript-sdk-source-code-6.26.5.zip

6.26.3

Released 12/05/2023

javascript-sdk-source-code-6.26.3.zip

6.26.2

Released 11/08/2023

javascript-sdk-source-code-6.26.2.zip

6.26.1

Released 10/03/2023

javascript-sdk-source-code-6.26.1.zip

6.26.0

Released 09/08/2023

javascript-sdk-source-code-6.26.0.zip

6.25.0

Released 08/01/2023

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

javascript-sdk-source-code-6.24.0.zip

6.23.1

Released 03/28/2023

javascript-sdk-source-code-6.23.1.zip

6.23.0

Released 03/17/2023

javascript-sdk-source-code-6.23.0.zip

6.22.3

Released 01/11/2023

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