OptionWhales Absorption API

The absorption API from OptionWhales — 5 operation(s) for absorption.

GitHub OpenAPI

Operations 5

GET /v1/absorption/health Absorption Health #
GET /v1/absorption/market Absorption Market #
GET /v1/absorption/events Absorption Events #
GET /v1/absorption/history/{ticker} Absorption History #
GET /v1/absorption/flow-series/{ticker} Absorption Flow Series #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/optionwhales-io:optionwhales-io-absorption-api"
All apis
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.

Get an API 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 Specification

optionwhales-io-absorption-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: OptionWhales Pro Absorption 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: absorption
paths:
  /v1/absorption/health:
    get:
      tags:
      - absorption
      summary: Absorption Health
      description: 'Coverage + basis for a session. Any tier, free, never 429''d.


        Deliberately cheap upstream (one manifest read, no cross-section), so a key can

        be smoke-tested and an incident can be diagnosed without spending budget. ``ok``

        answers "can this session be served at all", NOT "is it complete" - completeness

        is a spectrum and lives in ``coverage``, where it cannot be collapsed into a

        green light. On 2026-07-06 a subscription reset left the census covering 4

        tickers of ~439 and every response still looked healthy.'
      operationId: absorption_health_v1_absorption_health_get
      parameters:
      - name: date
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: YYYY-MM-DD
          title: Date
        description: YYYY-MM-DD
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/absorption/market:
    get:
      tags:
      - absorption
      summary: Absorption Market
      description: 'Whole-market absorption cross-section + breadth.


        One row per ticker. ``row_semantics`` says WHICH event that row is: the day''s

        PEAK on a settled session, the LATEST event on the live one. Same route,

        different meaning, so it is declared rather than inferred.


        ``include_events`` attaches each row''s recent events in the same request, with

        ``events_basis`` naming where they came from - the cross-section prefers the

        complete census while recent events only exist in the capped live stream, and

        those are two different bases.


        Charges ONE row, not one per ticker: it is a single cross-section read upstream.


        ``limit`` is clamped to the tier cap rather than rejected, and ``matched`` reports

        the pre-truncation total so the clamp is visible instead of silent.'
      operationId: absorption_market_v1_absorption_market_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: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Rows returned
          default: 200
          title: Limit
        description: Rows returned
      - name: include_events
        in: query
        required: false
        schema:
          type: boolean
          description: Attach recent events per row
          default: false
          title: Include Events
        description: Attach recent events per row
      - name: events_limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 5
          title: Events Limit
      - name: tradeable_only
        in: query
        required: false
        schema:
          type: boolean
          description: DROP context + Q3/Q4 only
          default: false
          title: Tradeable Only
        description: DROP context + Q3/Q4 only
      - name: min_pctile
        in: query
        required: false
        schema:
          anyOf:
          - type: number
            maximum: 100
            minimum: 0
          - type: 'null'
          description: Minimum l3_pctile_today
          title: Min Pctile
        description: Minimum l3_pctile_today
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/absorption/events:
    get:
      tags:
      - absorption
      summary: Absorption Events
      description: 'Absorption events for up to 25 tickers in ONE request.


        This shape exists because the request budget, not the rate limit, is what binds

        a polling consumer - see the module docstring''s worked example. Each event

        carries ``provisional`` (detected on the live expanding-percentile path, so not

        calibrated) and ``pre_q`` (the pre-event state''s quartile label).'
      operationId: absorption_events_v1_absorption_events_get
      parameters:
      - name: tickers
        in: query
        required: true
        schema:
          type: string
          description: Comma-separated, max 25
          title: Tickers
        description: Comma-separated, max 25
      - 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: events_limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 200
            minimum: 1
          - type: 'null'
          description: Newest N per ticker
          title: Events Limit
        description: Newest N per ticker
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/absorption/history/{ticker}:
    get:
      tags:
      - absorption
      summary: Absorption History
      description: 'Per-day net absorption direction over the last N sessions.


        ``fwd5_bps`` is RAW LONG forward P&L and is deliberately NOT signed by the

        absorption side; signing it would turn sell-absorption losses into apparent

        wins. A ``days`` above the tier cap is a 403, never a silent truncation - a

        caller who asked for 90 and got 30 without being told would compute a different

        statistic than they think.'
      operationId: absorption_history_v1_absorption_history__ticker__get
      parameters:
      - name: ticker
        in: path
        required: true
        schema:
          type: string
          title: Ticker
      - name: days
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Trailing sessions
          default: 20
          title: Days
        description: Trailing sessions
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/absorption/flow-series/{ticker}:
    get:
      tags:
      - absorption
      summary: Absorption Flow Series
      description: 'The 1-second signed-dollar / L3 / L2 line for one ticker-session.


        ``bar_signed_dollar_1s`` is ONE 1-second bar''s signed dollars - not session

        volume, and not comparable across the live and settled paths, which derive it

        differently. The upstream name was ``vol``, which all but invited the wrong sum.'
      operationId: absorption_flow_series_v1_absorption_flow_series__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
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 5000
          minimum: 1
          default: 900
          title: Limit
      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