Skip to content

Latest commit

 

History

History
2874 lines (1913 loc) · 90.1 KB

OptionsApi.md

File metadata and controls

2874 lines (1913 loc) · 90.1 KB

Intrinio.SDK.Api.OptionsApi

All URIs are relative to https://api-v2.intrinio.com

Method HTTP request Description
GetAllOptionsTickers GET /options/tickers Options Tickers
GetOptionAggregates GET /options/aggregates Total open interest and volume aggregated by ticker
GetOptionExpirationsRealtime GET /options/expirations/{symbol}/realtime Options Expirations
GetOptionStrikesRealtime GET /options/strikes/{symbol}/{strike}/realtime Option Strikes Realtime
GetOptionTrades GET /options/trades Option Trades
GetOptionTradesByContract GET /options/{identifier}/trades Option Trades By Contract
GetOptions GET /options/{symbol} Options
GetOptionsBySymbolRealtime GET /options/{symbol}/realtime Options by Symbol Realtime
GetOptionsChain GET /options/chain/{symbol}/{expiration} Options Chain
GetOptionsChainEod GET /options/chain/{symbol}/{expiration}/eod Options Chain EOD
GetOptionsChainRealtime GET /options/chain/{symbol}/{expiration}/realtime Options Chain Realtime
GetOptionsExpirations GET /options/expirations/{symbol} Options Expirations
GetOptionsExpirationsEod GET /options/expirations/{symbol}/eod Options Expirations
GetOptionsIntervalByContract GET /options/interval/{identifier} Options Intervals By Contract
GetOptionsIntervalMovers GET /options/interval/movers Options Intervals Movers
GetOptionsIntervalMoversChange GET /options/interval/movers/change Options Intervals Movers By Change
GetOptionsIntervalMoversVolume GET /options/interval/movers/volume Options Intervals Movers By Volume
GetOptionsPrices GET /options/prices/{identifier} Option Prices
GetOptionsPricesBatchRealtime POST /options/prices/realtime/batch Option Prices Batch Realtime
GetOptionsPricesEod GET /options/prices/{identifier}/eod Option Prices EOD
GetOptionsPricesEodByTicker GET /options/prices/by_ticker/{symbol}/eod Option Prices End of Day By Ticker
GetOptionsPricesRealtime GET /options/prices/{identifier}/realtime Option Prices Realtime
GetOptionsPricesRealtimeByTicker GET /options/prices/by_ticker/{symbol}/realtime Option Prices Realtime By Ticker
GetOptionsSnapshots GET /options/snapshots Option Prices Realtime Snapshot
GetOptionsStatsRealtime GET /options/prices/{identifier}/realtime/stats Option Stats Realtime
GetUnusualActivity GET /options/unusual_activity/{symbol} Options Unusual Activity
GetUnusualActivityIntraday GET /options/unusual_activity/{symbol}/intraday Options Unusual Activity Intraday
GetUnusualActivityUniversal GET /options/unusual_activity Options Unusual Activity Universal
GetUnusualActivityUniversalIntraday GET /options/unusual_activity/intraday Options Unusual Activity Universal Intraday

GetAllOptionsTickers

View Intrinio API Documentation

ApiResponseOptionsTickers GetAllOptionsTickers (bool? useUnderlyingSymbols = null)

Options Tickers

Returns all tickers that have existing options contracts.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllOptionsTickersExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      bool? useUnderlyingSymbols = false;
      
      ApiResponseOptionsTickers result = optionsApi.GetAllOptionsTickers(useUnderlyingSymbols);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
useUnderlyingSymbols bool? Use underlying symbol vs contract symbol [optional] [default to false]  

Return type

ApiResponseOptionsTickers

GetOptionAggregates

View Intrinio API Documentation

ApiResponseOptionsAggregates GetOptionAggregates (Object date = null, int? pageSize = null, string nextPage = null)

Total open interest and volume aggregated by ticker

