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

# Get live exposure by product and trader

> Your organization's open positions right now, aggregated: per product the traders long and short, quantities and the net and gross exposure, the firm's totals, and with `traders=true` the exposure of each trader. The figures follow every position change within about a second.

To receive them as they change instead of asking, subscribe on the organization event stream (`/organization/events/stream`): send `{"type": "subscribe", "topic": "live.positioning"}`; you receive `subscribed`, then a `live.positioning` message with the same `firm` and `products` at most about once per second while they change.

Exposure is quantity × mark × point value, each contract valued at its latest mark; open P&L uses the same mark. A trader counts as long a product when their positions in it sum to long. With `assetClass` or `market`, only positions and executions in contracts of those markets count.

The first request for your organization starts the live figures and answers `status: "starting"`; they are ready within seconds. About 60 requests per minute per organization.

## Example

```bash
curl "https://api.hyperprop.com/platform/v1/organization/risk/positioning/live?traders=true&traderLimit=20" \
  -H "X-API-Key: hp_live_your_key_here"
```

**Permissions:** requires **view** access to "Traders & accounts".

**Access:** read-only and full-access API keys. Dashboard members need view access to Traders & accounts.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning/live
openapi: 3.0.0
info:
  title: Hyperprop Platform API
  version: 1.0.0
  description: >-
    REST API for the Hyperprop Trading Platform — provision evaluation and
    funded trading accounts, manage traders and plans, react to account
    lifecycle events via signed webhooks, and reconcile billing. Built for prop
    firms integrating from their own backend.


    Authentication, quick start, error handling, idempotency, pagination, custom
    metadata, webhooks, and the MCP connector are documented at
    https://docs.hyperprop.com.
  x-logo:
    url: https://app.hyperprop.com/logo-icon.svg
    altText: Hyperprop
    href: https://hyperprop.com
servers:
  - url: https://api.hyperprop.com/platform
    description: Production
security: []
tags:
  - name: Trading accounts
    description: Create, update, and inspect trading accounts.
  - name: Traders
    description: Look up and update the traders in your organization.
  - name: Trading plans
    description: Define the plans you sell.
  - name: Trading rules
    description: Define how accounts are evaluated.
  - name: Instruments
    description: >-
      The contracts your organization's accounts can trade, with their
      specifications.
  - name: Lockouts
    description: Pause and resume trading on an account.
  - name: Payouts
    description: Check payout eligibility and record payouts.
  - name: Purchases
    description: Purchases recorded for your organization.
  - name: Time Machine
    description: Restore accounts to an earlier trading day or instant.
  - name: Mass credit
    description: >-
      Credit back losses across many accounts after an incident, as background
      jobs you can follow, pause, export and reverse.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history, to replay or audit what happened.
  - name: Real-time streams
    description: >-
      Live events and trading data over a WebSocket, for dashboards and CRMs
      that update as things happen.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance, revenue and top traders.
  - name: Risk
    description: Firm profit and loss and plan economics.
  - name: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - name: Billing and invoices
    description: >-
      Your Hyperprop invoices, credits and billing details, with usage so far
      this month, billing cycles, forecasts and CSV exports.
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: >-
      Manage your organization's API keys: rotation, read-only keys and IP
      allowlists.
  - name: Logs and health
    description: >-
      API request logs, the audit log, integration health, and idempotency key
      recovery.
  - name: Organization profile
    description: Your organization's profile and logo.
  - name: Support
    description: Open and follow up on support tickets.
  - name: Partner access
    description: >-
      Read a trader's journal as an approved partner app, with the trader's own
      key.
