Options Unusual Activity Intraday

Options Unusual Activity Intraday R API Documentation

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

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

Stock Price Code Example

Use my API Key
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
symbol <- "AAPL"
# Optional params
opts <- list(
next_page = NULL,
page_size = 1000,
activity_type = NULL,
sentiment = NULL,
start_date = as.Date("2022-02-01"),
end_date = as.Date("2022-02-03"),
minimum_total_value = IntrinioSDK::TODO_OBJECT_MAPPING$new(),
maximum_total_value = IntrinioSDK::TODO_OBJECT_MAPPING$new()
)
response <- OptionsApi$get_unusual_activity_intraday(symbol, opts)
print(response)
print(response$content)
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Parameters

NameTypeDescriptionNotes
symbolCharacterThe option symbol, corresponding to the underlying security. 
next_pageCharacterGets the next page of data from a previous API call[optional]  
page_sizeIntegerThe number of results to return[optional] [default to 1000]  
activity_typeCharacterThe unusual activity type to query for.[optional]  
sentimentCharacterThe 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_valueTODO_OBJECT_MAPPINGThe inclusive minimum total value for the unusual activity.[optional]  
maximum_total_valueTODO_OBJECT_MAPPINGThe inclusive maximum total value for the unusual activity.[optional]  


Return Type

object
IntrinioSDK::ApiResponseOptionsUnusualActivity

Properties

NameTypeDescription
tradesList of OptionUnusualTradeA list of unusual trades for a given company identifier  
trades_data_frameData FrameData frame representation of trades
object
IntrinioSDK::OptionUnusualTrade

Properties

NameTypeDescription
symbolCharacterThe underlying option security symbol for the trade  
timestampDateThe UTC timestamp of order placement  
typeCharacterThe type of unusual trade  
total_valueNumericThe aggregated value of all option contract premiums included in the trade  
total_sizeNumericThe total number of contracts involved in a single transaction  
average_priceNumericThe average premium paid per option contract  
contractCharacterThe option contract symbol  
ask_at_executionNumericAsk price at execution  
bid_at_executionNumericBid price at execution  
sentimentCharacterBullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price.  
underlying_price_at_executionNumericPrice of the underlying security at execution of trade