Docs
Flowseeker/API Reference/Scoring

Detailed scoring for a single trade

GEThttps://flow-api.skylit.ai/v1/score/{trade_id}

Returns sentiment, urgency, and confidence scores for an individual trade plus a spread-level breakdown and full trade context (ticker, strike, expiration, sweep/block flags, moneyness). Used to drill into a single row from /v1/flow/{ticker}.

The trade_id path parameter accepts three formats: the canonical flow_{hex}_{idx} id returned by the flow feed, a bare hex timestamp (188afe42c3a77af2), or a raw nanosecond integer.

Authorization

Authorization: Bearer <your API key>

Required. A missing header returns 401; an invalid, revoked or expired key returns 403.

Path parameters

  • trade_idstringrequired

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

Responses

  • 200

    Trade scoring breakdown.

  • 400

    Request validation failed.

  • 401

    Missing or invalid API key.

  • 402

    The account's shared Skylit credit balance is lower than this route's cost. Top up to continue. Carries X-Credits-Remaining: 0.

  • 403

    API key invalid, revoked or expired, or the account's API access is suspended (account_suspended).

  • 404

    Unknown resource (ticker / sector / window with no data).

  • 429

    Per-minute rate limit exceeded.

  • 503

    Underlying data source temporarily unavailable, or the credit balance could not be verified (credit_check_failed). Safe to retry.

Response fields

  • dataobjectrequired
    • tradeIdstringrequired
    • scoresobjectrequired
    • interpretationobjectrequired
    • spreadAnalysisobjectrequired
    • tradeContextobjectrequired
  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?