Option Trades Ruby API Documentation

Back to Product Docs

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

API Class:

Intrinio::OptionsApi

Instance Method:

get_option_trades()

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
opts = {
  source: nil,
  start_date: nil,
  start_time: nil,
  end_date: nil,
  end_time: nil,
  timezone: "UTC",
  page_size: 100,
  min_size: 100,
  security: "AAPL",
  next_page: nil
}
result = options_api.get_option_trades(opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

Name	Type	Description	Notes
source	String	The specific source of the data being requested.	[optional]
start_date	Date	The start date for the data being requested.	[optional]
start_time	String	The start time for the data being requested.	[optional]
end_date	Date	The end date for the data being requested.	[optional]
end_time	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]
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]
security	String	The ticker symbol for which trades are being requested.	[optional]
next_page	String	Gets the next page of data from a previous API call	[optional]

Return Type

object

Intrinio::OptionTradesResult

Properties

Name	Type	Description
next_page	String	The token required to request the next page of the data. If null, no further results are available.
source	String	The source of the trades.
trades	Array	Array of all the trades in this page of the result.

object

Intrinio::OptionTrades

Properties

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

Option Trades

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