Flowseeker/API Reference/Dark Pool

Dark-pool volume by price level

GEThttps://api.skylit.ai/v1/dark-pool/levels/{ticker}

Off-exchange shares and notional traded at each price bucket for {ticker} over a window, largest first. Levels where dark-pool volume concentrated are commonly read as support and resistance. Defaults to the last 30 calendar days and a bucket near 0.1% of the window's VWAP.

Authorization

Authorization: Bearer <your API key>

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

Path parameters

  • tickerstringrequired

    Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Query parameters

  • date_startstringdate

    Inclusive start date (YYYY-MM-DD). Replaces lookback_days. Max span 180 days.

  • date_endstringdate

    Inclusive end date (YYYY-MM-DD). Defaults to today (ET).

  • lookback_daysintegerdefault 30min 1 · max 180

    Calendar days back from date_end.

  • bucketnumberdoublemin 0.01

    Price bucket width in USD. Omit for automatic (a power of ten near 0.1% of VWAP).

  • sortstringdefault notional

    Ranking of the returned levels, largest first.

    notionalsharesprintsblock_notional
  • limitintegerdefault 50min 1 · max 500

Responses

  • 200

    Price levels for {ticker}, largest first.

  • 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

    Unknown, revoked or expired API key (the gateway's forbidden), the account's API access is suspended (account_suspended) or blocked (account_blocked). Not retryable.

  • 404

    Unknown ticker or contract (SYMBOL_NOT_FOUND), or no data for the requested window. Not charged.

  • 429

    Either the key exceeded its requests-per-minute limit (X-RateLimit-Limit; no Retry-After, wait until X-RateLimit-Reset), or the account is over one of the API's own limits, such as the query budget (queries running at once, fresh queries per second): TOO_MANY_CONCURRENT_QUERIES or RATE_LIMITED with Retry-After. Not charged; retry after the wait.

  • 500

    Unexpected server error (INTERNAL_ERROR, DATABASE_ERROR). Not charged; safe to retry with exponential backoff.

  • 503

    Underlying data source temporarily unavailable, the credit balance could not be verified (credit_check_failed), or the API is paused for maintenance (api_paused, with a Retry-After header and a retry_after field in seconds). Not charged; safe to retry.

  • 504

    The request did not complete within 25 seconds. Not charged; narrow the window or retry.

Response fields

  • dataobject[]required
    • pricenumberdoublerequired

      Lower edge of the bucket (USD).

    • printsintegerrequired
    • sharesintegerrequired
    • notionalnumberdoublerequired

      Notional printed in the bucket (USD).

    • pctOfNotionalnumberdoublerequired

      Percent of the window's total dark-pool notional.

    • blockPrintsintegerrequired

      Prints of at least $1M.

    • blockNotionalnumberdoublerequired

      Notional of those prints (USD).

  • metarequired

Last updated

Was this page helpful?