Options Unusual Activity Intraday

Options Unusual Activity Intraday Ruby API Documentation

Returns unusual trades for a given identifier within the query parameters.

API Class:
Intrinio::OptionsApi
Instance Method:
get_unusual_activity_intraday()

Stock Price Code Example

Use my API Key
# 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 = {
next_page: nil,
page_size: 1000,
activity_type: nil,
sentiment: nil,
start_date: Date.parse("2022-02-01"),
end_date: Date.parse("2022-02-03"),
minimum_total_value: 100000.0,
maximum_total_value: 200000.0
}
result = options_api.get_unusual_activity_intraday(symbol, opts)
pp result
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
symbolStringThe option symbol, corresponding to the underlying security. 
next_pageStringGets the next page of data from a previous API call[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 1000]  
activity_typeStringThe unusual activity type to query for.[optional]  
sentimentStringThe sentiment type to query for.[optional]  
start_dateDateReturn unusual activity on or after this date.[optional]  
end_dateDateReturn unusual activity on or before this date.[optional]  
minimum_total_valueObjectThe inclusive minimum total value for the unusual activity.[optional]  
maximum_total_valueObjectThe inclusive maximum total value for the unusual activity.[optional]  

Return Type

object
Intrinio::ApiResponseOptionsUnusualActivity

Properties

NameTypeDescription
tradesArrayA list of unusual trades for a given company identifier  
object
Intrinio::OptionUnusualTrade

Properties

NameTypeDescription
symbolStringThe underlying option security symbol for the trade  
timestampDateThe UTC timestamp of order placement  
typeStringThe type of unusual trade  
total_valueFloatThe aggregated value of all option contract premiums included in the trade  
total_sizeFloatThe total number of contracts involved in a single transaction  
average_priceFloatThe average premium paid per option contract  
contractStringThe option contract symbol  
ask_at_executionFloatAsk price at execution  
bid_at_executionFloatBid price at execution  
sentimentStringBullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.  
underlying_price_at_executionFloatPrice of the underlying security at execution of trade