Docs
Flowseeker/API Reference/Dark Pool

Dark-pool totals by ticker and day

GEThttps://api.skylit.ai/v1/dark-pool/daily

Prints, shares, notional, $1M+ blocks and the largest print for each ticker, one row per ticker per day (group_by=day) or summed over the range (group_by=ticker). Without tickers it ranks every name. Defaults to today (ET); ranges up to 366 days.

Authorization

Authorization: Bearer <your API key>

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

Query parameters

  • datestringdate

    Single trade date (YYYY-MM-DD). Defaults to today (ET).

  • date_startstringdate

    Inclusive start of a range (YYYY-MM-DD). Max span 366 days.

  • date_endstringdate

    Inclusive end of a range (YYYY-MM-DD).

  • tickersstring

    Comma-separated tickers (max 50). Omit for all names.

  • sectorsstring

    Comma-separated GICS sectors to include.

  • industriesstring

    Comma-separated GICS industries to include.

  • min_notionalnumberdoubledefault 0min 0

    Minimum total notional per row (USD).

  • group_bystringdefault day

    day: a row per ticker per day. ticker: a row per ticker over the range.

    dayticker
  • sortstringdefault notional

    Sort key. date requires group_by=day.

    notionalsharesprintsblock_notionalblock_printslargest_printdate
  • orderstringdefault desc
    ascdesc
  • limitintegerdefault 500min 1 · max 5000
  • offsetintegerdefault 0min 0 · max 100000

Responses

  • 200

    Dark-pool totals for the requested filters.

  • 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
    • datestring | nulldaterequired

      Trade date; null with group_by=ticker.

    • tickerstringrequired
    • sectorstringrequired
    • industrystringrequired
    • printsintegerrequired
    • sharesintegerrequired
    • notionalnumberdoublerequired

      USD.

    • vwapnumberdoublerequired

      Notional-weighted average print price.

    • blockPrintsintegerrequired

      Prints of at least $1M.

    • blockNotionalnumberdoublerequired

      Notional of those prints (USD).

    • largestPrintnumberdoublerequired

      Largest single print (USD).

    • daysintegerrequired

      Days with prints in the row.

    • pctAvgVolnumber | nulldouble

      Average daily dark-pool shares as a percent of the ticker's average daily volume. null when no ADV is available.

  • metarequired

Last updated

Was this page helpful?