Today's flow vs trailing average (with similar-days lookback)
curl --request GET \
--url https://flow-api.skylit.ai/v1/flow/{ticker}/historical-compare \
--header 'Authorization: Bearer <token>'import requests
url = "https://flow-api.skylit.ai/v1/flow/{ticker}/historical-compare"
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/flow/{ticker}/historical-compare', 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/flow/{ticker}/historical-compare",
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/flow/{ticker}/historical-compare"
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/flow/{ticker}/historical-compare")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flow-api.skylit.ai/v1/flow/{ticker}/historical-compare")
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>",
"date": "2023-12-25",
"current": {
"totalPremium": 123,
"totalVolume": 1,
"callPremium": 123,
"putPremium": 123,
"netPremium": 123,
"callPutRatio": 123,
"callVolume": 1,
"putVolume": 1
},
"historical": {
"avgPremium": 123,
"avgVolume": 123,
"avgNetPremium": 123,
"avgCallPutRatio": 123,
"avgCallPremium": 123,
"avgPutPremium": 123,
"daysAnalyzed": 1
},
"vsAverage": {
"premiumVsAvg": 123,
"volumeVsAvg": 123,
"netPremiumVsAvg": 123
},
"percentileRankings": {
"premiumPercentile": 50,
"volumePercentile": 50,
"netPremiumPercentile": 50
},
"similarDays": [
{
"date": "2023-12-25",
"netPremium": 123,
"totalPremium": 123,
"similarityScore": 123
}
]
},
"meta": {
"timestamp": "2023-11-07T05:31:56Z",
"requestId": "d7574836"
}
}Flow
Today's flow vs trailing average (with similar-days lookback)
Compares the current trading day’s premium / volume / net premium / call-put ratio against the trailing 20-trading-day average for the same ticker. Returns absolute deltas, percentile rankings, and the five most-similar past trading days.
GET
/
v1
/
flow
/
{ticker}
/
historical-compare
Today's flow vs trailing average (with similar-days lookback)
curl --request GET \
--url https://flow-api.skylit.ai/v1/flow/{ticker}/historical-compare \
--header 'Authorization: Bearer <token>'import requests
url = "https://flow-api.skylit.ai/v1/flow/{ticker}/historical-compare"
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/flow/{ticker}/historical-compare', 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/flow/{ticker}/historical-compare",
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/flow/{ticker}/historical-compare"
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/flow/{ticker}/historical-compare")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flow-api.skylit.ai/v1/flow/{ticker}/historical-compare")
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>",
"date": "2023-12-25",
"current": {
"totalPremium": 123,
"totalVolume": 1,
"callPremium": 123,
"putPremium": 123,
"netPremium": 123,
"callPutRatio": 123,
"callVolume": 1,
"putVolume": 1
},
"historical": {
"avgPremium": 123,
"avgVolume": 123,
"avgNetPremium": 123,
"avgCallPutRatio": 123,
"avgCallPremium": 123,
"avgPutPremium": 123,
"daysAnalyzed": 1
},
"vsAverage": {
"premiumVsAvg": 123,
"volumeVsAvg": 123,
"netPremiumVsAvg": 123
},
"percentileRankings": {
"premiumPercentile": 50,
"volumePercentile": 50,
"netPremiumPercentile": 50
},
"similarDays": [
{
"date": "2023-12-25",
"netPremium": 123,
"totalPremium": 123,
"similarityScore": 123
}
]
},
"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).
Example:
"SPY"
Query Parameters
Date to evaluate (YYYY-MM-DD). Defaults to today.
Was this page helpful?
⌘I