Docs
Flowseeker/API Reference/Underlying

Prefix-search active tickers

GEThttps://flow-api.skylit.ai/v1/underlying/search

Case-insensitive prefix search over the active-tickers universe for the requested date. Use to power autocomplete UIs.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • qstringrequired

    Search prefix (1–10 characters, uppercased server-side).

  • limitintegerdefault 20min 1 · max 50
  • datestringdate

    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).

Responses

  • 200

    Matching tickers (capped at 50).

  • 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.

  • 429

    Per-minute rate limit exceeded.

Response fields

  • dataobject[]required
    • tickerstringrequired
    • totalPremiumnumberdoublerequired

      Total premium (USD) across all option trades on the day.

    • totalVolumeintegerrequired

      Total option contracts traded.

  • metaobjectrequired
    • timestampstringdate-timerequired

      Server-side timestamp the response was generated at.

    • requestIdstringrequired

      Short opaque ID for log correlation.

Last updated

Was this page helpful?