---
title: "Retrieve Flow Data"
method: GET
path: "/api/option-contract/{id}/flow"
---

# Retrieve Flow Data

`GET /api/option-contract/{id}/flow`

Returns the latest flows for the given option chain, with optional filtering by min premium or side.

## Path parameters

- `id` string, required

## Query parameters

- `date` string, date
- `limit` integer
- `min_premium` integer
- `side` 'ALL' | 'ASK' | 'BID' | 'MID'

## Response `200`

Successful response with flow data.

- FlowDataResponse
  - `data` FlowDataEntry[]
    - `id` string — The ID of the option trade.
    - `executed_at` string, date-time — The time the option trade was executed.
    - `price` string — The fill price of the option trade.
    - `premium` string — The premium of the option trade.
    - `delta` string — Delta value for the option trade.
    - `implied_volatility` string — Implied volatility of the option trade.
    - `nbbo_ask` string — National Best Bid and Offer (NBBO) ask price.
    - `nbbo_bid` string — National Best Bid and Offer (NBBO) bid price.
    - `open_interest` integer — The open interest for the contract.
    - `volume` integer — The number of contracts traded till this point.
    - `underlying_symbol` string — The underlying symbol of the contract.
    - `option_type` 'call' | 'put' — The option type of the contract.
    - `expiry` string, date — The contract expiry date.
    - `strike` string — The contract strike price.
    - `sector` string — The financial sector of the ticker.
    - `size` integer — The size of the option trade.
    - `tags` string[] — Tags related to the trade.
    - `upstream_condition_detail` string — The upstream condition detail/trade code.

## Other responses

- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/the-unnatural-group--llc/apis/tradesignals-api.md) · [All operations](https://skmtc.net/the-unnatural-group--llc/apis/tradesignals-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/the-unnatural-group--llc/tradesignals-api/revisions/0b37cadfb125/schema)