Options by Symbol Realtime Ruby API Documentation

Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.

API Class:

Intrinio::OptionsApi

Instance Method:

get_options_by_symbol_realtime()

Stock Price Code Example

Use my API Key

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# Load the gem
require 'intrinio-sdk'
require 'pp'
# Setup authorization
Intrinio.configure do |config|
  config.api_key['api_key'] = 'YOUR_API_KEY'
  config.allow_retries = true
end
options_api = Intrinio::OptionsApi.new
symbol = "AAPL"
opts = {
  type: "put",
  strike: 170,
  strike_greater_than: 150,
  strike_less_than: 190,
  expiration: "2022-04-16",
  expiration_after: "2022-01-01",
  expiration_before: "2023-12-31",
  source: nil,
  include_related_symbols: false
}
result = options_api.get_options_by_symbol_realtime(symbol, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
symbol	String	The option symbol, corresponding to the underlying security.
type	String	The option contract type.	[optional]
strike	Float	The strike price of the option contract. This will return options contracts with strike price equal to this price.	[optional]
strike_greater_than	Float	The strike price of the option contract. This will return options contracts with strike prices greater than this price.	[optional]
strike_less_than	Float	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]
expiration_after	String	The expiration date of the option contract. This will return options contracts with expiration dates after this date.	[optional]
expiration_before	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]
include_related_symbols	BOOLEAN	Include related symbols that end in a 1 or 2 because of a corporate action.	[optional]

Return Type

object

Intrinio::ApiResponseOptionsRealtime

Properties

Name	Type	Description
options	Array	A list of options contracts with the given symbol

object

Intrinio::OptionRealtime

Properties

Name	Type	Description
code	String	The Intrinio Code for the Option.
ticker	String	The ticker symbol of the Security for the Option.
expiration	Date	The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.
strike	Float	The strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative's underlying asset. In a call option, the strike price is the price at which the option holder can purchase the underlying security. For a put option, the strike price is the price at which the option holder can sell the underlying security.
type	String	The type of Option (put or call).

Options by Symbol Realtime

SDKs

API Endpoints

Standardized & As-Reported Financial Statement Data

Company Reference & Metadata

Company News

Insider & Institutional Holdings Data

Upcoming & Historical IPOs

Raw Text Filings

XBRL Searchable Financial Statement Notes

Aggregate Standardized Financial Statement Data by SIC Codes

Economic Data

Security Reference Data

Real-Time Prices

Historical Intraday Prices

Historical End of Day Prices

Technical Indicators

Historical End of Day Index Prices

Reference & Metadata

Holdings

Returns & Analytics