Skip to main content
GET
/
v1
/
market
/
tide
Bucketed market-wide net call premium / net put premium time series
curl --request GET \
  --url https://flow-api.skylit.ai/v1/market/tide \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "interval": "<string>",
    "bucket": "<string>",
    "bars": [
      {
        "timestamp": 123,
        "timestampEnd": 123,
        "ncp": 123,
        "npp": 123,
        "ncpCumulative": 123,
        "nppCumulative": 123,
        "manualNcp": 123,
        "manualNpp": 123,
        "manualNcpCumulative": 123,
        "manualNppCumulative": 123,
        "callVolume": 1,
        "putVolume": 1,
        "totalVolume": 1,
        "spyPrice": 123,
        "isGap": true
      }
    ]
  },
  "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

​
interval
enum<string>
default:1D

Trailing window length. Defaults to a single trading day (1D); multi-day intervals roll up history at the chosen bucket size.

Available options:
1D,
2D,
3D,
5D,
7D,
14D,
30D,
45D,
60D,
90D,
120D,
180D,
360D
​
bucket
enum<string>
default:1min

Bucket size for the time series.

Available options:
1min,
5min,
15min,
30min,
1d,
1w
​
date
string<date>

Trading date anchor (YYYY-MM-DD). Defaults to today.

​
excludeMultiLeg
boolean
default:false

Exclude multi-leg / spread trades from the directional totals.

Response

Market tide bars.

​
data
object
required
​
meta
object
required