Skip to main content
GET
/
v1
/
chain-bull-bear
/
{ticker}
Chain-level call/put-aware bull/bear pressure
curl --request GET \
  --url https://flow-api.skylit.ai/v1/chain-bull-bear/{ticker} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "ticker": "<string>",
    "date": "2023-12-25",
    "timeframe": "<string>",
    "tradeCount": 1,
    "totalVolume": 1,
    "totalPremium": 123,
    "metrics": {
      "bullPct": 123,
      "bearPct": 123,
      "neutralPct": 123,
      "bullBearRatio": 123,
      "callBullPct": 123,
      "putBullPct": 123
    },
    "interpretation": {
      "description": "<string>"
    }
  },
  "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>
​
timeframe
enum<string>
default:1d
Available options:
5m,
15m,
1h,
4h,
1d
​
optionType
enum<string>
default:all
Available options:
call,
put,
all
​
minPremium
integer
Required range: x >= 0
​
minDte
integer
Required range: x >= 0
​
maxDte
integer
Required range: x >= 0

Response

Chain-level bull/bear analysis.

​
data
object
required
​
meta
object
required