Skip to main content
GET
/
v1
/
score
/
{tradeId}
Detailed scoring for a single trade
curl --request GET \
  --url https://flow-api.skylit.ai/v1/score/{tradeId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "tradeId": "flow_188afe42c3a77af2_0",
    "scores": {
      "sentiment": 0,
      "urgency": 50,
      "confidence": 0.5
    },
    "interpretation": {
      "intent": "<string>",
      "description": "<string>"
    },
    "spreadAnalysis": {
      "bid": 123,
      "ask": 123,
      "mid": 123,
      "tradePrice": 123,
      "spreadWidth": 123,
      "spreadPct": 123
    },
    "tradeContext": {
      "ticker": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "strike": 123,
      "expiration": "2023-12-25",
      "premium": 123,
      "size": 2,
      "underlyingPrice": 123,
      "dte": 1,
      "moneynessPct": 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

​
tradeId
string
required

Trade id (flow_{hex}_{idx}, bare hex timestamp, or raw nanos).

Example:

"flow_188afe42c3a77af2_0"

Response

Trade scoring breakdown.

​
data
object
required
​
meta
object
required