# intrinioSDK.OptionsApi All URIs are relative to *https://api-v2.intrinio.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**getAllOptionsTickers**](OptionsApi.md#getAllOptionsTickers) | **GET** /options/tickers | Options Tickers [**getOptionAggregates**](OptionsApi.md#getOptionAggregates) | **GET** /options/aggregates | Total open interest and volume aggregated by ticker [**getOptionExpirationsRealtime**](OptionsApi.md#getOptionExpirationsRealtime) | **GET** /options/expirations/{symbol}/realtime | Options Expirations [**getOptionStrikesRealtime**](OptionsApi.md#getOptionStrikesRealtime) | **GET** /options/strikes/{symbol}/{strike}/realtime | Option Strikes Realtime [**getOptionTrades**](OptionsApi.md#getOptionTrades) | **GET** /options/trades | Option Trades [**getOptionTradesByContract**](OptionsApi.md#getOptionTradesByContract) | **GET** /options/{identifier}/trades | Option Trades By Contract [**getOptions**](OptionsApi.md#getOptions) | **GET** /options/{symbol} | Options [**getOptionsBySymbolRealtime**](OptionsApi.md#getOptionsBySymbolRealtime) | **GET** /options/{symbol}/realtime | Options by Symbol Realtime [**getOptionsChain**](OptionsApi.md#getOptionsChain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain [**getOptionsChainEod**](OptionsApi.md#getOptionsChainEod) | **GET** /options/chain/{symbol}/{expiration}/eod | Options Chain EOD [**getOptionsChainRealtime**](OptionsApi.md#getOptionsChainRealtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime [**getOptionsExpirations**](OptionsApi.md#getOptionsExpirations) | **GET** /options/expirations/{symbol} | Options Expirations [**getOptionsExpirationsEod**](OptionsApi.md#getOptionsExpirationsEod) | **GET** /options/expirations/{symbol}/eod | Options Expirations [**getOptionsGainers**](OptionsApi.md#getOptionsGainers) | **GET** /options/gainers | Options Top Gainers [**getOptionsGreeksByContract**](OptionsApi.md#getOptionsGreeksByContract) | **GET** /options/greeks/{contract}/realtime | Option Greeks & Derived Price by Contract [**getOptionsGreeksByTicker**](OptionsApi.md#getOptionsGreeksByTicker) | **GET** /options/greeks/by_ticker/{identifier}/realtime | Options Realtime Greeks & Derived Price by Ticker [**getOptionsImpliedMoveBySymbol**](OptionsApi.md#getOptionsImpliedMoveBySymbol) | **GET** /options/implied_move/{symbol}/{expiration_date} | Options Implied Move By Symbol [**getOptionsIntervalByContract**](OptionsApi.md#getOptionsIntervalByContract) | **GET** /options/interval/{identifier} | Options Intervals By Contract [**getOptionsIntervalMovers**](OptionsApi.md#getOptionsIntervalMovers) | **GET** /options/interval/movers | Options Intervals Movers [**getOptionsIntervalMoversChange**](OptionsApi.md#getOptionsIntervalMoversChange) | **GET** /options/interval/movers/change | Options Intervals Movers By Change [**getOptionsIntervalMoversVolume**](OptionsApi.md#getOptionsIntervalMoversVolume) | **GET** /options/interval/movers/volume | Options Intervals Movers By Volume [**getOptionsLosers**](OptionsApi.md#getOptionsLosers) | **GET** /options/losers | Options Top Losers [**getOptionsPrices**](OptionsApi.md#getOptionsPrices) | **GET** /options/prices/{identifier} | Option Prices [**getOptionsPricesBatchRealtime**](OptionsApi.md#getOptionsPricesBatchRealtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime [**getOptionsPricesEod**](OptionsApi.md#getOptionsPricesEod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD [**getOptionsPricesEodByTicker**](OptionsApi.md#getOptionsPricesEodByTicker) | **GET** /options/prices/by_ticker/{symbol}/eod | Option Prices End of Day By Ticker [**getOptionsPricesRealtime**](OptionsApi.md#getOptionsPricesRealtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime [**getOptionsPricesRealtimeByTicker**](OptionsApi.md#getOptionsPricesRealtimeByTicker) | **GET** /options/prices/by_ticker/{symbol}/realtime | Option Prices Realtime By Ticker [**getOptionsSnapshots**](OptionsApi.md#getOptionsSnapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot [**getOptionsStatsRealtime**](OptionsApi.md#getOptionsStatsRealtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime [**getUnusualActivity**](OptionsApi.md#getUnusualActivity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity [**getUnusualActivityIntraday**](OptionsApi.md#getUnusualActivityIntraday) | **GET** /options/unusual_activity/{symbol}/intraday | Options Unusual Activity Intraday [**getUnusualActivityUniversal**](OptionsApi.md#getUnusualActivityUniversal) | **GET** /options/unusual_activity | Options Unusual Activity Universal [**getUnusualActivityUniversalIntraday**](OptionsApi.md#getUnusualActivityUniversalIntraday) | **GET** /options/unusual_activity/intraday | Options Unusual Activity Universal Intraday [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getAllOptionsTickers) [//]: # (RETURN_TYPE:ApiResponseOptionsTickers) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsTickers.md) [//]: # (OPERATION:getAllOptionsTickers_v2) [//]: # (ENDPOINT:/options/tickers) [//]: # (DOCUMENT_LINK:OptionsApi.md#getAllOptionsTickers) ## **getAllOptionsTickers** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getAllOptionsTickers_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsTickers getAllOptionsTickers(opts) #### Options Tickers Returns all tickers that have existing options contracts. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'useUnderlyingSymbols': false }; options.getAllOptionsTickers(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **useUnderlyingSymbols** | Boolean| Use underlying symbol vs contract symbol | [optional] [default to false]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsTickers**](ApiResponseOptionsTickers.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionAggregates) [//]: # (RETURN_TYPE:ApiResponseOptionsAggregates) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsAggregates.md) [//]: # (OPERATION:getOptionAggregates_v2) [//]: # (ENDPOINT:/options/aggregates) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionAggregates) ## **getOptionAggregates** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionAggregates_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsAggregates getOptionAggregates(opts) #### Total open interest and volume aggregated by ticker Returns total open interest and volume by ticker [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'date': "2024-04-24", 'pageSize': 100, 'nextPage': null }; options.getOptionAggregates(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **date** | [**Object**](.md)| Return aggregated data for this date | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 100]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsAggregates**](ApiResponseOptionsAggregates.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionExpirationsRealtime) [//]: # (RETURN_TYPE:ApiResponseOptionsExpirations) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsExpirations.md) [//]: # (OPERATION:getOptionExpirationsRealtime_v2) [//]: # (ENDPOINT:/options/expirations/{symbol}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionExpirationsRealtime) ## **getOptionExpirationsRealtime** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionExpirationsRealtime_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsExpirations getOptionExpirationsRealtime(symbol, opts) #### Options Expirations Returns a list of all current and upcoming option contract expiration dates for a particular symbol. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var opts = { 'after': "2022-01-01", 'before': "2023-04-01", 'source': null, 'includeRelatedSymbols': false }; options.getOptionExpirationsRealtime(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **after** | String| Return option contract expiration dates after this date. | [optional]   **before** | String| Return option contract expiration dates before this date. | [optional]   **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionStrikesRealtime) [//]: # (RETURN_TYPE:ApiResponseOptionsChainRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChainRealtime.md) [//]: # (OPERATION:getOptionStrikesRealtime_v2) [//]: # (ENDPOINT:/options/strikes/{symbol}/{strike}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionStrikesRealtime) ## **getOptionStrikesRealtime** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionStrikesRealtime_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsChainRealtime getOptionStrikesRealtime(symbol, strike, opts) #### Option Strikes Realtime Returns a list of the latest top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all call/put contracts that match the strike and symbol specified. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var strike = 95; var opts = { 'source': null, 'stockPriceSource': null, 'model': null, 'showExtendedPrice': null, 'includeRelatedSymbols': false }; options.getOptionStrikesRealtime(symbol, strike, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **strike** | Number| The strike price of the option contract. This will return options contracts with strike price equal to this price. |   **source** | String| Realtime or delayed. | [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]   **includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsChainRealtime**](ApiResponseOptionsChainRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionTrades) [//]: # (RETURN_TYPE:OptionTradesResult) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:OptionTradesResult.md) [//]: # (OPERATION:getOptionTrades_v2) [//]: # (ENDPOINT:/options/trades) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionTrades) ## **getOptionTrades** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionTrades_v2) [//]: # (START_OVERVIEW) > OptionTradesResult getOptionTrades(opts) #### Option Trades Returns all trades between start time and end time, up to seven days ago for the specified source. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'source': null, 'startDate': null, 'startTime': null, 'endDate': null, 'endTime': null, 'timezone': "UTC", 'pageSize': 100, 'minSize': 100, 'security': "AAPL", 'nextPage': null }; options.getOptionTrades(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **source** | String| The specific source of the data being requested. | [optional]   **startDate** | Date| The start date for the data being requested. | [optional]   **startTime** | String| The start time for the data being requested. | [optional]   **endDate** | Date| The end date for the data being requested. | [optional]   **endTime** | String| The end time for the data being requested. | [optional]   **timezone** | String| The timezone the start and end date/times use. | [optional] [default to UTC]   **pageSize** | Number| The maximum number of results to return per page. | [optional] [default to 100]   **minSize** | Number| Trades must be larger or equal to this size. | [optional]   **security** | String| The ticker symbol for which trades are being requested. | [optional]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**OptionTradesResult**](OptionTradesResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionTradesByContract) [//]: # (RETURN_TYPE:OptionTradesResult) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:OptionTradesResult.md) [//]: # (OPERATION:getOptionTradesByContract_v2) [//]: # (ENDPOINT:/options/{identifier}/trades) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionTradesByContract) ## **getOptionTradesByContract** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionTradesByContract_v2) [//]: # (START_OVERVIEW) > OptionTradesResult getOptionTradesByContract(identifier, opts) #### Option Trades By Contract Returns all trades for a contract between start time and end time, up to seven days ago for the specified source. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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, 'startDate': null, 'startTime': null, 'endDate': null, 'endTime': null, 'timezone': "UTC", 'pageSize': 100, 'minSize': 100, 'nextPage': null }; options.getOptionTradesByContract(identifier, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | String| The option contract for which trades are being requested. |   **source** | String| The specific source of the data being requested. | [optional]   **startDate** | Date| The start date for the data being requested. | [optional]   **startTime** | String| The start time for the data being requested. | [optional]   **endDate** | Date| The end date for the data being requested. | [optional]   **endTime** | String| The end time for the data being requested. | [optional]   **timezone** | String| The timezone the start and end date/times use. | [optional] [default to UTC]   **pageSize** | Number| The maximum number of results to return per page. | [optional] [default to 100]   **minSize** | Number| Trades must be larger or equal to this size. | [optional]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**OptionTradesResult**](OptionTradesResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptions) [//]: # (RETURN_TYPE:ApiResponseOptions) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptions.md) [//]: # (OPERATION:getOptions_v2) [//]: # (ENDPOINT:/options/{symbol}) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptions) ## **getOptions** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptions_v2) [//]: # (START_OVERVIEW) > ApiResponseOptions getOptions(symbol, opts) #### Options Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe. Available via a 3rd party, contact sales for a trial. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "AAPL"; var opts = { 'type': "put", 'strike': 170, 'strikeGreaterThan': 150, 'strikeLessThan': 190, 'expiration': "2019-03-01", 'expirationAfter': "2019-01-01", 'expirationBefore': "2019-12-31", 'pageSize': 100, 'nextPage': null }; options.getOptions(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **type** | String| The option contract type. | [optional]   **strike** | Number| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   **strikeGreaterThan** | Number| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   **strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   **expiration** | String| The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional]   **expirationAfter** | String| The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional]   **expirationBefore** | String| The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 100]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptions**](ApiResponseOptions.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsBySymbolRealtime) [//]: # (RETURN_TYPE:ApiResponseOptionsRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsRealtime.md) [//]: # (OPERATION:getOptionsBySymbolRealtime_v2) [//]: # (ENDPOINT:/options/{symbol}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsBySymbolRealtime) ## **getOptionsBySymbolRealtime** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsBySymbolRealtime_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsRealtime getOptionsBySymbolRealtime(symbol, opts) #### Options by Symbol Realtime Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "AAPL"; var opts = { 'type': "put", 'strike': 170, 'strikeGreaterThan': 150, 'strikeLessThan': 190, 'expiration': "2022-04-16", 'expirationAfter': "2022-01-01", 'expirationBefore': "2023-12-31", 'source': null, 'includeRelatedSymbols': false }; options.getOptionsBySymbolRealtime(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **type** | String| The option contract type. | [optional]   **strike** | Number| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   **strikeGreaterThan** | Number| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   **strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   **expiration** | String| The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional]   **expirationAfter** | String| The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional]   **expirationBefore** | String| The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional]   **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsRealtime**](ApiResponseOptionsRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsChain) [//]: # (RETURN_TYPE:ApiResponseOptionsChain) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChain.md) [//]: # (OPERATION:getOptionsChain_v2) [//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsChain) ## **getOptionsChain** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsChain_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsChain getOptionsChain(symbol, expiration, opts) #### Options Chain Returns a list of the historical end-of-day top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain. Available via a 3rd party, contact sales for a trial. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var expiration = "2019-04-05"; var opts = { 'date': null, 'type': null, 'strike': null, 'strikeGreaterThan': null, 'strikeLessThan': null, 'moneyness': null, 'pageSize': 100 }; options.getOptionsChain(symbol, expiration, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **expiration** | String| The expiration date of the options contract |   **date** | Date| The date of the option price. Returns option prices on this date. | [optional]   **type** | String| The option contract type. | [optional]   **strike** | Number| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   **strikeGreaterThan** | Number| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   **strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   **moneyness** | String| The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money. | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 100]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsChain**](ApiResponseOptionsChain.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsChainEod) [//]: # (RETURN_TYPE:ApiResponseOptionsChainEod) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChainEod.md) [//]: # (OPERATION:getOptionsChainEod_v2) [//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}/eod) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsChainEod) ## **getOptionsChainEod** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsChainEod_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsChainEod getOptionsChainEod(symbol, expiration, opts) #### Options Chain EOD Returns all EOD options contracts and their prices for the given symbol and expiration date. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "AAPL"; var expiration = "2023-01-20"; var opts = { 'type': null, 'strike': null, 'strikeGreaterThan': null, 'strikeLessThan': null, 'date': null, 'includeRelatedSymbols': false, 'recalculateStats': false, 'model': "black_scholes", 'ivMode': "ivMode_example" }; options.getOptionsChainEod(symbol, expiration, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **expiration** | String| The expiration date of the options contract |   **type** | String| The option contract type. | [optional]   **strike** | Number| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   **strikeGreaterThan** | Number| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   **strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   **date** | Date| The date to retrieve prices for | [optional]   **includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]   **recalculateStats** | Boolean| Recalculate implied volatility and greeks on the fly using end-of-day underlying prices. | [optional] [default to false]   **model** | String| The options pricing model to use when recalculating stats. | [optional] [default to black_scholes]   **ivMode** | String| The implied volatility calculation mode to use when recalculating stats. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsChainEod**](ApiResponseOptionsChainEod.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsChainRealtime) [//]: # (RETURN_TYPE:ApiResponseOptionsChainRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChainRealtime.md) [//]: # (OPERATION:getOptionsChainRealtime_v2) [//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsChainRealtime) ## **getOptionsChainRealtime** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsChainRealtime_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsChainRealtime getOptionsChainRealtime(symbol, expiration, opts) #### Options Chain Realtime Returns a list of the latest National Best Bid & Offer (NBBO) top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var expiration = "2023-01-20"; var opts = { 'source': null, 'type': null, 'strike': null, 'strikeGreaterThan': null, 'strikeLessThan': null, 'volumeGreaterThan': null, 'volumeLessThan': null, 'openInterestGreaterThan': null, 'openInterestLessThan': null, 'moneyness': null, 'stockPriceSource': null, 'model': null, 'showExtendedPrice': null, 'includeRelatedSymbols': false, 'showStats': null }; options.getOptionsChainRealtime(symbol, expiration, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **expiration** | String| The expiration date of the options contract |   **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **type** | String| The option contract type. | [optional]   **strike** | Number| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   **strikeGreaterThan** | Number| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   **strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   **volumeGreaterThan** | Number| The volume of the option contract. This will return options contracts with volumes greater than this amount. | [optional]   **volumeLessThan** | Number| The volume of the option contract. This will return options contracts with volumes less than this amout. | [optional]   **openInterestGreaterThan** | Number| The open interest of the option contract. This will return options contracts with open interest greater than this amount. | [optional]   **openInterestLessThan** | Number| The open interest of the option contract. This will return options contracts with open interest less than this amount. | [optional]   **moneyness** | String| The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money. Requires subscription to realtime stock price data. | [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]   **includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]   **showStats** | Boolean| Whether to include Greek calculations or not. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsChainRealtime**](ApiResponseOptionsChainRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsExpirations) [//]: # (RETURN_TYPE:ApiResponseOptionsExpirations) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsExpirations.md) [//]: # (OPERATION:getOptionsExpirations_v2) [//]: # (ENDPOINT:/options/expirations/{symbol}) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsExpirations) ## **getOptionsExpirations** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsExpirations_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsExpirations getOptionsExpirations(symbol, opts) #### Options Expirations Returns a list of all current and upcoming option contract expiration dates for a particular symbol. Available via a 3rd party, contact sales for a trial. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var opts = { 'after': "2019-01-01", 'before': "2019-12-31" }; options.getOptionsExpirations(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **after** | String| Return option contract expiration dates after this date. | [optional]   **before** | String| Return option contract expiration dates before this date. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsExpirationsEod) [//]: # (RETURN_TYPE:ApiResponseOptionsExpirations) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsExpirations.md) [//]: # (OPERATION:getOptionsExpirationsEod_v2) [//]: # (ENDPOINT:/options/expirations/{symbol}/eod) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsExpirationsEod) ## **getOptionsExpirationsEod** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsExpirationsEod_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsExpirations getOptionsExpirationsEod(symbol, opts) #### Options Expirations Returns a list of all current and upcoming option contract expiration dates for a particular symbol. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var opts = { 'after': "2019-01-01", 'before': "2019-12-31", 'includeRelatedSymbols': false }; options.getOptionsExpirationsEod(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **after** | String| Return option contract expiration dates after this date. | [optional]   **before** | String| Return option contract expiration dates before this date. | [optional]   **includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsGainers) [//]: # (RETURN_TYPE:ApiResponseOptionMovers) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionMovers.md) [//]: # (OPERATION:getOptionsGainers_v2) [//]: # (ENDPOINT:/options/gainers) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsGainers) ## **getOptionsGainers** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsGainers_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionMovers getOptionsGainers(mode, opts) #### Options Top Gainers Returns a list of top gainers since last close. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 mode = null; var opts = { 'nextPage': null }; options.getOptionsGainers(mode, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **mode** | String| Which metric to sort by - change, percent change, or volume. |   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionMovers**](ApiResponseOptionMovers.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsGreeksByContract) [//]: # (RETURN_TYPE:ApiResponseOptionsGreekContractRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsGreekContractRealtime.md) [//]: # (OPERATION:getOptionsGreeksByContract_v2) [//]: # (ENDPOINT:/options/greeks/{contract}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsGreeksByContract) ## **getOptionsGreeksByContract** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsGreeksByContract_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsGreekContractRealtime getOptionsGreeksByContract(contract, opts) #### Option Greeks & Derived Price by Contract Retrieves realtime options greeks data for a specific options contract [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 contract = "contract_example"; var opts = { 'source': "source_example", 'model': "black_scholes", 'ivMode': "ivMode_example", 'stockPriceSource': "stockPriceSource_example" }; options.getOptionsGreeksByContract(contract, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contract** | String| The options contract identifier |   **source** | String| The data source to use for options data | [optional]   **model** | String| The options pricing model to use for greeks calculations | [optional] [default to black_scholes]   **ivMode** | String| The implied volatility calculation mode | [optional]   **stockPriceSource** | String| The data source to use for underlying stock prices | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsGreekContractRealtime**](ApiResponseOptionsGreekContractRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsGreeksByTicker) [//]: # (RETURN_TYPE:ApiResponseOptionsGreeksByTickerRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsGreeksByTickerRealtime.md) [//]: # (OPERATION:getOptionsGreeksByTicker_v2) [//]: # (ENDPOINT:/options/greeks/by_ticker/{identifier}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsGreeksByTicker) ## **getOptionsGreeksByTicker** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsGreeksByTicker_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsGreeksByTickerRealtime getOptionsGreeksByTicker(identifier, opts) #### Options Realtime Greeks & Derived Price by Ticker Retrieves realtime options greeks data for all contracts of a given ticker symbol [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 = "identifier_example"; var opts = { 'source': "source_example", 'model': "black_scholes", 'ivMode': "ivMode_example", 'stockPriceSource': "stockPriceSource_example", 'expirationStartDate': new Date("2013-10-20"), 'expirationEndDate': new Date("2013-10-20"), 'strike': 3.4, 'strikeGreaterThan': 3.4, 'strikeLessThan': 3.4, 'pageSize': 250, 'nextPage': null }; options.getOptionsGreeksByTicker(identifier, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | String| The ticker symbol to get options greeks for |   **source** | String| The data source to use for options data | [optional]   **model** | String| The options pricing model to use for greeks calculations | [optional] [default to black_scholes]   **ivMode** | String| The implied volatility calculation mode | [optional]   **stockPriceSource** | String| The data source to use for underlying stock prices | [optional]   **expirationStartDate** | Date| Filter options by expiration date (start) | [optional]   **expirationEndDate** | Date| Filter options by expiration date (end) | [optional]   **strike** | Number| Filter options by strike price | [optional]   **strikeGreaterThan** | Number| Filter options by minimum strike price | [optional]   **strikeLessThan** | Number| Filter options by maximum strike price | [optional]   **pageSize** | Number| Number of results to return per page | [optional] [default to 250]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsGreeksByTickerRealtime**](ApiResponseOptionsGreeksByTickerRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsImpliedMoveBySymbol) [//]: # (RETURN_TYPE:ApiResponseOptionsImpliedMove) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsImpliedMove.md) [//]: # (OPERATION:getOptionsImpliedMoveBySymbol_v2) [//]: # (ENDPOINT:/options/implied_move/{symbol}/{expiration_date}) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsImpliedMoveBySymbol) ## **getOptionsImpliedMoveBySymbol** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsImpliedMoveBySymbol_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsImpliedMove getOptionsImpliedMoveBySymbol(symbol, expirationDate, opts) #### Options Implied Move By Symbol Returns the implied move data points for a ticker symbol. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "TSLA"; var expirationDate = new Date("2025-05-30"); var opts = { 'percentage': 0.85, 'source': null }; options.getOptionsImpliedMoveBySymbol(symbol, expirationDate, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The ticker symbol for the contracts. |   **expirationDate** | Date| The expiration date for the contracts to consider. |   **percentage** | [**Object**](.md)| Percentage to multiply the straddle by. Defaults to 0.85. | [optional]   **source** | String| Realtime or 15-minute delayed contracts. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsImpliedMove**](ApiResponseOptionsImpliedMove.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsIntervalByContract) [//]: # (RETURN_TYPE:OptionIntervalsResult) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:OptionIntervalsResult.md) [//]: # (OPERATION:getOptionsIntervalByContract_v2) [//]: # (ENDPOINT:/options/interval/{identifier}) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsIntervalByContract) ## **getOptionsIntervalByContract** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsIntervalByContract_v2) [//]: # (START_OVERVIEW) > OptionIntervalsResult getOptionsIntervalByContract(identifier, intervalSize, opts) #### Options Intervals By Contract Returns a list of interval data points for a contract. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 = "SPY___230103P00380000"; var intervalSize = "5m"; var opts = { 'source': null, 'pageSize': 100, 'endTime': null }; options.getOptionsIntervalByContract(identifier, intervalSize, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | String| The Intrinio ID or code of the options contract to request intervals for. |   **intervalSize** | String| The time length of the interval. |   **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 100]   **endTime** | Date| The inclusive UTC date and time the intervals end at. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**OptionIntervalsResult**](OptionIntervalsResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsIntervalMovers) [//]: # (RETURN_TYPE:OptionIntervalsMoversResult) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:OptionIntervalsMoversResult.md) [//]: # (OPERATION:getOptionsIntervalMovers_v2) [//]: # (ENDPOINT:/options/interval/movers) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsIntervalMovers) ## **getOptionsIntervalMovers** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsIntervalMovers_v2) [//]: # (START_OVERVIEW) > OptionIntervalsMoversResult getOptionsIntervalMovers(opts) #### Options Intervals Movers Returns a list of intervals for the biggest movers over the last hour interval. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'source': null, 'openTime': null }; options.getOptionsIntervalMovers(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **openTime** | Date| The inclusive UTC date and time the interval opens at. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**OptionIntervalsMoversResult**](OptionIntervalsMoversResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsIntervalMoversChange) [//]: # (RETURN_TYPE:OptionIntervalsMoversResult) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:OptionIntervalsMoversResult.md) [//]: # (OPERATION:getOptionsIntervalMoversChange_v2) [//]: # (ENDPOINT:/options/interval/movers/change) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsIntervalMoversChange) ## **getOptionsIntervalMoversChange** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsIntervalMoversChange_v2) [//]: # (START_OVERVIEW) > OptionIntervalsMoversResult getOptionsIntervalMoversChange(opts) #### Options Intervals Movers By Change Returns a list of intervals for the biggest movers by change over the last hour interval. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'source': null, 'openTime': null }; options.getOptionsIntervalMoversChange(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **openTime** | Date| The inclusive UTC date and time the interval opens at. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**OptionIntervalsMoversResult**](OptionIntervalsMoversResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsIntervalMoversVolume) [//]: # (RETURN_TYPE:OptionIntervalsMoversResult) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:OptionIntervalsMoversResult.md) [//]: # (OPERATION:getOptionsIntervalMoversVolume_v2) [//]: # (ENDPOINT:/options/interval/movers/volume) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsIntervalMoversVolume) ## **getOptionsIntervalMoversVolume** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsIntervalMoversVolume_v2) [//]: # (START_OVERVIEW) > OptionIntervalsMoversResult getOptionsIntervalMoversVolume(opts) #### Options Intervals Movers By Volume Returns a list of intervals for the biggest movers by volume over the last hour interval. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'source': null, 'openTime': null }; options.getOptionsIntervalMoversVolume(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **openTime** | Date| The inclusive UTC date and time the interval opens at. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**OptionIntervalsMoversResult**](OptionIntervalsMoversResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsLosers) [//]: # (RETURN_TYPE:ApiResponseOptionMovers) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionMovers.md) [//]: # (OPERATION:getOptionsLosers_v2) [//]: # (ENDPOINT:/options/losers) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsLosers) ## **getOptionsLosers** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsLosers_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionMovers getOptionsLosers(mode, opts) #### Options Top Losers Returns a list of top losers since last close. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 mode = null; var opts = { 'nextPage': null }; options.getOptionsLosers(mode, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **mode** | String| Which metric to sort by - change, percent change, or volume. |   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionMovers**](ApiResponseOptionMovers.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsPrices) [//]: # (RETURN_TYPE:ApiResponseOptionPrices) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionPrices.md) [//]: # (OPERATION:getOptionsPrices_v2) [//]: # (ENDPOINT:/options/prices/{identifier}) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsPrices) ## **getOptionsPrices** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsPrices_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionPrices getOptionsPrices(identifier, opts) #### Option Prices Returns all price data from inception to expiration for a particular contract. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 = "MSFT190405C00118000"; var opts = { 'startDate': "2019-01-01", 'endDate': "2019-12-31", 'pageSize': 100, 'nextPage': null }; options.getOptionsPrices(identifier, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | String| The Intrinio ID or code of the options contract to request prices for. |   **startDate** | String| Return option contract prices on or after this date. | [optional]   **endDate** | String| Return option contract prices on or before this date. | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 100]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionPrices**](ApiResponseOptionPrices.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsPricesBatchRealtime) [//]: # (RETURN_TYPE:ApiResponseOptionsPricesBatchRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesBatchRealtime.md) [//]: # (OPERATION:getOptionsPricesBatchRealtime_v2) [//]: # (ENDPOINT:/options/prices/realtime/batch) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsPricesBatchRealtime) ## **getOptionsPricesBatchRealtime** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsPricesBatchRealtime_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsPricesBatchRealtime getOptionsPricesBatchRealtime(body, opts) #### Option Prices Batch Realtime Returns a list of latest price data for up to 250 option contracts per request. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript var intrinioSDK = require('intrinio-sdk'); intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY"; intrinioSDK.ApiClient.instance.enableRetries = true; var options = new intrinioSDK.OptionsApi(); body = { "contracts": [ "A220121P00055000", "A220121P00057500", "A220121P00060000" ] } var opts = { 'source': null, 'showStats': null, 'stockPriceSource': null, 'model': null, 'showExtendedPrice': null }; options.getOptionsPricesBatchRealtime(body, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OptionContractsList**](OptionContractsList.md)| The contract symbols for which to return options prices for. |   **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **showStats** | Boolean| Whether to include Greek calculations or not. | [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]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsPricesBatchRealtime**](ApiResponseOptionsPricesBatchRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsPricesEod) [//]: # (RETURN_TYPE:ApiResponseOptionsPricesEod) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesEod.md) [//]: # (OPERATION:getOptionsPricesEod_v2) [//]: # (ENDPOINT:/options/prices/{identifier}/eod) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsPricesEod) ## **getOptionsPricesEod** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsPricesEod_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsPricesEod getOptionsPricesEod(identifier, opts) #### Option Prices EOD Returns all option prices for a given option contract identifier. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 = "AAPL230616P00190000"; var opts = { 'nextPage': null, 'startDate': null, 'endDate': null, 'recalculateStats': false, 'model': "black_scholes", 'ivMode': "ivMode_example" }; options.getOptionsPricesEod(identifier, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | String| The Intrinio ID or code of the options contract to request prices for. |   **nextPage** | String| Gets the next page of data from a previous API call | [optional]   **startDate** | Date| The start date to retrieve prices for | [optional]   **endDate** | Date| The end date to retrieve prices for | [optional]   **recalculateStats** | Boolean| Recalculate implied volatility and greeks on the fly using end-of-day underlying prices. | [optional] [default to false]   **model** | String| The options pricing model to use when recalculating stats. | [optional] [default to black_scholes]   **ivMode** | String| The implied volatility calculation mode to use when recalculating stats. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsPricesEod**](ApiResponseOptionsPricesEod.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsPricesEodByTicker) [//]: # (RETURN_TYPE:ApiResponseOptionsPricesByTickerEod) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesByTickerEod.md) [//]: # (OPERATION:getOptionsPricesEodByTicker_v2) [//]: # (ENDPOINT:/options/prices/by_ticker/{symbol}/eod) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsPricesEodByTicker) ## **getOptionsPricesEodByTicker** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsPricesEodByTicker_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsPricesByTickerEod getOptionsPricesEodByTicker(symbol, opts) #### Option Prices End of Day By Ticker Returns a list of end of day pricing information for all option contracts currently associated with the ticker. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var opts = { 'pageSize': 250, 'date': "2024-01-01", 'type': null, 'strike': null, 'strikeGreaterThan': null, 'strikeLessThan': null, 'includeRelatedSymbols': false, 'recalculateStats': false, 'model': "black_scholes", 'ivMode': "ivMode_example", 'nextPage': null }; options.getOptionsPricesEodByTicker(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The equities ticker symbol, corresponding to the underlying security. |   **pageSize** | Number| The number of results to return | [optional] [default to 250]   **date** | [**Object**](.md)| The date to get pricing data for. Defaults to today in Eastern time zone. | [optional]   **type** | String| The option contract type. | [optional]   **strike** | Number| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]   **strikeGreaterThan** | Number| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]   **strikeLessThan** | Number| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]   **includeRelatedSymbols** | Boolean| Include related symbols that end in a 1 or 2 because of a corporate action. | [optional]   **recalculateStats** | Boolean| Recalculate implied volatility and greeks on the fly using end-of-day underlying prices. | [optional] [default to false]   **model** | String| The options pricing model to use when recalculating stats. | [optional] [default to black_scholes]   **ivMode** | String| The implied volatility calculation mode to use when recalculating stats. | [optional]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsPricesByTickerEod**](ApiResponseOptionsPricesByTickerEod.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsPricesRealtime) [//]: # (RETURN_TYPE:ApiResponseOptionsPriceRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPriceRealtime.md) [//]: # (OPERATION:getOptionsPricesRealtime_v2) [//]: # (ENDPOINT:/options/prices/{identifier}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsPricesRealtime) ## **getOptionsPricesRealtime** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsPricesRealtime_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsPriceRealtime getOptionsPricesRealtime(identifier, opts) #### Option Prices Realtime Returns all option prices for a given option contract identifier. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_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]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsPriceRealtime**](ApiResponseOptionsPriceRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsPricesRealtimeByTicker) [//]: # (RETURN_TYPE:ApiResponseOptionsPricesByTickerRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesByTickerRealtime.md) [//]: # (OPERATION:getOptionsPricesRealtimeByTicker_v2) [//]: # (ENDPOINT:/options/prices/by_ticker/{symbol}/realtime) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsPricesRealtimeByTicker) ## **getOptionsPricesRealtimeByTicker** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsPricesRealtimeByTicker_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsPricesByTickerRealtime getOptionsPricesRealtimeByTicker(symbol, opts) #### Option Prices Realtime By Ticker Returns a list of the latest National Best Bid & Offer (NBBO) top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the ticker. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "MSFT"; var opts = { 'source': null, 'ivMode': null, 'nextPage': null, 'pageSize': 250, 'stockPriceSource': null, 'model': null, 'showExtendedPrice': null, 'expirationStartDate': "2024-01-01", 'expirationEndDate': "2024-02-02", 'strike': 100.0, 'showStats': null, 'nextPage2': null }; options.getOptionsPricesRealtimeByTicker(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The equities ticker symbol, corresponding to the underlying security. |   **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **ivMode** | String| Change the mode for the implied volatility calculation to out of the money. | [optional]   **nextPage** | String| Gets the next page of data from a previous API call | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 250]   **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]   **expirationStartDate** | [**Object**](.md)| Filter out contracts that expire before this date. | [optional]   **expirationEndDate** | [**Object**](.md)| Filter out contracts that expire after this date. | [optional]   **strike** | Number| Filter out contracts that have this strike price. | [optional]   **showStats** | Boolean| Whether to include Greek calculations or not. | [optional]   **nextPage2** | String| Gets the next page of data from a previous API call | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsPricesByTickerRealtime**](ApiResponseOptionsPricesByTickerRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsSnapshots) [//]: # (RETURN_TYPE:OptionSnapshotsResult) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:OptionSnapshotsResult.md) [//]: # (OPERATION:getOptionsSnapshots_v2) [//]: # (ENDPOINT:/options/snapshots) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsSnapshots) ## **getOptionsSnapshots** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsSnapshots_v2) [//]: # (START_OVERVIEW) > OptionSnapshotsResult getOptionsSnapshots(opts) #### Option Prices Realtime Snapshot Returns all options snapshots for the queried interval with links to download. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'source': null, 'atDatetime': null, 'withGreeks': null, 'stockPriceSource': null, 'withUnderlyingPrice': null }; options.getOptionsSnapshots(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **source** | String| Realtime or 15-minute delayed contracts. | [optional]   **atDatetime** | Date| The UTC date and time (with url-encoded spaces) the snapshot will cover. | [optional]   **withGreeks** | Boolean| Whether to include Greek calculations fields when available. | [optional]   **stockPriceSource** | String| Source for underlying price for calculating Greeks. | [optional]   **withUnderlyingPrice** | Boolean| Whether to include the underlying price of the security in the file. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**OptionSnapshotsResult**](OptionSnapshotsResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getOptionsStatsRealtime) [//]: # (RETURN_TYPE:ApiResponseOptionsStatsRealtime) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsStatsRealtime.md) [//]: # (OPERATION:getOptionsStatsRealtime_v2) [//]: # (ENDPOINT:/options/prices/{identifier}/realtime/stats) [//]: # (DOCUMENT_LINK:OptionsApi.md#getOptionsStatsRealtime) ## **getOptionsStatsRealtime** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getOptionsStatsRealtime_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsStatsRealtime getOptionsStatsRealtime(identifier, opts) #### Option Stats Realtime Returns all option stats (greeks and implied volatility) as well as the underlying factors used to calculate them, for a particular option contract. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 = "AAPL230120C00090000"; var opts = { 'source': null, 'showExtendedPrice': null }; options.getOptionsStatsRealtime(identifier, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_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]   **showExtendedPrice** | Boolean| Whether to include open close high low type fields. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsStatsRealtime**](ApiResponseOptionsStatsRealtime.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getUnusualActivity) [//]: # (RETURN_TYPE:ApiResponseOptionsUnusualActivity) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md) [//]: # (OPERATION:getUnusualActivity_v2) [//]: # (ENDPOINT:/options/unusual_activity/{symbol}) [//]: # (DOCUMENT_LINK:OptionsApi.md#getUnusualActivity) ## **getUnusualActivity** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getUnusualActivity_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsUnusualActivity getUnusualActivity(symbol, opts) #### Options Unusual Activity Returns unusual options activity for a particular company across all option chains. Unusual options activity includes large trades, sweeps, and block trades. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "AAPL"; var opts = { 'source': null }; options.getUnusualActivity(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **source** | String| Realtime or 15-minute delayed contracts. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getUnusualActivityIntraday) [//]: # (RETURN_TYPE:ApiResponseOptionsUnusualActivity) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md) [//]: # (OPERATION:getUnusualActivityIntraday_v2) [//]: # (ENDPOINT:/options/unusual_activity/{symbol}/intraday) [//]: # (DOCUMENT_LINK:OptionsApi.md#getUnusualActivityIntraday) ## **getUnusualActivityIntraday** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getUnusualActivityIntraday_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsUnusualActivity getUnusualActivityIntraday(symbol, opts) #### Options Unusual Activity Intraday Returns unusual trades for a given identifier within the query parameters. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 symbol = "AAPL"; var opts = { 'nextPage': null, 'pageSize': 1000, 'activityType': null, 'sentiment': null, 'startDate': new Date("2022-02-01"), 'endDate': new Date("2022-02-03"), 'minimumTotalValue': 100000.0, 'maximumTotalValue': 200000.0 }; options.getUnusualActivityIntraday(symbol, opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **symbol** | String| The option symbol, corresponding to the underlying security. |   **nextPage** | String| Gets the next page of data from a previous API call | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 1000]   **activityType** | String| The unusual activity type to query for. | [optional]   **sentiment** | String| The sentiment type to query for. | [optional]   **startDate** | Date| Return unusual activity on or after this date. | [optional]   **endDate** | Date| Return unusual activity before this date. | [optional]   **minimumTotalValue** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]   **maximumTotalValue** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getUnusualActivityUniversal) [//]: # (RETURN_TYPE:ApiResponseOptionsUnusualActivity) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md) [//]: # (OPERATION:getUnusualActivityUniversal_v2) [//]: # (ENDPOINT:/options/unusual_activity) [//]: # (DOCUMENT_LINK:OptionsApi.md#getUnusualActivityUniversal) ## **getUnusualActivityUniversal** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getUnusualActivityUniversal_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsUnusualActivity getUnusualActivityUniversal(opts) #### Options Unusual Activity Universal Returns the latest unusual options activity across all US companies with across all option chains. Unusual options activity includes large trades, sweeps, and block trades. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'source': null }; options.getUnusualActivityUniversal(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **source** | String| Realtime or 15-minute delayed contracts. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION) [//]: # (CLASS:OptionsApi) [//]: # (METHOD:getUnusualActivityUniversalIntraday) [//]: # (RETURN_TYPE:ApiResponseOptionsUnusualActivity) [//]: # (RETURN_TYPE_KIND:object) [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md) [//]: # (OPERATION:getUnusualActivityUniversalIntraday_v2) [//]: # (ENDPOINT:/options/unusual_activity/intraday) [//]: # (DOCUMENT_LINK:OptionsApi.md#getUnusualActivityUniversalIntraday) ## **getUnusualActivityUniversalIntraday** [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getUnusualActivityUniversalIntraday_v2) [//]: # (START_OVERVIEW) > ApiResponseOptionsUnusualActivity getUnusualActivityUniversalIntraday(opts) #### Options Unusual Activity Universal Intraday Returns unusual trades for all underlying security symbols within the query parameters. [//]: # (END_OVERVIEW) ### Example [//]: # (START_CODE_EXAMPLE) ```javascript 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 opts = { 'nextPage': null, 'pageSize': 1000, 'activityType': null, 'sentiment': null, 'startDate': new Date("2022-02-01"), 'endDate': new Date("2022-02-03"), 'minimumTotalValue': 100000.0, 'maximumTotalValue': 200000.0 }; options.getUnusualActivityUniversalIntraday(opts).then(function(data) { data = JSON.stringify(data, null, 2) console.log(data); }, function(error) { console.error(error); }); ``` [//]: # (END_CODE_EXAMPLE) ### Parameters [//]: # (START_PARAMETERS) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **nextPage** | String| Gets the next page of data from a previous API call | [optional]   **pageSize** | Number| The number of results to return | [optional] [default to 1000]   **activityType** | String| The unusual activity type to query for. | [optional]   **sentiment** | String| The sentiment type to query for. | [optional]   **startDate** | Date| Return unusual activity on or after this date. | [optional]   **endDate** | Date| Return unusual activity before this date. | [optional]   **minimumTotalValue** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]   **maximumTotalValue** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]  
[//]: # (END_PARAMETERS) ### Return type [**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md) [//]: # (END_OPERATION)