Aggregated multi-exchange sweep activity

curl --request GET \
  --url https://flow-api.skylit.ai/v1/sweeps/{ticker} \
  --header 'Authorization: Bearer <token>'

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))

}

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",
        "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"
  }
}

GET

sweeps

{ticker}

Aggregated multi-exchange sweep activity

curl --request GET \
  --url https://flow-api.skylit.ai/v1/sweeps/{ticker} \
  --header 'Authorization: Bearer <token>'

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))

}

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",
        "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

min_premium

number<double>

option_type

enum<string>

default:all

Available options:

call,

put,

all

moneyness

enum<string>

default:all

Available options:

deep_itm,

itm,

atm,

otm,

deep_otm,

all

min_dte

integer

Required range: x >= 0

max_dte

integer

Required range: x >= 0

min_strike

number<double>

max_strike

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

Show child attributes

Flow

Sector

Market

Sweeps

Analytics

Scoring

Ratios

Underlying

Contract

Dark Pool

Meta

Aggregated multi-exchange sweep activity

Authorizations

Path Parameters

Query Parameters

Response