Options Intervals By Contract Ruby API Documentation

Back to Product Docs

Returns a list of interval data points for a contract.

API Class:

Intrinio::OptionsApi

Instance Method:

get_options_interval_by_contract()

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
# 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
identifier = "SPY___230103P00380000"
interval_size = "5m"
opts = {
  source: nil,
  page_size: 100,
  end_time: DateTime.parse(nil)
}
result = options_api.get_options_interval_by_contract(identifier, interval_size, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
identifier	String	The Intrinio ID or code of the options contract to request intervals for.
interval_size	String	The time length of the interval.
source	String	Realtime or 15-minute delayed contracts.	[optional]
page_size	Integer	The number of results to return	[optional] [default to 100]
end_time	DateTime	The inclusive UTC date and time the intervals end at.	[optional]

Return Type

object

Intrinio::OptionIntervalsResult

Properties

Name	Type	Description
intervals	Array	Array of all the intervals in the result.
contract	String	The option contract for the intervals
size	String	The size of the time span for the interval.

object

Intrinio::OptionInterval

Properties

Name	Type	Description
open_time	DateTime	The UTC timestamp for the time this interval opened.
close_time	DateTime	The UTC timestamp for the time this interval closed.
open	Float	The first traded contract price in this interval.
high	Float	The highest traded contract price in this interval.
low	Float	The lowest traded contract price in this interval.
close	Float	The last traded contract price in this interval.
volume	Float	The volume of contracts traded in this interval.
average	Float	The volume weighted average price of contract trades in this interval.
change	Float	The ratio of Close minus Open to Open.
trade_count	Float	The number of qualified trades executed during the period

Options Intervals By Contract

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