Skip to main content
GET
/
v1
/
sweeps
/
{ticker}
Aggregated multi-exchange sweep activity
curl --request GET \
  --url https://flow-api.skylit.ai/v1/sweeps/{ticker} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "ticker": "<string>",
    "sweeps": [
      {
        "timestamp": "2023-11-07T05:31:56Z",
        "strike": 123,
        "expiration": "2023-12-25",
        "dte": 1,
        "totalContracts": 2,
        "totalPremium": 123,
        "exchangeCount": 2,
        "exchanges": [
          "<string>"
        ],
        "executionTimeMs": 1,
        "scores": {
          "flowScore": 0,
          "flowBonus": 50
        }
      }
    ],
    "summary": {
      "totalSweeps": 1,
      "bullishSweeps": 1,
      "bearishSweeps": 1,
      "totalSweepPremium": 123,
      "sdf": 123,
      "returnedCount": 1
    }
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "d7574836"
  }
}

Authorizations

​
Authorization
string
header
required

Skylit API key in the Authorization header (Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.

Path Parameters

​
ticker
string
required

Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Example:

"SPY"

Query Parameters

​
timeframe
enum<string>
default:1h

Trailing window. Currently only restricts the trading day; the handler reads the full day's sweep partition. 5m/15m/1h/ 4h reserved for future intraday filtering.

Available options:
5m,
15m,
1h,
4h,
1d
​
minPremium
number<double>
​
optionType
enum<string>
default:all
Available options:
call,
put,
all
​
moneyness
enum<string>
default:all
Available options:
deep_itm,
itm,
atm,
otm,
deep_otm,
all
​
minDte
integer
Required range: x >= 0
​
maxDte
integer
Required range: x >= 0
​
minStrike
number<double>
​
maxStrike
number<double>
​
expiration
string<date>

Restrict to a single expiration date (YYYY-MM-DD).

​
limit
integer
default:100

Max sweep rows returned (server caps at 500).

Required range: 1 <= x <= 500
​
date
string<date>

Response

Sweep activity for {ticker}.

​
data
object
required
​
meta
object
required