paths:
  /v1/organization/risk/positioning/live:
    get:
      tags:
        - Trader insights
      summary: Get live exposure by product and trader
      description: >-
        Your organization's open positions right now, aggregated: per product
        the traders long and short, quantities and the net and gross exposure,
        the firm's totals, and with `traders=true` the exposure of each trader.
        The figures follow every position change within about a second.


        To receive them as they change instead of asking, subscribe on the
        organization event stream (`/organization/events/stream`): send
        `{"type": "subscribe", "topic": "live.positioning"}`; you receive
        `subscribed`, then a `live.positioning` message with the same `firm` and
        `products` at most about once per second while they change.


        Exposure is quantity × mark × point value, each contract valued at its
        latest mark; open P&L uses the same mark. A trader counts as long a
        product when their positions in it sum to long. With `assetClass` or
        `market`, only positions and executions in contracts of those markets
        count.


        The first request for your organization starts the live figures and
        answers `status: "starting"`; they are ready within seconds. About 60
        requests per minute per organization.


        ## Example


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/risk/positioning/live?traders=true&traderLimit=20"
        \
          -H "X-API-Key: hp_live_your_key_here"
        ```


        **Permissions:** requires **view** access to "Traders & accounts".


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Traders & accounts.
      operationId: getV1OrganizationRiskPositioningLive
      parameters:
        - description: >-
            Comma-separated account types: `evaluation`, `sim_funded`,
            `competition`
          name: accountType
          in: query
          required: false
          example: sim_funded
          schema:
            type: string
            maxLength: 100
        - description: >-
            Comma-separated plan IDs, at most 50; `none` for accounts without a
            plan
          name: planId
          in: query
          required: false
          example: 7f8d9e0a-1b2c-3d4e-5f60-718293a4b5c6
          schema:
            type: string
            maxLength: 2000
        - description: Include exposure per trader
          name: traders
          in: query
          example: true
          schema:
            type: boolean
            default: false
        - description: 'With `traders=true`: how many traders, largest gross exposure first'
          name: traderLimit
          in: query
          example: 50
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
        - description: >-
            Only one kind of market: `future` (CME Group futures) or `perpetual`
            (perpetuals). Omit for both
          name: assetClass
          in: query
          required: false
          example: perpetual
          schema:
            type: string
            enum:
              - future
              - perpetual
        - description: >-
            Comma-separated markets your organization is enabled for: futures
            `CME`, `CBOT`, `NYMEX`, `COMEX`; perpetuals `HDL`, `BINANCE`,
            `HYPERLIQUID`. With `assetClass`, every market must be of that class
          name: market
          in: query
          required: false
          example: CME,CBOT
          schema:
            type: string
            maxLength: 84
        - name: If-None-Match
          in: header
          required: false
          description: >-
            Optional. The `ETag` of the answer you already have. When the answer
            would be the same, the response is `304` without a body.
          example: '"Hq3mB1c0s8n2JkVbQy4Tz9uXw5E"'
          schema:
            type: string
      responses:
        '200':
          description: 'Live exposure, or `status: "starting"`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model1081'
        '304':
          description: >-
            Not modified: the answer is the same as the one whose `ETag` you
            sent in `If-None-Match`. No body; keep using the answer you have.
        '400':
          description: >-
            Invalid parameters: `INVALID_MARKET`, `MARKET_NOT_ALLOWED` (not
            enabled for your organization), `MARKET_ASSET_CLASS_MISMATCH` (a
            market of another `assetClass`), or another validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model510'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model15'
        '403':
          description: This API key does not have admin permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model511'
        '429':
          description: >-
            Too many requests for your organization (`RATE_LIMITED`); wait
            `retryAfterSeconds`
        '500':
          description: Internal error (`POSITIONING_ERROR`)
        '504':
          description: >-
            Gateway Timeout - The request did not complete within 25 seconds
            (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the
            request (for example a shorter date range).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model1082'
      security:
        - X-API-Key: []
components:
  schemas:
    Model1081:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model1080'
    Model510:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: >-
            Unknown market: CMX. Use CME, CBOT, NYMEX, COMEX, HDL, BINANCE,
            HYPERLIQUID
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INVALID_MARKET
    Model15:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model511:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: This API key does not have admin permissions
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INSUFFICIENT_PERMISSIONS
    Model1082:
      type: object
      properties:
        statusCode:
          type: number
          example: 504
        error:
          type: string
          example: Gateway Timeout
        message:
          type: string
          example: >-
            The request did not complete within 25 seconds. Try again, or narrow
            it (for example a shorter date range).
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: REQUEST_TIMEOUT
    Model1080:
      type: object
      properties:
        organizationId:
          type: string
          example: 55555555-5555-4555-8555-555555555555
        status:
          $ref: '#/components/schemas/Model1072'
        retryAfterSeconds:
          type: integer
          description: With `starting` only
          example: 2
        asOf:
          type: string
          example: '2026-11-13T15:41:07.118Z'
        liveSince:
          type: string
          description: Since when the figures have been kept current
          example: '2026-11-13T15:30:02.004Z'
        staleSince:
          type: string
          description: >-
            Set when some recent changes may be missing; the figures are
            refreshed in full within a few minutes
          example: null
        marketFilter:
          $ref: '#/components/schemas/marketFilter'
        firm:
          $ref: '#/components/schemas/Model1073'
        products:
          $ref: '#/components/schemas/Model1075'
        traders:
          $ref: '#/components/schemas/Model1079'
    Model1072:
      type: string
      description: >-
        `starting`: the live figures are being prepared for your organization
        (the first request starts it); retry after `retryAfterSeconds`
      example: live
      enum:
        - live
        - starting
    marketFilter:
      type: object
      description: The market filter applied
      properties:
        assetClass:
          $ref: '#/components/schemas/Model501'
        markets:
          $ref: '#/components/schemas/Model502'
    Model1073:
      type: object
      properties:
        tradersLong:
          type: integer
          description: >-
            Traders whose positions in it sum to long (firm: long at least one
            product root)
          example: 412
        tradersShort:
          type: integer
          example: 388
        tradersInPosition:
          type: integer
          example: 800
        smartTradersLong:
          type: integer
          description: Always 0 here; the sentiment read fills it for its smart-money group
          example: 0
        smartTradersShort:
          type: integer
          example: 0
        smartTradersInPosition:
          type: integer
          example: 0
        longNotional:
          type: number
          description: 'Long exposure: quantity × mark × point value'
          example: 18240500
        shortNotional:
          type: number
          example: 16120250
        netNotional:
          type: number
          description: Long − short exposure
          example: 2120250
        grossNotional:
          type: number
          description: Long + short exposure
          example: 34360750
        smartLongNotional:
          type: number
          example: 0
        smartShortNotional:
          type: number
          example: 0
        longOpenPnl:
          type: number
          example: 41200.5
        shortOpenPnl:
          type: number
          example: -12800.25
        accountsInPosition:
          type: integer
          example: 1240
        openPositions:
          type: integer
          example: 1512
    Model1075:
      type: array
      description: Every product held, largest gross exposure first
      items:
        $ref: '#/components/schemas/Model1074'
    Model1079:
      type: array
      description: 'With `traders=true`: exposure per trader, largest gross exposure first'
      items:
        $ref: '#/components/schemas/Model1078'
    Model501:
      type: string
      description: Null when not filtered by class
      example: future
      enum:
        - future
        - perpetual
    Model502:
      type: array
      description: Empty when not filtered by market
      example:
        - CME
        - CBOT
      items:
        type: string
    Model1074:
      type: object
      properties:
        productKey:
          type: string
          example: MNQ
        rootSymbol:
          type: string
          example: MNQ
        name:
          type: string
          example: Micro E-mini Nasdaq-100
        productGroup:
          type: string
          example: equity_index
        assetClass:
          type: string
          example: future
        sizeUnit:
          type: string
          example: contracts
        tradersLong:
          type: integer
          description: >-
            Traders whose positions in it sum to long (firm: long at least one
            product root)
          example: 412
        tradersShort:
          type: integer
          example: 388
        tradersInPosition:
          type: integer
          example: 800
        smartTradersLong:
          type: integer
          description: Always 0 here; the sentiment read fills it for its smart-money group
          example: 0
        smartTradersShort:
          type: integer
          example: 0
        smartTradersInPosition:
          type: integer
          example: 0
        longNotional:
          type: number
          description: 'Long exposure: quantity × mark × point value'
          example: 18240500
        shortNotional:
          type: number
          example: 16120250
        netNotional:
          type: number
          description: Long − short exposure
          example: 2120250
        grossNotional:
          type: number
          description: Long + short exposure
          example: 34360750
        smartLongNotional:
          type: number
          example: 0
        smartShortNotional:
          type: number
          example: 0
        longOpenPnl:
          type: number
          example: 41200.5
        shortOpenPnl:
          type: number
          example: -12800.25
        longQuantity:
          type: number
          example: 1840
        shortQuantity:
          type: number
          example: 1610
        netQuantity:
          type: number
          example: 230
        price:
          type: number
          description: 'Perpetuals only: the mark the product is valued at'
          example: null
    Model1078:
      type: object
      properties:
        traderId:
          type: string
          example: 0f8e7d6c-5b4a-4392-8170-6f5e4d3c2b1a
        traderName:
          type: string
          example: Alex Trader
        traderEmail:
          type: string
          example: alex@example.com
        accounts:
          type: integer
          example: 2
        longNotional:
          type: number
          example: 210400
        shortNotional:
          type: number
          example: 0
        netNotional:
          type: number
          example: 210400
        grossNotional:
          type: number
          example: 210400
        openPnl:
          type: number
          example: 1250.5
        products:
          $ref: '#/components/schemas/Model1077'
    Model1077:
      type: array
      items:
        $ref: '#/components/schemas/Model1076'
    Model1076:
      type: object
      properties:
        productKey:
          type: string
          example: MNQ
        netQuantity:
          type: number
          example: 4
        netNotional:
          type: number
          example: 210400
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key (`hp_live_...`), sent in the `X-API-Key` header.
        Create, rotate and restrict keys in the dashboard or with the API keys
        endpoints; an organization can have two active keys, so you can rotate
        without downtime. A **full-access** key can call every endpoint in this
        reference. A **read-only** key can call `GET` endpoints (and create a
        trading stream token); any other request returns `403 READ_ONLY_KEY`. A
        key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other
        address. Each endpoint lists which keys can call it under **Access**.

````

## Related topics

- [Get long vs short positioning over time](https://docs.hyperprop.com/platform-api/trader-insights/get-long-vs-short-positioning-over-time.md)
- [Get live positioning across all accounts](https://docs.hyperprop.com/platform-api/trader-insights/get-live-positioning-across-all-accounts.md)
- [Set exposure limits](https://docs.hyperprop.com/platform-api/risk/set-exposure-limits.md)
- [Read exposure and concentration](https://docs.hyperprop.com/platform-api/risk/read-exposure-and-concentration.md)
- [Get active traders](https://docs.hyperprop.com/platform-api/trading-accounts/get-active-traders.md)


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