Returns unusual trades for all underlying security symbols within the query parameters.
Name | Type | Description | Notes |
---|---|---|---|
next_page | String | Gets the next page of data from a previous API call | [optional] |
page_size | Integer | The number of results to return | [optional] [default to 1000] |
activity_type | String | The unusual activity type to query for. | [optional] |
sentiment | String | The sentiment type to query for. | [optional] |
start_date | Date | Return unusual activity on or after this date. | [optional] |
end_date | Date | Return unusual activity on or before this date. | [optional] |
minimum_total_value | Object | The inclusive minimum total value for the unusual activity. | [optional] |
maximum_total_value | Object | The inclusive maximum total value for the unusual activity. | [optional] |
Name | Type | Description |
---|---|---|
trades | Array | A list of unusual trades for a given company identifier |
Name | Type | Description |
---|---|---|
symbol | String | The underlying option security symbol for the trade |
timestamp | Date | The UTC timestamp of order placement |
type | String | The type of unusual trade |
total_value | Float | The aggregated value of all option contract premiums included in the trade |
total_size | Float | The total number of contracts involved in a single transaction |
average_price | Float | The average premium paid per option contract |
contract | String | The option contract symbol |
ask_at_execution | Float | Ask price at execution |
bid_at_execution | Float | Bid price at execution |
sentiment | String | Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price. |
underlying_price_at_execution | Float | Price of the underlying security at execution of trade |