Options Intervals By Contract R API Documentation

Back to Product Docs

Returns a list of interval data points for a contract.

API Class:

IntrinioSDK::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
24
25
26
27
client <- IntrinioSDK::ApiClient$new()
# Configure API key authorization: ApiKeyAuth
client$configuration$apiKey <- "YOUR_API_KEY"
#Configure retries
client$configuration$allowRetries <- TRUE
# Setup API with client
OptionsApi <- IntrinioSDK::OptionsApi$new(client)
# Required params
identifier <- "SPY___230103P00380000"
interval_size <- "5m"
# Optional params
opts <- list(
  source = NULL,
  page_size = 100,
  end_time = as.POSIXlt(NULL, tz="UTC")
)
response <- OptionsApi$get_options_interval_by_contract(identifier, interval_size, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

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

Return Type

object

IntrinioSDK::OptionIntervalsResult

Properties

Name	Type	Description
intervals	List of OptionInterval	Array of all the intervals in the result.
intervals_data_frame	Data Frame	Data frame representation of intervals
contract	Character	The option contract for the intervals
size	Character	The size of the time span for the interval.

object

IntrinioSDK::OptionInterval

Properties

Name	Type	Description
open_time	POSIXlt	The UTC timestamp for the time this interval opened.
close_time	POSIXlt	The UTC timestamp for the time this interval closed.
open	Numeric	The first traded contract price in this interval.
high	Numeric	The highest traded contract price in this interval.
low	Numeric	The lowest traded contract price in this interval.
close	Numeric	The last traded contract price in this interval.
volume	Numeric	The volume of contracts traded in this interval.
average	Numeric	The volume weighted average price of contract trades in this interval.
change	Numeric	The ratio of Close minus Open to Open.
trade_count	Numeric	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