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

# TP/SL trigger book

> Aggregated book of the **resting trigger orders** (take profit, stop loss and other trigger orders) of every user on one coin, grouped by trigger price and side. No addresses are returned: each level gives the summed size and the number of orders.

- `isPositionTpsl: true` marks TP/SL attached to a whole position; such levels show `totalSz` `0`.
- Levels are sorted by `triggerPx`, highest first.
- The response can be large (hundreds of KB on a major coin) and slow (from a few seconds to tens of seconds on BTC). Keep `lookbackDays` small. A request that runs longer than about 30 seconds comes back as `400 {"error": "Unknown type: <type>"}`: the type exists, the request timed out. Retry with a narrower window or a smaller `limit`.



## OpenAPI

````yaml /live-data/openapi-rest.json post /info#tpslBook
openapi: 3.0.3
info:
  title: 'Hypedexer API: Live Data (REST)'
  version: 0.1.0
  description: >-
    REST API for real-time Hyperliquid market data served from our own
    Hyperliquid nodes.


    All data is accessed through a single unified endpoint `POST /info` that
    dispatches based on the `type` field in the JSON body.


    ## Request types


    | Type | Description | Handled |

    |------|-------------|----------|

    | `metaAndAssetCtxs` | Asset context (funding, OI, prices) | Locally (Redis
    cache) |

    | `allMids` | Mid prices for all coins | Locally (Redis cache) |

    | `userFills` / `userFillsByTime` | Fills for a specific user | Locally
    (volume files) |

    | `allFills` | All fills globally | Locally (volume files) |

    | `trades` | Trade data | Locally (volume files) |

    | `l2Book` / `l2Books` | L2 order book snapshot | Locally |

    | `availableDates` | Available data dates | Locally |

    | `clearinghouseState` | Clearinghouse state, one user (`user`) or many in
    one call (`users`), per dex with `dex` | Locally with upstream proxy per
    user |

    | `openInterestHistory` | Open interest history of a market (~30 s samples,
    with mark price, 24h volume, funding, premium) | Indexed history |

    | `userFunding` / `accountFunding` | Funding payments of a user | Indexed
    history, returned unwrapped |

    | `userNonFundingLedgerUpdates` | Native ledger of a user: deposits,
    withdrawals, transfers, vaults, staking, borrow/lend | Indexed history,
    returned unwrapped |

    | `historicalOrders` | Latest orders of a user with their status | Indexed
    history, returned unwrapped |

    | `userTwapSliceFills` | Fills of a user's TWAP orders with their parent |
    Indexed history, returned unwrapped |

    | `fills` / `recentFills` | Indexed fills with filters (compact shape) |
    Indexed history, returned unwrapped; paging in `X-Has-More` /
    `X-Next-Cursor` headers |

    | `builderFills` / `builderFillsByTime` / `builderOrdersByTime` | Every fill
    or order routed through one builder code | Indexed history |

    | `tpslBook` | Aggregated resting TP/SL trigger orders of a coin, by price |
    Indexed history |

    | `oraclePriceHistory` / `slippageHistory` / `marketLiquidityHistory` |
    Per-market series (~30 to 60 s samples, about 7 days) | Indexed history |

    | `stakingOverview` / `validatorAprHistory` / `globalStakingSummary` |
    Validator snapshots and network staking figures | Indexed history |

    | `liqHistory` | Liquidation events, cursor paging in headers | Indexed
    history |

    | `userTwapStatusesByTime` / `userTwapSummaries` | Status and latest state
    of a user's TWAP orders | Indexed history |

    | `dataCoverage` | Start and latest timestamp per dataset | Indexed history
    |

    | `borrowLendReserveHistory` | Borrow/lend reserve history, one sample per
    minute | Indexed history, returned unwrapped |

    | `meta`, `spotMeta`, `openOrders`, ... | Proxied to local Hyperliquid node
    | Proxied to upstream |


    ## Authentication


    Required. Send your key in the `X-API-Key` header or as `Authorization:
    Bearer <key>`. A request without a valid key returns `401`.


    ## Response format


    Most types return:

    ```json

    { "result": <data>, "cursor": null }

    ```


    `allMids` returns the result directly (not wrapped):

    ```json

    { "BTC": "66764.5", "ETH": "3421.2" }

    ```


    Proxied types return the upstream response as-is.
  contact:
    name: Hypedexer
servers:
  - url: https://api.hypedexer.com
    description: Production, routed to the nearest region (EU or JP)
security:
  - BearerAuth: []
