OptionWhales Darkpool API
The darkpool API from OptionWhales — 16 operation(s) for darkpool.
The darkpool API from OptionWhales — 16 operation(s) for darkpool.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/optionwhales-io:optionwhales-io-darkpool-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: OptionWhales Pro Darkpool API
description: Premium API for intent flow, momentum, abnormal trades, earnings intelligence, economic events, directional scores, GEX, dark pool, implied-volatility analytics, open interest, and an MCP server for AI agents
version: 1.2.0
tags:
- name: darkpool
paths:
/v1/darkpool/health:
get:
tags:
- darkpool
summary: Darkpool Health
description: Service health + session coverage (any tier — lets a key be smoke-tested).
operationId: darkpool_health_v1_darkpool_health_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/v1/darkpool/sessions:
get:
tags:
- darkpool
summary: Darkpool Sessions
description: All available dark-pool sessions (dates).
operationId: darkpool_sessions_v1_darkpool_sessions_get
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
/v1/darkpool/blocks:
get:
tags:
- darkpool
summary: Darkpool Blocks
description: 'Detected off-exchange BLOCKS (>= max($1M, rolling P99.5) per ticker) with %ADV,
post-print impact (bps) and the options-confirmation read. ``outside_nbbo`` flags a print
reported beyond the quote, ``away_from_quote`` one priced away from it (more than 0.1 %
and 2 cents outside); null = quote unknown.'
operationId: darkpool_blocks_v1_darkpool_blocks_get
parameters:
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: YYYY-MM-DD; default latest
title: Date
description: YYYY-MM-DD; default latest
- name: ticker
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: filter, CSV ok
title: Ticker
description: filter, CSV ok
- name: nbbo_label
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Nbbo Label
- name: min_premium
in: query
required: false
schema:
type: number
minimum: 0.0
default: 0.0
title: Min Premium
- name: min_size
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Min Size
- name: limit
in: query
required: false
schema:
type: integer
maximum: 5000
minimum: 1
default: 500
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/ranking:
get:
tags:
- darkpool
summary: Darkpool Ranking
description: Whole-market off-exchange share + per-ticker notional ranking.
operationId: darkpool_ranking_v1_darkpool_ranking_get
parameters:
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
- name: limit
in: query
required: false
schema:
type: integer
maximum: 1000
minimum: 1
default: 500
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/alerts:
get:
tags:
- darkpool
summary: Darkpool Alerts
description: Large off-exchange blocks with DIRECTIONAL options confirmation, by severity.
operationId: darkpool_alerts_v1_darkpool_alerts_get
parameters:
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
- name: ticker
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Ticker
- name: limit
in: query
required: false
schema:
type: integer
maximum: 1000
minimum: 1
default: 50
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/pressure:
get:
tags:
- darkpool
summary: Darkpool Pressure
description: 'Market + per-ticker NBBO-location pressure windows (buy/sell/net/ratio).
``market_windows_ex_away`` and each ticker''s ``darkpool_windows_ex_away`` are the same
windows with prints away from the quote left out; each window adds ``away_notional`` and
``away_n`` (what was left out). null for a session built before the adjustment.'
operationId: darkpool_pressure_v1_darkpool_pressure_get
parameters:
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
- name: window
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: 1m|5m|15m|30m|1h|day
title: Window
description: 1m|5m|15m|30m|1h|day
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/pressure/{ticker}:
get:
tags:
- darkpool
summary: Darkpool Pressure Ticker
description: 'One ticker''s pressure windows + the cumulative intraday curve
(price vs cumulative dark-pool pressure vs cumulative option intent).
``darkpool_windows_ex_away`` / ``curve.dp_cum_ex_away``: the same with prints away from the
quote left out (null / absent for a session built before the adjustment).'
operationId: darkpool_pressure_ticker_v1_darkpool_pressure__ticker__get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
- name: window
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Window
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/ticker/{ticker}:
get:
tags:
- darkpool
summary: Darkpool Ticker
description: 'Per-ticker session detail: off-exchange summary, rolling baseline (P95/P99/P99.5),
ADV, NBBO-location split and that ticker''s blocks.'
operationId: darkpool_ticker_v1_darkpool_ticker__ticker__get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/time-profile/{ticker}:
get:
tags:
- darkpool
summary: Darkpool Time Profile
description: 'WHEN one ticker''s off-exchange volume traded, by price, for one session: a sparse
5-minute × price grid of shares, per-row and per-bucket totals, the POC and 70 % value
area, and the largest block prints at their report time. A session still being built
answers 503 with ``Retry-After``.
``cells_side`` = flat [buy, sell, away] share triples in ``cells`` order: buy pressure =
shares at the ask + 60 % of those near it, sell = at the bid + 60 % near it, away = more
than 0.1 % (and 2 cents) outside the quote, left out of pressure; the rest of a cell is
neutral. ``totals`` adds ``buy_volume`` / ``sell_volume`` / ``away_volume``. Absent when
the profile was built without quotes.'
operationId: darkpool_time_profile_v1_darkpool_time_profile__ticker__get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: YYYY-MM-DD; default latest
title: Date
description: YYYY-MM-DD; default latest
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/prints/{ticker}:
get:
tags:
- darkpool
summary: Darkpool Prints
description: 'Raw off-exchange (TRF) prints for one ticker+date — individual trades with NBBO
context (standard per-key rate limits apply). Page with ``older_than``/``newer_than``
time cursors (UTC, YYYY-MM-DDTHH:MM:SS).'
operationId: darkpool_prints_v1_darkpool_prints__ticker__get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
- name: newer_than
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Newer Than
- name: older_than
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Older Than
- name: min_premium
in: query
required: false
schema:
type: number
minimum: 0.0
default: 0.0
title: Min Premium
- name: max_premium
in: query
required: false
schema:
anyOf:
- type: number
minimum: 0.0
- type: 'null'
title: Max Premium
- name: min_size
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Min Size
- name: max_size
in: query
required: false
schema:
anyOf:
- type: integer
minimum: 0
- type: 'null'
title: Max Size
- name: nbbo_label
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Nbbo Label
- name: order
in: query
required: false
schema:
type: string
pattern: ^(asc|desc)$
default: desc
title: Order
- name: order_by
in: query
required: false
schema:
type: string
pattern: ^(executed_at|premium|size|price)$
default: executed_at
title: Order By
- name: limit
in: query
required: false
schema:
type: integer
maximum: 500
minimum: 1
default: 500
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/recent:
get:
tags:
- darkpool
summary: Darkpool Recent
description: 'Recent NOTABLE off-exchange prints market-wide. Explicitly block-gated (the
detected-block tape, not the full raw market tape) — see ``data.feed``.'
operationId: darkpool_recent_v1_darkpool_recent_get
parameters:
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
- name: ticker
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Ticker
- name: min_premium
in: query
required: false
schema:
type: number
minimum: 0.0
default: 0.0
title: Min Premium
- name: min_size
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Min Size
- name: nbbo_label
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Nbbo Label
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/sectors:
get:
tags:
- darkpool
summary: Darkpool Sectors
description: 'Per-SPDR-sector off-exchange aggregate for one session (heatmap): notional, share,
net NBBO-location pressure and top names per sector. Coverage is the calibrated liquid
universe intersected with each sector — NOT full sector constituents. Each sector also
carries its pressure with prints away from the quote left out (``*_ex_away`` +
``away_notional``; null for a session built before the adjustment).'
operationId: darkpool_sectors_v1_darkpool_sectors_get
parameters:
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: YYYY-MM-DD; default latest
title: Date
description: YYYY-MM-DD; default latest
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/sector/{key}:
get:
tags:
- darkpool
summary: Darkpool Sector Composition
description: 'One SPDR sector''s constituent equities + alignment metrics: each ticker''s off-exchange
$, share of sector, net lean and intensity, plus concentration (top-1/top-3 share) and
direction-agreement (how unanimous the sector''s flow is). The ``*_ex_away`` keys (sector
and per ticker) repeat the lean with prints away from the quote left out; null for a
session built before the adjustment.'
operationId: darkpool_sector_composition_v1_darkpool_sector__key__get
parameters:
- name: key
in: path
required: true
schema:
type: string
title: Key
- name: date
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Date
- name: limit
in: query
required: false
schema:
type: integer
maximum: 300
minimum: 1
default: 60
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/sector_rotation:
get:
tags:
- darkpool
summary: Darkpool Sector Rotation
description: 'Per-(sector, session) rotation matrix over the last ``display`` sessions — each cell is
that session''s sector DP-$ vs its trailing 20-day average — plus a one-line rotation
summary and the most-elevated sector.'
operationId: darkpool_sector_rotation_v1_darkpool_sector_rotation_get
parameters:
- name: days
in: query
required: false
schema:
type: integer
maximum: 120
minimum: 3
default: 25
title: Days
- name: display
in: query
required: false
schema:
type: integer
maximum: 20
minimum: 2
default: 5
title: Display
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/daily-candles/{ticker}:
get:
tags:
- darkpool
summary: Darkpool Daily Candles
description: 'Daily OHLC candles for the last N calendar days (pairs with ``/print-levels`` for
the 30-day cost-basis chart).'
operationId: darkpool_daily_candles_v1_darkpool_daily_candles__ticker__get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: days
in: query
required: false
schema:
type: integer
maximum: 180
minimum: 2
default: 30
title: Days
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/darkpool/print-levels/{ticker}:
get:
tags:
- darkpool
summary: Darkpool Print Levels
description: 'Top-N off-exchange price LEVELS (print clusters ≈ institutional cost basis) over the
last N sessions — the horizontal dashed lines on the 30-day chart.'
operationId: darkpool_print_levels_v1_darkpool_print_levels__ticker__get
parameters:
- name: ticker
in: path
required: true
schema:
type: string
title: Ticker
- name: days
in: query
required: false
schema:
type: integer
maximum: 120
minimum: 1
default: 30
title: Days
- name: top
in: query
required: false
schema:
type: integer
maximum: 30
minimum: 1
default: 10
title: Top
- name: band_pct
in: query
required: false
schema:
type: number
maximum: 5.0
minimum: 0.05
default: 0.5
title: Band Pct
- name: min_premium
in: query
required: false
schema:
type: number
minimum: 0.0
default: 0.0
title: Min Premium
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError