---
title: "Flow Alerts"
method: GET
path: "/api/option-trades/flow-alerts"
---

# Flow Alerts

`GET /api/option-trades/flow-alerts`

## Request

- Base URL: `https://api.unusualwhales.com`
- URL: `https://api.unusualwhales.com/api/option-trades/flow-alerts`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/the-unnatural-group--llc/apis/tradesignals-api/docs/api/option-trades/flow-alerts/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the latest flow alerts.

## Response `200`

Successful response

- FlowAlertResponse
  - `data` FlowAlertEntry[]
    - `alert_rule` string: The name of the alert rule.
    - `all_opening_trades` boolean
    - `created_at` string, date-time: A UTC timestamp.
    - `expiry` string, date: The contract expiry date in ISO format.
    - `expiry_count` integer: The amount of expiries belonging to the trade. This is only greater than 1 if it is a multileg trade.
    - `has_floor` boolean
    - `has_multileg` boolean: Whether the trade is a multileg trade.
    - `has_singleleg` boolean: Whether the trade is a singleleg trade.
    - `has_sweep` boolean: Whether the trade is a sweep.
    - `open_interest` number, nullable
    - `option_chain` string: The option symbol of the contract.
    - `price` number: The fill price of the trade.
    - `strike` string: The contract strike.
    - `ticker` string: The stock ticker.
    - `total_ask_side_prem` number: The total ask-side premium.
    - `total_bid_side_prem` number: The total bid-side premium.
    - `total_premium` number: The total premium.
    - `total_size` integer: The total size.
    - `trade_count` integer: The number of trades.
    - `type` 'call' | 'put': The contract type.
    - `underlying_price` number: The price of the underlying asset.
    - `volume` integer: The trade volume.
    - `volume_oi_ratio` number: The volume to open interest ratio.

## Other responses

- `422`: Validation error
- `500`: Internal server error

---

[API](https://skmtc.dev/the-unnatural-group--llc/apis/tradesignals-api.md) - [All operations](https://skmtc.dev/the-unnatural-group--llc/apis/tradesignals-api/llms.txt) - [OpenAPI document](https://skmtc.dev/the-unnatural-group--llc/apis/tradesignals-api/revisions/0b37cadfb125?raw)