Skip to main content
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>'
{
  "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

​
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

​
date
string<date>

Date to evaluate (YYYY-MM-DD). Defaults to today.

Response

Today vs historical comparison.

​
data
object
required
​
meta
object
required