curl --request GET \
--url https://flow-api.skylit.ai/v1/sweeps/{ticker} \
--header 'Authorization: Bearer <token>'import requests
url = "https://flow-api.skylit.ai/v1/sweeps/{ticker}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://flow-api.skylit.ai/v1/sweeps/{ticker}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flow-api.skylit.ai/v1/sweeps/{ticker}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flow-api.skylit.ai/v1/sweeps/{ticker}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flow-api.skylit.ai/v1/sweeps/{ticker}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flow-api.skylit.ai/v1/sweeps/{ticker}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"ticker": "<string>",
"sweeps": [
{
"timestamp": "2023-11-07T05:31:56Z",
"optionType": "CALL",
"strike": 123,
"expiration": "2023-12-25",
"dte": 1,
"totalContracts": 2,
"totalPremium": 123,
"exchangeCount": 2,
"exchanges": [
"<string>"
],
"executionTimeMs": 1,
"spreadPosition": "AT_ASK",
"moneyness": "DEEP_ITM",
"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"
}
}Aggregated multi-exchange sweep activity
Returns “logical sweeps” — multi-exchange splits of one large order grouped by contract within a one-second execution window. Each row carries the venue list, total contracts/premium, spread position, moneyness bucket, and Skylit Flow Score / FlowBonus. The summary block adds population-level Sweep Dominance Factor (SDF) and bullish/bearish counts extrapolated from the full-day total.
curl --request GET \
--url https://flow-api.skylit.ai/v1/sweeps/{ticker} \
--header 'Authorization: Bearer <token>'import requests
url = "https://flow-api.skylit.ai/v1/sweeps/{ticker}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://flow-api.skylit.ai/v1/sweeps/{ticker}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://flow-api.skylit.ai/v1/sweeps/{ticker}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://flow-api.skylit.ai/v1/sweeps/{ticker}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://flow-api.skylit.ai/v1/sweeps/{ticker}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flow-api.skylit.ai/v1/sweeps/{ticker}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"ticker": "<string>",
"sweeps": [
{
"timestamp": "2023-11-07T05:31:56Z",
"optionType": "CALL",
"strike": 123,
"expiration": "2023-12-25",
"dte": 1,
"totalContracts": 2,
"totalPremium": 123,
"exchangeCount": 2,
"exchanges": [
"<string>"
],
"executionTimeMs": 1,
"spreadPosition": "AT_ASK",
"moneyness": "DEEP_ITM",
"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
Skylit API key in the Authorization header
(Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.
Path Parameters
Underlying ticker symbol (uppercase, e.g. SPY, AAPL).
"SPY"
Query Parameters
Trailing window. Currently only restricts the trading day;
5m/15m/1h/4h reserved for future intraday filtering.
5m, 15m, 1h, 4h, 1d call, put, all deep_itm, itm, atm, otm, deep_otm, all x >= 0x >= 0Restrict to a single expiration date (YYYY-MM-DD).
Max sweep rows returned (server caps at 500).
1 <= x <= 500Was this page helpful?

