> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alphractal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Order Flow Summary (Retail, Mid, Whale)

> Taker flow on perpetual swaps grouped by market order size, in USD: retail (under 10k), mid (10k to 1M) and whale (1M and above). Every exchange is summed. Each bucket classifies the whole market order (fills of the same side in the same millisecond), not each fill. The series starts on 2026-09-17; earlier dates return an empty array. 1m keeps 90 days. Without startDate, 1m returns the 7 days before the asset's last minute with data (at or before endDate, when it is given); 5m to 4h return their newest bars (5m 90 days, 15m 180 days, 30m 1 year, 1h 2 years, 4h 4 years); 6h, 12h and 1d return the whole series. A 1m window longer than 7 days, counted to endDate or to now without one, is rejected with 400; request consecutive windows instead.



## OpenAPI

````yaml /api-reference/openapi.json get /{asset}/derivatives/Orderflow_summary
openapi: 3.1.1
info:
  title: Alphractal API
  version: 0.3.0
  description: >-
    Alphractal API provides comprehensive cryptocurrency on-chain data including
    mining metrics, address analytics, block information, fee data, market
    indicators, supply metrics, exchange flows, and more.
servers:
  - url: https://api.alphractal.com
    description: Production server
security:
  - ApiKeyAuth: []
paths:
  /{asset}/derivatives/Orderflow_summary:
    get:
      tags:
        - Derivatives
      summary: Order Flow Summary (Retail, Mid, Whale)
      description: >-
        Taker flow on perpetual swaps grouped by market order size, in USD:
        retail (under 10k), mid (10k to 1M) and whale (1M and above). Every
        exchange is summed. Each bucket classifies the whole market order (fills
        of the same side in the same millisecond), not each fill. The series
        starts on 2026-09-17; earlier dates return an empty array. 1m keeps 90
        days. Without startDate, 1m returns the 7 days before the asset's last
        minute with data (at or before endDate, when it is given); 5m to 4h
        return their newest bars (5m 90 days, 15m 180 days, 30m 1 year, 1h 2
        years, 4h 4 years); 6h, 12h and 1d return the whole series. A 1m window
        longer than 7 days, counted to endDate or to now without one, is
        rejected with 400; request consecutive windows instead.
      parameters:
        - name: asset
          in: path
          required: true
          schema:
            type:
              - string
              - 'null'
            enum:
              - 0g
              - 1inch
              - 2z
              - a
              - aave
              - ace
              - ada
              - aero
              - aioz
              - akt
              - alch
              - algo
              - ape
              - apt
              - ar
              - arb
              - aster
              - ath
              - atom
              - avax
              - awe
              - axs
              - b
              - banana
              - bard
              - bat
              - bch
              - beam
              - bnb
              - bonk
              - brett
              - bsv
              - btc
              - btt
              - cake
              - cc
              - cfg
              - cfx
              - cheems
              - chz
              - ckb
              - comp
              - core
              - cow
              - cro
              - crv
              - ctc
              - cvx
              - cys
              - dash
              - deep
              - dexe
              - dog
              - doge
              - dot
              - dydx
              - egld
              - ena
              - ens
              - etc
              - eth
              - ethfi
              - fartcoin
              - fet
              - ff
              - fil
              - floki
              - flr
              - fluid
              - form
              - frax
              - g
              - gala
              - gas
              - glm
              - gmx
              - gno
              - grass
              - grt
              - gwei
              - h
              - hbar
              - hnt
              - home
              - hot
              - hype
              - icnt
              - icp
              - imx
              - inch
              - inj
              - iota
              - ip
              - jasmy
              - jst
              - jto
              - jup
              - kaia
              - kaito
              - kas
              - kite
              - la
              - ldo
              - link
              - lit
              - lpt
              - ltc
              - lunc
              - m
              - mana
              - mantra
              - met
              - mina
              - mnt
              - mon
              - morpho
              - move
              - near
              - neo
              - night
              - okb
              - ondo
              - op
              - paxg
              - pendle
              - pengu
              - pepe
              - pieverse
              - pippin
              - pol
              - pump
              - pyth
              - qnt
              - qtum
              - qubic
              - render
              - river
              - rose
              - rsr
              - rune
              - rvn
              - s
              - safe
              - sand
              - sei
              - sent
              - sfp
              - shib
              - siren
              - skr
              - sky
              - snx
              - sol
              - spx
              - stable
              - stg
              - strk
              - stx
              - sui
              - sun
              - syrup
              - t
              - tag
              - tao
              - theta
              - tia
              - ton
              - toshi
              - tria
              - trump
              - trx
              - turbo
              - twt
              - uai
              - ub
              - uni
              - velo
              - vet
              - virtual
              - vvv
              - w
              - wal
              - wif
              - wld
              - wlfi
              - xaut
              - xcn
              - xdc
              - xec
              - xlm
              - xmr
              - xpl
              - xrp
              - xtz
              - xvg
              - yfi
              - yzy
              - z
              - zec
              - zen
              - zil
              - zk
              - zro
              - zrx
          description: >-
            Asset identifier, lowercase ticker. The list is the assets that
            carry this metric — an asset outside it has no data here.
          example: btc
        - name: timeframe
          in: query
          schema:
            type:
              - string
              - 'null'
            enum:
              - 1m
              - 5m
              - 15m
              - 30m
              - 1h
              - 4h
              - 6h
              - 12h
              - 1d
            default: 1d
          description: >-
            Aggregation bucket. Values outside the accepted list fall back to
            the daily series instead of returning an error.
          example: 1h
        - name: startDate
          in: query
          schema:
            type:
              - string
              - 'null'
            format: date-time
          description: >-
            Start of the window (UTC, inclusive). Without it, 1m returns the 7
            days before the asset's last minute with data; 5m to 4h return their
            newest bars (5m 90 days, 15m 180 days, 30m 1 year, 1h 2 years, 4h 4
            years); 6h, 12h and 1d return the whole series, which starts on
            2026-09-17. A 1m window longer than 7 days is rejected with 400;
            request consecutive windows instead.
        - name: endDate
          in: query
          schema:
            type:
              - string
              - 'null'
            format: date-time
          description: >-
            End of the window (UTC, inclusive). With 1m and no startDate, the
            answer is the 7 days before the last minute with data at or before
            this date.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrderflowSummaryResponse'
        '400':
          description: Bad Request - a 1m window longer than 7 days
components:
  schemas:
    OrderflowSummaryResponse:
      description: >-
        One row per bar: USD volume of taker buy and sell market orders, grouped
        as retail (under 10k USD), mid (10k to 1M USD) and whale (1M USD and
        above).
      type: object
      properties:
        time:
          type: string
          format: date-time
        retail_buy_usd:
          type: number
          format: double
        retail_sell_usd:
          type: number
          format: double
        mid_buy_usd:
          type: number
          format: double
        mid_sell_usd:
          type: number
          format: double
        whale_buy_usd:
          type: number
          format: double
        whale_sell_usd:
          type: number
          format: double
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key authentication. Include your API key in the X-Api-Key header for
        all requests.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.