Skip to main content
GET
/
v1
/
market
/
overview
Market-wide flow overview for the current trading day
curl --request GET \
  --url https://flow-api.skylit.ai/v1/market/overview \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "date": "2023-12-25",
    "totalPremium": 123,
    "totalVolume": 1,
    "callPremium": 123,
    "putPremium": 123,
    "netPremium": 123,
    "callVolume": 1,
    "putVolume": 1,
    "callPutRatio": 123,
    "activeTickers": 1,
    "bullishPremium": 123,
    "bearishPremium": 123,
    "directionalNet": 123,
    "fir": 123,
    "premiumRvol": 123,
    "topTickers": [
      {
        "ticker": "<string>",
        "totalPremium": 123,
        "totalVolume": 1,
        "callPremium": 123,
        "putPremium": 123,
        "netPremium": 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.

Query Parameters

​
tickers
string

Comma-separated list of tickers (e.g. AAPL,NVDA,SPY). When omitted, returns true market-wide stats over every ticker.

Example:

"AAPL,NVDA,SPY"

Response

Market-wide overview snapshot.

​
data
object
required
​
meta
object
required