tags:
  - name: Health
    description: Service health and info.
  - name: Asset Context
    description: >-
      Real-time asset context data: funding, open interest, oracle/mark/mid
      prices, volumes.
  - name: Mid Prices
    description: Mid prices for all coins, optionally filtered by DEX.
  - name: Fills
    description: >-
      Executed fills from the Hyperliquid fullnode volumes. Supports
      user-specific and global queries.
  - name: Trades
    description: Trade data from the fullnode volumes.
  - name: Order Book
    description: L2 order book snapshots.
  - name: Metadata
    description: Volume availability and data metadata.
  - name: Clearinghouse
    description: >-
      Clearinghouse state with multi-user support. Each user is fetched
      individually from the upstream Hyperliquid node.
  - name: Proxied Perpetuals
    description: >-
      Perpetual market metadata, margin, OI caps, DEX configs. Proxied to
      upstream Hyperliquid node.
  - name: Proxied Spot
    description: >-
      Spot market metadata, balances, and deploy state. Proxied to upstream
      Hyperliquid node.
  - name: Proxied Trading
    description: >-
      Orders, positions, and active asset data. Proxied to upstream Hyperliquid
      node.
  - name: Proxied Account
    description: >-
      User account info: fees, rate limits, sub-accounts, agents, roles. Proxied
      to upstream Hyperliquid node.
  - name: Proxied Vaults
    description: >-
      Vault summaries, equities, and leaderboards. Proxied to upstream
      Hyperliquid node.
  - name: Proxied Staking
    description: >-
      Delegations, staking summaries, and validator votes. Proxied to upstream
      Hyperliquid node.
  - name: Proxied Exchange
    description: >-
      Exchange status, liquidatable positions, web data. Proxied to upstream
      Hyperliquid node.
  - name: Account History
    description: >-
      Per-address history served from our index, in Hyperliquid's `info` shapes:
      funding payments, native ledger and orders.
  - name: Borrow/Lend
    description: >-
      History of Hyperliquid's borrow/lend reserves, sampled every minute from
      our own node.
  - name: Builders
    description: >-
      Builder-wide feeds: every fill and order routed through one builder code,
      whatever the user.
  - name: Market History
    description: >-
      Per-market series sampled from our own node every 30 to 60 seconds, kept
      about 7 days: open interest, oracle prices, slippage, liquidity.
  - name: Staking
    description: Validator snapshots and network staking figures from our own node.
  - name: Liquidations
    description: Indexed liquidation events with cursor paging.
  - name: Coverage
    description: >-
      What the index holds: per-dataset start and latest timestamp in the region
      answering.
paths:
  /info#tpslBook:
    post:
      tags:
        - Order Book
      summary: TP/SL trigger book
      description: >-
        Aggregated book of the **resting trigger orders** (take profit, stop
        loss and other trigger orders) of every user on one coin, grouped by
        trigger price and side. No addresses are returned: each level gives the
        summed size and the number of orders.


        - `isPositionTpsl: true` marks TP/SL attached to a whole position; such
        levels show `totalSz` `0`.

        - Levels are sorted by `triggerPx`, highest first.

        - The response can be large (hundreds of KB on a major coin) and slow
        (from a few seconds to tens of seconds on BTC). Keep `lookbackDays`
        small. A request that runs longer than about 30 seconds comes back as
        `400 {"error": "Unknown type: <type>"}`: the type exists, the request
        timed out. Retry with a narrower window or a smaller `limit`.
      operationId: tpslBook
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - type
                - coin
              properties:
                type:
                  type: string
                  enum:
                    - tpslBook
                coin:
                  type: string
                  description: Coin, e.g. `BTC`
                lookbackDays:
                  type: integer
                  minimum: 1
                  maximum: 365
                  default: 90
                  description: How many days of trigger orders to take into account
            example:
              type: tpslBook
              coin: ETH
              lookbackDays: 1
      responses:
        '200':
          description: Trigger levels for the coin
          content:
            application/json:
              schema:
                type: object
                properties:
                  coin:
                    type: string
                  levels:
                    type: array
                    items:
                      type: object
                      properties:
                        side:
                          type: string
                          enum:
                            - A
                            - B
                        triggerCondition:
                          type: string
                        triggerPx:
                          type: string
                        isPositionTpsl:
                          type: boolean
                        totalSz:
                          type: string
                        nOrders:
                          type: integer
              example:
                coin: ETH
                levels:
                  - side: A
                    triggerCondition: Price above 44000
                    triggerPx: '44000'
                    isPositionTpsl: true
                    totalSz: '0'
                    nOrders: 1
                  - side: B
                    triggerCondition: Price above 22399
                    triggerPx: '22399'
                    isPositionTpsl: false
                    totalSz: '0.8552'
                    nOrders: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - BearerAuth: []
components:
  responses:
    Unauthorized:
      description: >-
        Missing or invalid API key. The body is `missing api key` or `invalid
        api key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Invalid API key
  schemas:
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Hypedexer API key, sent as `Authorization: Bearer <key>`. The
        `X-API-Key: <key>` header and the `api_key` query parameter are accepted
        as well.

````

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