Returns unusual trades for all underlying security symbols within the query parameters.
| Name | Description | Example |
|---|---|---|
|
next_page
|
Gets the next page of data from a previous API call | - |
|
page_size
|
The number of results to return | - |
|
activity_type
|
The unusual activity type to query for.
Options:
block
sweep
large
show more
show less
|
block |
|
sentiment
|
The sentiment type to query for.
Options:
bullish
bearish
neutral
show more
show less
|
bullish |
|
start_date
|
Return unusual activity on or after this date. | 2022-02-01 |
|
end_date
|
Return unusual activity before this date. | 2022-02-03 |
|
minimum_total_value
|
The inclusive minimum total value for the unusual activity. | 100000.0 |
|
maximum_total_value
|
The inclusive maximum total value for the unusual activity. | 200000.0 |
|
next_page
* required
Gets the next page of data from a previous API call
|
||
|
page_size
* required
The number of results to return
|
||
|
activity_type
* required
The unusual activity type to query for.
|
||
|
sentiment
* required
The sentiment type to query for.
|
||
|
start_date
* required
Return unusual activity on or after this date.
|
||
|
end_date
* required
Return unusual activity before this date.
|
||
|
minimum_total_value
* required
The inclusive minimum total value for the unusual activity.
|
||
|
maximum_total_value
* required
The inclusive maximum total value for the unusual activity.
|
| Name | Description | Type |
|---|---|---|
| trades | A list of unusual trades for a given company identifier | array |
|
symbol
|
The underlying option security symbol for the trade | string |
|
timestamp
|
The UTC timestamp of order placement | string |
|
type
|
The type of unusual trade | string |
|
total_value
|
The aggregated value of all option contract premiums included in the trade | number |
|
total_size
|
The total number of contracts involved in a single transaction | number |
|
average_price
|
The average premium paid per option contract | number |
|
contract
|
The option contract symbol | string |
|
ask_at_execution
|
Ask price at execution | number |
|
bid_at_execution
|
Bid price at execution | number |
|
sentiment
|
Bullish, Bearish, or Neutral Sentiment is estimated based on whether the trade was executed at the bid, ask, or mark price. | select |
|
underlying_price_at_execution
|
Price of the underlying security at execution of trade | number |
|
trades
A list of unusual trades for a given company identifier
|
