Option Trades By Contract R API Documentation

Back to Product Docs

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

API Class:

IntrinioSDK::OptionsApi

Instance Method:

get_option_trades_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
28
29
30
31
32
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 <- "AAPL__261218C00230000"
# Optional params
opts <- list(
  source = NULL,
  start_date = NULL,
  start_time = NULL,
  end_date = NULL,
  end_time = NULL,
  timezone = "UTC",
  page_size = 100,
  min_size = 100,
  next_page = NULL
)
response <- OptionsApi$get_option_trades_by_contract(identifier, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
identifier	Character	The option contract for which trades are being requested.
source	Character	The specific source of the data being requested.	[optional]
start_date	Date	The start date for the data being requested.	[optional]
start_time	Character	The start time for the data being requested.	[optional]
end_date	Date	The end date for the data being requested.	[optional]
end_time	Character	The end time for the data being requested.	[optional]
timezone	Character	The timezone the start and end date/times use.	[optional] [default to UTC]
page_size	Integer	The maximum number of results to return per page.	[optional] [default to 100]
min_size	Integer	Trades must be larger or equal to this size.	[optional]
next_page	Character	Gets the next page of data from a previous API call	[optional]

Return Type

object

IntrinioSDK::OptionTradesResult

Properties

Name	Type	Description
next_page	Character	The token required to request the next page of the data. If null, no further results are available.
source	Character	The source of the trades.
trades	List of OptionTrades	Array of all the trades in this page of the result.
trades_data_frame	Data Frame	Data frame representation of trades

object

IntrinioSDK::OptionTrades

Properties

Name	Type	Description
contract	Character	The option contract
underlying_symbol	Character	The ticker symbol
timestamp	POSIXlt	The UTC timestamp at the time of the trade.
price	Numeric	The price of the trade.
size	Numeric	The size of the trade.
total_volume	Numeric	The total volume of the symbol for the day up to the timestamp point in time.
ask_price_at_execution	Numeric	The price of ask quote at the time of the trade.
bid_price_at_execution	Numeric	The price of bid quote at the time of the trade.
exchange	Character	The exchange for the trade.
conditions	Character	The condition of the trade.
sequence_id	Numeric	The sequential ID for the trade, ordered as temporally received from the exchange.

Option Trades 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