Skip to main content
GET
/
v1
/
underlying
/
top
/
weekly
Top underlyings by trailing-5-day flow
curl --request GET \
  --url https://flow-api.skylit.ai/v1/underlying/top/weekly \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "ticker": "<string>",
      "totalPremium": 123,
      "totalVolume": 1,
      "callPremium": 123,
      "putPremium": 123,
      "callVolume": 1,
      "putVolume": 1,
      "netPremium": 123,
      "callPutRatio": 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

​
limit
integer
default:50

Maximum rows to return.

Required range: 1 <= x <= 200
​
date
string<date>

Trading date the request targets, in YYYY-MM-DD. Defaults to the current trading date (the most recent session that has settled enough data to be queryable). Past dates fall through to the daily rollup tables.

Example:

"2026-05-27"

​
minPremium
number<double>
Required range: x >= 0
​
minVolume
integer
Required range: x >= 0
​
orderBy
enum<string>
default:premium
Available options:
premium,
volume,
netPremium,
callPutRatio
​
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Top underlyings for the trailing week.

​
data
object[]
required
​
meta
object
required