Returns total open interest and volume by ticker

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionAggregatesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      var date = new Object();
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseOptionsAggregates result = optionsApi.GetOptionAggregates(date, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
date Object Return aggregated data for this date [optional]  
pageSize int? The number of results to return [optional] [default to 100]  
nextPage string Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOptionsAggregates

GetOptionExpirationsRealtime

View Intrinio API Documentation

ApiResponseOptionsExpirations GetOptionExpirationsRealtime (string symbol, string after = null, string before = null, string source = null, bool? includeRelatedSymbols = null)

Options Expirations

Returns a list of all current and upcoming option contract expiration dates for a particular symbol.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionExpirationsRealtimeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      string after = "2022-01-01";
      string before = "2023-04-01";
      string source = null;
      bool? includeRelatedSymbols = false;
      
      ApiResponseOptionsExpirations result = optionsApi.GetOptionExpirationsRealtime(symbol, after, before, source, includeRelatedSymbols);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 bool? Include related symbols that end in a 1 or 2 because of a corporate action. [optional]  

Return type

ApiResponseOptionsExpirations

GetOptionStrikesRealtime

View Intrinio API Documentation

ApiResponseOptionsChainRealtime GetOptionStrikesRealtime (string symbol, decimal? strike, string source = null, string stockPriceSource = null, string model = null, bool? showExtendedPrice = null, bool? includeRelatedSymbols = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionStrikesRealtimeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      decimal? strike = 95;
      string source = null;
      string stockPriceSource = null;
      string model = null;
      bool? showExtendedPrice = null;
      bool? includeRelatedSymbols = false;
      
      ApiResponseOptionsChainRealtime result = optionsApi.GetOptionStrikesRealtime(symbol, strike, source, stockPriceSource, model, showExtendedPrice, includeRelatedSymbols);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
symbol string The option symbol, corresponding to the underlying security.  
strike decimal? 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 bool? Whether to include open close high low type fields. [optional]  
includeRelatedSymbols bool? Include related symbols that end in a 1 or 2 because of a corporate action. [optional]  

Return type

ApiResponseOptionsChainRealtime

GetOptionTrades

View Intrinio API Documentation

OptionTradesResult GetOptionTrades (string source = null, DateTime? startDate = null, string startTime = null, DateTime? endDate = null, string endTime = null, string timezone = null, int? pageSize = null, int? minSize = null, string security = null, string nextPage = null)

Option Trades

Returns all trades between start time and end time, up to seven days ago for the specified source.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionTradesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string source = null;
      DateTime? startDate = null;
      string startTime = null;
      DateTime? endDate = null;
      string endTime = null;
      string timezone = "UTC";
      int? pageSize = 100;
      int? minSize = 100;
      string security = "AAPL";
      string nextPage = null;
      
      OptionTradesResult result = optionsApi.GetOptionTrades(source, startDate, startTime, endDate, endTime, timezone, pageSize, minSize, security, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
source string The specific source of the data being requested. [optional]  
startDate DateTime? The start date for the data being requested. [optional]  
startTime string The start time for the data being requested. [optional]  
endDate DateTime? 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 int? The maximum number of results to return per page. [optional] [default to 100]  
minSize int? 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]  

Return type

OptionTradesResult

GetOptionTradesByContract

View Intrinio API Documentation

OptionTradesResult GetOptionTradesByContract (string identifier, string source = null, DateTime? startDate = null, string startTime = null, DateTime? endDate = null, string endTime = null, string timezone = null, int? pageSize = null, int? minSize = null, string nextPage = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionTradesByContractExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string identifier = "AAPL__261218C00230000";
      string source = null;
      DateTime? startDate = null;
      string startTime = null;
      DateTime? endDate = null;
      string endTime = null;
      string timezone = "UTC";
      int? pageSize = 100;
      int? minSize = 100;
      string nextPage = null;
      
      OptionTradesResult result = optionsApi.GetOptionTradesByContract(identifier, source, startDate, startTime, endDate, endTime, timezone, pageSize, minSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 DateTime? The start date for the data being requested. [optional]  
startTime string The start time for the data being requested. [optional]  
endDate DateTime? 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 int? The maximum number of results to return per page. [optional] [default to 100]  
minSize int? Trades must be larger or equal to this size. [optional]  
nextPage string Gets the next page of data from a previous API call [optional]  

Return type

OptionTradesResult

GetOptions

View Intrinio API Documentation

ApiResponseOptions GetOptions (string symbol, string type = null, decimal? strike = null, decimal? strikeGreaterThan = null, decimal? strikeLessThan = null, string expiration = null, string expirationAfter = null, string expirationBefore = null, int? pageSize = null, string nextPage = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "AAPL";
      string type = "put";
      decimal? strike = 170;
      decimal? strikeGreaterThan = 150;
      decimal? strikeLessThan = 190;
      string expiration = "2019-03-01";
      string expirationAfter = "2019-01-01";
      string expirationBefore = "2019-12-31";
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseOptions result = optionsApi.GetOptions(symbol, type, strike, strikeGreaterThan, strikeLessThan, expiration, expirationAfter, expirationBefore, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
symbol string The option symbol, corresponding to the underlying security.  
type string The option contract type. [optional]  
strike decimal? The strike price of the option contract. This will return options contracts with strike price equal to this price. [optional]  
strikeGreaterThan decimal? The strike price of the option contract. This will return options contracts with strike prices greater than this price. [optional]  
strikeLessThan decimal? 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 int? The number of results to return [optional] [default to 100]  
nextPage string Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOptions

GetOptionsBySymbolRealtime

View Intrinio API Documentation

ApiResponseOptionsRealtime GetOptionsBySymbolRealtime (string symbol, string type = null, decimal? strike = null, decimal? strikeGreaterThan = null, decimal? strikeLessThan = null, string expiration = null, string expirationAfter = null, string expirationBefore = null, string source = null, bool? includeRelatedSymbols = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsBySymbolRealtimeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "AAPL";
      string type = "put";
      decimal? strike = 170;
      decimal? strikeGreaterThan = 150;
      decimal? strikeLessThan = 190;
      string expiration = "2022-04-16";
      string expirationAfter = "2022-01-01";
      string expirationBefore = "2023-12-31";
      string source = null;
      bool? includeRelatedSymbols = false;
      
      ApiResponseOptionsRealtime result = optionsApi.GetOptionsBySymbolRealtime(symbol, type, strike, strikeGreaterThan, strikeLessThan, expiration, expirationAfter, expirationBefore, source, includeRelatedSymbols);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
symbol string The option symbol, corresponding to the underlying security.  
type string The option contract type. [optional]  
strike decimal? The strike price of the option contract. This will return options contracts with strike price equal to this price. [optional]  
strikeGreaterThan decimal? The strike price of the option contract. This will return options contracts with strike prices greater than this price. [optional]  
strikeLessThan decimal? 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 bool? Include related symbols that end in a 1 or 2 because of a corporate action. [optional]  

Return type

ApiResponseOptionsRealtime

GetOptionsChain

View Intrinio API Documentation

ApiResponseOptionsChain GetOptionsChain (string symbol, string expiration, DateTime? date = null, string type = null, decimal? strike = null, decimal? strikeGreaterThan = null, decimal? strikeLessThan = null, string moneyness = null, int? pageSize = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsChainExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      string expiration = "2019-04-05";
      DateTime? date = null;
      string type = null;
      decimal? strike = null;
      decimal? strikeGreaterThan = null;
      decimal? strikeLessThan = null;
      string moneyness = null;
      int? pageSize = null;
      
      ApiResponseOptionsChain result = optionsApi.GetOptionsChain(symbol, expiration, date, type, strike, strikeGreaterThan, strikeLessThan, moneyness, pageSize);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 DateTime? The date of the option price. Returns option prices on this date. [optional]  
type string The option contract type. [optional]  
strike decimal? The strike price of the option contract. This will return options contracts with strike price equal to this price. [optional]  
strikeGreaterThan decimal? The strike price of the option contract. This will return options contracts with strike prices greater than this price. [optional]  
strikeLessThan decimal? 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 int? The number of results to return [optional] [default to 100]  

Return type

ApiResponseOptionsChain

GetOptionsChainEod

View Intrinio API Documentation

ApiResponseOptionsChainEod GetOptionsChainEod (string symbol, string expiration, string type = null, decimal? strike = null, decimal? strikeGreaterThan = null, decimal? strikeLessThan = null, DateTime? date = null, bool? includeRelatedSymbols = null)

Options Chain EOD

Returns all EOD options contracts and their prices for the given symbol and expiration date.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsChainEodExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "AAPL";
      string expiration = "2023-01-20";
      string type = null;
      decimal? strike = null;
      decimal? strikeGreaterThan = null;
      decimal? strikeLessThan = null;
      DateTime? date = null;
      bool? includeRelatedSymbols = false;
      
      ApiResponseOptionsChainEod result = optionsApi.GetOptionsChainEod(symbol, expiration, type, strike, strikeGreaterThan, strikeLessThan, date, includeRelatedSymbols);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 decimal? The strike price of the option contract. This will return options contracts with strike price equal to this price. [optional]  
strikeGreaterThan decimal? The strike price of the option contract. This will return options contracts with strike prices greater than this price. [optional]  
strikeLessThan decimal? The strike price of the option contract. This will return options contracts with strike prices less than this price. [optional]  
date DateTime? The date to retrieve prices for [optional]  
includeRelatedSymbols bool? Include related symbols that end in a 1 or 2 because of a corporate action. [optional]  

Return type

ApiResponseOptionsChainEod

GetOptionsChainRealtime

View Intrinio API Documentation

ApiResponseOptionsChainRealtime GetOptionsChainRealtime (string symbol, string expiration, string source = null, string type = null, decimal? strike = null, decimal? strikeGreaterThan = null, decimal? strikeLessThan = null, decimal? volumeGreaterThan = null, decimal? volumeLessThan = null, decimal? openInterestGreaterThan = null, decimal? openInterestLessThan = null, string moneyness = null, string stockPriceSource = null, string model = null, bool? showExtendedPrice = null, bool? includeRelatedSymbols = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsChainRealtimeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      string expiration = "2023-01-20";
      string source = null;
      string type = null;
      decimal? strike = null;
      decimal? strikeGreaterThan = null;
      decimal? strikeLessThan = null;
      decimal? volumeGreaterThan = null;
      decimal? volumeLessThan = null;
      decimal? openInterestGreaterThan = null;
      decimal? openInterestLessThan = null;
      string moneyness = null;
      string stockPriceSource = null;
      string model = null;
      bool? showExtendedPrice = null;
      bool? includeRelatedSymbols = false;
      
      ApiResponseOptionsChainRealtime result = optionsApi.GetOptionsChainRealtime(symbol, expiration, source, type, strike, strikeGreaterThan, strikeLessThan, volumeGreaterThan, volumeLessThan, openInterestGreaterThan, openInterestLessThan, moneyness, stockPriceSource, model, showExtendedPrice, includeRelatedSymbols);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 decimal? The strike price of the option contract. This will return options contracts with strike price equal to this price. [optional]  
strikeGreaterThan decimal? The strike price of the option contract. This will return options contracts with strike prices greater than this price. [optional]  
strikeLessThan decimal? The strike price of the option contract. This will return options contracts with strike prices less than this price. [optional]  
volumeGreaterThan decimal? The volume of the option contract. This will return options contracts with volumes greater than this amount. [optional]  
volumeLessThan decimal? The volume of the option contract. This will return options contracts with volumes less than this amout. [optional]  
openInterestGreaterThan decimal? The open interest of the option contract. This will return options contracts with open interest greater than this amount. [optional]  
openInterestLessThan decimal? 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 bool? Whether to include open close high low type fields. [optional]  
includeRelatedSymbols bool? Include related symbols that end in a 1 or 2 because of a corporate action. [optional]  

Return type

ApiResponseOptionsChainRealtime

GetOptionsExpirations

View Intrinio API Documentation

ApiResponseOptionsExpirations GetOptionsExpirations (string symbol, string after = null, string before = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsExpirationsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      string after = "2019-01-01";
      string before = "2019-12-31";
      
      ApiResponseOptionsExpirations result = optionsApi.GetOptionsExpirations(symbol, after, before);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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]  

Return type

ApiResponseOptionsExpirations

GetOptionsExpirationsEod

View Intrinio API Documentation

ApiResponseOptionsExpirations GetOptionsExpirationsEod (string symbol, string after = null, string before = null, bool? includeRelatedSymbols = null)

Options Expirations

Returns a list of all current and upcoming option contract expiration dates for a particular symbol.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsExpirationsEodExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      string after = "2019-01-01";
      string before = "2019-12-31";
      bool? includeRelatedSymbols = false;
      
      ApiResponseOptionsExpirations result = optionsApi.GetOptionsExpirationsEod(symbol, after, before, includeRelatedSymbols);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 bool? Include related symbols that end in a 1 or 2 because of a corporate action. [optional]  

Return type

ApiResponseOptionsExpirations

GetOptionsIntervalByContract

View Intrinio API Documentation

OptionIntervalsResult GetOptionsIntervalByContract (string identifier, string intervalSize, string source = null, int? pageSize = null, DateTime? endTime = null)

Options Intervals By Contract

Returns a list of interval data points for a contract.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsIntervalByContractExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string identifier = "SPY___230103P00380000";
      string intervalSize = "5m";
      string source = null;
      int? pageSize = 100;
      DateTime? endTime = null;
      
      OptionIntervalsResult result = optionsApi.GetOptionsIntervalByContract(identifier, intervalSize, source, pageSize, endTime);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 int? The number of results to return [optional] [default to 100]  
endTime DateTime? The inclusive UTC date and time the intervals end at. [optional]  

Return type

OptionIntervalsResult

GetOptionsIntervalMovers

View Intrinio API Documentation

OptionIntervalsMoversResult GetOptionsIntervalMovers (string source = null, DateTime? openTime = null)

Options Intervals Movers

Returns a list of intervals for the biggest movers over the last hour interval.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsIntervalMoversExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string source = null;
      DateTime? openTime = null;
      
      OptionIntervalsMoversResult result = optionsApi.GetOptionsIntervalMovers(source, openTime);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
source string Realtime or 15-minute delayed contracts. [optional]  
openTime DateTime? The inclusive UTC date and time the interval opens at. [optional]  

Return type

OptionIntervalsMoversResult

GetOptionsIntervalMoversChange

View Intrinio API Documentation

OptionIntervalsMoversResult GetOptionsIntervalMoversChange (string source = null, DateTime? openTime = null)

Options Intervals Movers By Change

Returns a list of intervals for the biggest movers by change over the last hour interval.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsIntervalMoversChangeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string source = null;
      DateTime? openTime = null;
      
      OptionIntervalsMoversResult result = optionsApi.GetOptionsIntervalMoversChange(source, openTime);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
source string Realtime or 15-minute delayed contracts. [optional]  
openTime DateTime? The inclusive UTC date and time the interval opens at. [optional]  

Return type

OptionIntervalsMoversResult

GetOptionsIntervalMoversVolume

View Intrinio API Documentation

OptionIntervalsMoversResult GetOptionsIntervalMoversVolume (string source = null, DateTime? openTime = null)

Options Intervals Movers By Volume

Returns a list of intervals for the biggest movers by volume over the last hour interval.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsIntervalMoversVolumeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string source = null;
      DateTime? openTime = null;
      
      OptionIntervalsMoversResult result = optionsApi.GetOptionsIntervalMoversVolume(source, openTime);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
source string Realtime or 15-minute delayed contracts. [optional]  
openTime DateTime? The inclusive UTC date and time the interval opens at. [optional]  

Return type

OptionIntervalsMoversResult

GetOptionsPrices

View Intrinio API Documentation

ApiResponseOptionPrices GetOptionsPrices (string identifier, string startDate = null, string endDate = null, int? pageSize = null, string nextPage = null)

Option Prices

Returns all price data from inception to expiration for a particular contract.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsPricesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string identifier = "MSFT190405C00118000";
      string startDate = "2019-01-01";
      string endDate = "2019-12-31";
      int? pageSize = 100;
      string nextPage = null;
      
      ApiResponseOptionPrices result = optionsApi.GetOptionsPrices(identifier, startDate, endDate, pageSize, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 int? The number of results to return [optional] [default to 100]  
nextPage string Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOptionPrices

GetOptionsPricesBatchRealtime

View Intrinio API Documentation

ApiResponseOptionsPricesBatchRealtime GetOptionsPricesBatchRealtime (OptionContractsList body, string source = null, bool? showStats = null, string stockPriceSource = null, string model = null, bool? showExtendedPrice = null)

Option Prices Batch Realtime

Returns a list of latest price data for up to 250 option contracts per request.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsPricesBatchRealtimeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string source = null;
      bool? showStats = null;
      string stockPriceSource = null;
      string model = null;
      bool? showExtendedPrice = null;
      
      var body = new OptionContractsList();
      body.Contracts = new List<string>(new string[] { "A220121P00055000", "A220121P00057500", "A220121P00060000" });
      ApiResponseOptionsPricesBatchRealtime result = optionsApi.GetOptionsPricesBatchRealtime(body, source, showStats, stockPriceSource, model, showExtendedPrice);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
body OptionContractsList The contract symbols for which to return options prices for.  
source string Realtime or 15-minute delayed contracts. [optional]  
showStats bool? 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 bool? Whether to include open close high low type fields. [optional]  

Return type

ApiResponseOptionsPricesBatchRealtime

GetOptionsPricesEod

View Intrinio API Documentation

ApiResponseOptionsPricesEod GetOptionsPricesEod (string identifier, string nextPage = null, DateTime? startDate = null, DateTime? endDate = null)

Option Prices EOD

Returns all option prices for a given option contract identifier.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsPricesEodExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string identifier = "AAPL230616P00190000";
      string nextPage = null;
      DateTime? startDate = null;
      DateTime? endDate = null;
      
      ApiResponseOptionsPricesEod result = optionsApi.GetOptionsPricesEod(identifier, nextPage, startDate, endDate);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 DateTime? The start date to retrieve prices for [optional]  
endDate DateTime? The end date to retrieve prices for [optional]  

Return type

ApiResponseOptionsPricesEod

GetOptionsPricesEodByTicker

View Intrinio API Documentation

ApiResponseOptionsPricesByTickerEod GetOptionsPricesEodByTicker (string symbol, int? pageSize = null, Object date = null, string type = null, decimal? strike = null, decimal? strikeGreaterThan = null, decimal? strikeLessThan = null, bool? includeRelatedSymbols = null, string nextPage = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsPricesEodByTickerExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      int? pageSize = 250;
      var date = new Object();
      string type = null;
      decimal? strike = null;
      decimal? strikeGreaterThan = null;
      decimal? strikeLessThan = null;
      bool? includeRelatedSymbols = false;
      string nextPage = null;
      
      ApiResponseOptionsPricesByTickerEod result = optionsApi.GetOptionsPricesEodByTicker(symbol, pageSize, date, type, strike, strikeGreaterThan, strikeLessThan, includeRelatedSymbols, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
symbol string The equities ticker symbol, corresponding to the underlying security.  
pageSize int? The number of results to return [optional] [default to 250]  
date Object The date to get pricing data for. Defaults to today in Eastern time zone. [optional]  
type string The option contract type. [optional]  
strike decimal? The strike price of the option contract. This will return options contracts with strike price equal to this price. [optional]  
strikeGreaterThan decimal? The strike price of the option contract. This will return options contracts with strike prices greater than this price. [optional]  
strikeLessThan decimal? The strike price of the option contract. This will return options contracts with strike prices less than this price. [optional]  
includeRelatedSymbols bool? Include related symbols that end in a 1 or 2 because of a corporate action. [optional]  
nextPage string Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseOptionsPricesByTickerEod

GetOptionsPricesRealtime

View Intrinio API Documentation

ApiResponseOptionsPriceRealtime GetOptionsPricesRealtime (string identifier, string source = null, string stockPriceSource = null, string model = null, bool? showExtendedPrice = null)

Option Prices Realtime

Returns all option prices for a given option contract identifier.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsPricesRealtimeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string identifier = "AAPL__261218C00230000";
      string source = null;
      string stockPriceSource = null;
      string model = null;
      bool? showExtendedPrice = null;
      
      ApiResponseOptionsPriceRealtime result = optionsApi.GetOptionsPricesRealtime(identifier, source, stockPriceSource, model, showExtendedPrice);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 bool? Whether to include open close high low type fields. [optional]  

Return type

ApiResponseOptionsPriceRealtime

GetOptionsPricesRealtimeByTicker

View Intrinio API Documentation

ApiResponseOptionsPricesByTickerRealtime GetOptionsPricesRealtimeByTicker (string symbol, string source = null, string ivMode = null, string nextPage = null, int? pageSize = null, string stockPriceSource = null, string model = null, bool? showExtendedPrice = null, Object expirationStartDate = null, Object expirationEndDate = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsPricesRealtimeByTickerExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "MSFT";
      string source = null;
      string ivMode = null;
      string nextPage = null;
      int? pageSize = 250;
      string stockPriceSource = null;
      string model = null;
      bool? showExtendedPrice = null;
      var expirationStartDate = new Object();
      var expirationEndDate = new Object();
      
      ApiResponseOptionsPricesByTickerRealtime result = optionsApi.GetOptionsPricesRealtimeByTicker(symbol, source, ivMode, nextPage, pageSize, stockPriceSource, model, showExtendedPrice, expirationStartDate, expirationEndDate);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 int? 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 bool? Whether to include open close high low type fields. [optional]  
expirationStartDate Object Filter out contracts that expire before this date. [optional]  
expirationEndDate Object Filter out contracts that expire after this date. [optional]  

Return type

ApiResponseOptionsPricesByTickerRealtime

GetOptionsSnapshots

View Intrinio API Documentation

OptionSnapshotsResult GetOptionsSnapshots (string source = null, DateTime? atDatetime = null)

Option Prices Realtime Snapshot

Returns all options snapshots for the queried interval with links to download.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsSnapshotsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string source = null;
      DateTime? atDatetime = null;
      
      OptionSnapshotsResult result = optionsApi.GetOptionsSnapshots(source, atDatetime);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
source string Realtime or 15-minute delayed contracts. [optional]  
atDatetime DateTime? The UTC date and time (with url-encoded spaces) the snapshot will cover. [optional]  

Return type

OptionSnapshotsResult

GetOptionsStatsRealtime

View Intrinio API Documentation

ApiResponseOptionsStatsRealtime GetOptionsStatsRealtime (string identifier, string source = null, bool? showExtendedPrice = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetOptionsStatsRealtimeExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string identifier = "AAPL230120C00090000";
      string source = null;
      bool? showExtendedPrice = null;
      
      ApiResponseOptionsStatsRealtime result = optionsApi.GetOptionsStatsRealtime(identifier, source, showExtendedPrice);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 bool? Whether to include open close high low type fields. [optional]  

Return type

ApiResponseOptionsStatsRealtime

GetUnusualActivity

View Intrinio API Documentation

ApiResponseOptionsUnusualActivity GetUnusualActivity (string symbol, string source = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetUnusualActivityExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "AAPL";
      string source = null;
      
      ApiResponseOptionsUnusualActivity result = optionsApi.GetUnusualActivity(symbol, source);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
symbol string The option symbol, corresponding to the underlying security.  
source string Realtime or 15-minute delayed contracts. [optional]  

Return type

ApiResponseOptionsUnusualActivity

GetUnusualActivityIntraday

View Intrinio API Documentation

ApiResponseOptionsUnusualActivity GetUnusualActivityIntraday (string symbol, string nextPage = null, int? pageSize = null, string activityType = null, string sentiment = null, DateTime? startDate = null, DateTime? endDate = null, Object minimumTotalValue = null, Object maximumTotalValue = null)

Options Unusual Activity Intraday

Returns unusual trades for a given identifier within the query parameters.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetUnusualActivityIntradayExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string symbol = "AAPL";
      string nextPage = null;
      int? pageSize = 100;
      string activityType = null;
      string sentiment = null;
      DateTime? startDate = DateTime.Parse("2022-02-01");
      DateTime? endDate = DateTime.Parse("2022-02-03");
      var minimumTotalValue = new Object();
      var maximumTotalValue = new Object();
      
      ApiResponseOptionsUnusualActivity result = optionsApi.GetUnusualActivityIntraday(symbol, nextPage, pageSize, activityType, sentiment, startDate, endDate, minimumTotalValue, maximumTotalValue);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

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 int? 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 DateTime? Return unusual activity on or after this date. [optional]  
endDate DateTime? Return unusual activity on or before this date. [optional]  
minimumTotalValue Object The inclusive minimum total value for the unusual activity. [optional]  
maximumTotalValue Object The inclusive maximum total value for the unusual activity. [optional]  

Return type

ApiResponseOptionsUnusualActivity

GetUnusualActivityUniversal

View Intrinio API Documentation

ApiResponseOptionsUnusualActivity GetUnusualActivityUniversal (string source = null)

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.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetUnusualActivityUniversalExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string source = null;
      
      ApiResponseOptionsUnusualActivity result = optionsApi.GetUnusualActivityUniversal(source);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
source string Realtime or 15-minute delayed contracts. [optional]  

Return type

ApiResponseOptionsUnusualActivity

GetUnusualActivityUniversalIntraday

View Intrinio API Documentation

ApiResponseOptionsUnusualActivity GetUnusualActivityUniversalIntraday (string nextPage = null, int? pageSize = null, string activityType = null, string sentiment = null, DateTime? startDate = null, DateTime? endDate = null, Object minimumTotalValue = null, Object maximumTotalValue = null)

Options Unusual Activity Universal Intraday

Returns unusual trades for all underlying security symbols within the query parameters.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetUnusualActivityUniversalIntradayExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var optionsApi = new OptionsApi();
      
      string nextPage = null;
      int? pageSize = 100;
      string activityType = null;
      string sentiment = null;
      DateTime? startDate = DateTime.Parse("2022-02-01");
      DateTime? endDate = DateTime.Parse("2022-02-03");
      var minimumTotalValue = new Object();
      var maximumTotalValue = new Object();
      
      ApiResponseOptionsUnusualActivity result = optionsApi.GetUnusualActivityUniversalIntraday(nextPage, pageSize, activityType, sentiment, startDate, endDate, minimumTotalValue, maximumTotalValue);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
nextPage string Gets the next page of data from a previous API call [optional]  
pageSize int? 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 DateTime? Return unusual activity on or after this date. [optional]  
endDate DateTime? Return unusual activity on or before this date. [optional]  
minimumTotalValue Object The inclusive minimum total value for the unusual activity. [optional]  
maximumTotalValue Object The inclusive maximum total value for the unusual activity. [optional]  

Return type

ApiResponseOptionsUnusualActivity