> ## 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.

# Read the daily risk report of a trading day

> The risk findings of one trading day, computed once after the session closes (in the evening, Chicago time). Pull it once per trading day; it does not change afterwards. Every row names the accounts with your `customerId`, your trader record (`traderId`) and the trader's login (`userId`), so you can match it without a lookup.

- **hedge_pairs:** two different traders holding opposite positions on the same market at the same time. Micro and full-size contracts count as one market (MNQ with NQ, MES with ES, MYM with YM, M2K with RTY, MCL with CL, MGC with GC; a micro is a tenth of the full size). A pair is two positions opened within 5 minutes of each other, closed within 5 minutes of each other and overlapping for at least 10 seconds, with both positions' open and close times, size and profit or loss. A wider rule also lists positions opened within 60 seconds of each other and held against each other for at least 3 minutes, however far apart they closed (`rule: open_overlap`); those rows flag nobody and send no webhook event.
- **copy_pairs:** two different traders opening the same market and side within 30 seconds, with positions overlapping at least 1 second. `daysSeen` counts the days in the last 30 on which the two matched; `flagged` is true from 2 days on.
- **copy_groups:** 3 or more different traders opening the same market and side within 5 seconds, with `daysSeen`.
- **shared_devices:** a device or address used by more than one of your traders on the day: their sign-ins, apps and versions when the app sent them, country, whether a sign-in came from a hosting or VPN network, whether their sessions overlapped, and the minutes in which both traded. An address shared by more than 50 traders (a mobile carrier, a VPN exit) is left out.
- **news_window_fills:** every executed order inside one of your news windows (`PUT /risk/news-windows`) that applies to the account's plan, and whether it opened or reduced a position. Report only; nothing is blocked.

From 14 November 2026 `hedge_pairs`, `copy_pairs` and `copy_groups` hold only the medium and high findings, one per trader pair and day (a hedge row carries the pair's other hedges in `rows` and its wider-rule overlaps in `overlapRows`), each with its measures (`pair`) and `assessment`. A pair is medium when the two traders made tight matches (copies opened within 3 seconds, hedges opened and closed within 30 seconds with similar size, while at most 10 traders did the same) that cover a meaningful share of their trading that day, or shared a device or address; high when it repeats on another day or they shared a device. A group is a finding when it is small (up to 10 traders), most of a quiet moment, and closed together or repeated. Every other match is listed with `GET /risk/reports/{tradingDay}/matches`.

Moments when very many traders open the same market at once (a market open, a news print) are not used for pairing; `stats` counts them. Platform copy trading a trader sets up across their own accounts is never reported. The shared device and news reports hold at most 2000 rows, the largest first (`truncated`). Findings flag accounts for review; they are not proof. The order source (manual, bracket, API, copier) is not part of these reports yet.

```bash
curl "https://api.hyperprop.com/platform/v1/organization/risk/reports/2026-11-12?report=hedge_pairs,copy_groups" \
  -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/reports/{tradingDay}
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/reports/{tradingDay}:
    get:
      tags:
        - Risk
      summary: Read the daily risk report of a trading day
      description: >-
        The risk findings of one trading day, computed once after the session
        closes (in the evening, Chicago time). Pull it once per trading day; it
        does not change afterwards. Every row names the accounts with your
        `customerId`, your trader record (`traderId`) and the trader's login
        (`userId`), so you can match it without a lookup.


        - **hedge_pairs:** two different traders holding opposite positions on
        the same market at the same time. Micro and full-size contracts count as
        one market (MNQ with NQ, MES with ES, MYM with YM, M2K with RTY, MCL
        with CL, MGC with GC; a micro is a tenth of the full size). A pair is
        two positions opened within 5 minutes of each other, closed within 5
        minutes of each other and overlapping for at least 10 seconds, with both
        positions' open and close times, size and profit or loss. A wider rule
        also lists positions opened within 60 seconds of each other and held
        against each other for at least 3 minutes, however far apart they closed
        (`rule: open_overlap`); those rows flag nobody and send no webhook
        event.

        - **copy_pairs:** two different traders opening the same market and side
        within 30 seconds, with positions overlapping at least 1 second.
        `daysSeen` counts the days in the last 30 on which the two matched;
        `flagged` is true from 2 days on.

        - **copy_groups:** 3 or more different traders opening the same market
        and side within 5 seconds, with `daysSeen`.

        - **shared_devices:** a device or address used by more than one of your
        traders on the day: their sign-ins, apps and versions when the app sent
        them, country, whether a sign-in came from a hosting or VPN network,
        whether their sessions overlapped, and the minutes in which both traded.
        An address shared by more than 50 traders (a mobile carrier, a VPN exit)
        is left out.

        - **news_window_fills:** every executed order inside one of your news
        windows (`PUT /risk/news-windows`) that applies to the account's plan,
        and whether it opened or reduced a position. Report only; nothing is
        blocked.


        From 14 November 2026 `hedge_pairs`, `copy_pairs` and `copy_groups` hold
        only the medium and high findings, one per trader pair and day (a hedge
        row carries the pair's other hedges in `rows` and its wider-rule
        overlaps in `overlapRows`), each with its measures (`pair`) and
        `assessment`. A pair is medium when the two traders made tight matches
        (copies opened within 3 seconds, hedges opened and closed within 30
        seconds with similar size, while at most 10 traders did the same) that
        cover a meaningful share of their trading that day, or shared a device
        or address; high when it repeats on another day or they shared a device.
        A group is a finding when it is small (up to 10 traders), most of a
        quiet moment, and closed together or repeated. Every other match is
        listed with `GET /risk/reports/{tradingDay}/matches`.


        Moments when very many traders open the same market at once (a market
        open, a news print) are not used for pairing; `stats` counts them.
        Platform copy trading a trader sets up across their own accounts is
        never reported. The shared device and news reports hold at most 2000
        rows, the largest first (`truncated`). Findings flag accounts for
        review; they are not proof. The order source (manual, bracket, API,
        copier) is not part of these reports yet.


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/risk/reports/2026-11-12?report=hedge_pairs,copy_groups"
        \
          -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: getV1OrganizationRiskReportsTradingday
      parameters:
        - description: >-
            Trading day (YYYY-MM-DD). A trading day runs from 17:00 to 17:00
            Chicago time and is named after the date it ends on.
          name: tradingDay
          in: path
          required: true
          example: '2026-11-12'
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - description: >-
            Comma-separated reports to return (default: all): `hedge_pairs`,
            `copy_pairs`, `copy_groups`, `shared_devices`, `news_window_fills`
          name: report
          in: query
          required: false
          example: hedge_pairs,copy_groups
          schema:
            type: string
            pattern: ^[a-z_]+(,[a-z_]+)*$
        - 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: The reports of the trading day
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model1135'
        '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 request data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model351'
        '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'
        '500':
          description: Internal error (`RISK_REPORTS_ERROR`)
        '503':
          description: >-
            Daily risk reports are not available yet
            (`RISK_REPORTS_UNAVAILABLE`)
        '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/Model1136'
      security:
        - X-API-Key: []
components:
  schemas:
    Model1135:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model1134'
    Model351:
      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: Invalid request data
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: BAD_REQUEST
    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
    Model1136:
      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
    Model1134:
      type: object
      properties:
        organizationId:
          type: string
          x-format:
            guid: true
        tradingDay:
          type: string
          example: '2026-11-12'
        thresholds:
          $ref: '#/components/schemas/thresholds'
        reports:
          $ref: '#/components/schemas/Model1133'
    thresholds:
      type: object
      description: The thresholds the reports were computed with
    Model1133:
      type: object
      properties:
        hedge_pairs:
          $ref: '#/components/schemas/hedge_pairs'
        copy_pairs:
          $ref: '#/components/schemas/copy_pairs'
        copy_groups:
          $ref: '#/components/schemas/copy_groups'
        shared_devices:
          $ref: '#/components/schemas/shared_devices'
        news_window_fills:
          $ref: '#/components/schemas/news_window_fills'
    hedge_pairs:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Model1083'
        computedAt:
          type: string
          x-format:
            isoDate: true
        rowCount:
          type: integer
          description: All findings of the day
          example: 3
        truncated:
          type: boolean
          description: >-
            True when there were more than 2000 rows; the largest are returned.
            From 14 Nov 2026 hedge, copy and group reports are never cut short
          example: false
        stats:
          $ref: '#/components/schemas/stats'
        rows:
          $ref: '#/components/schemas/Model1095'
        redacted:
          type: boolean
          description: >-
            Shared devices only: true when device ids and addresses are
            shortened because your role lacks Risk investigations
          example: false
    copy_pairs:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Model1096'
        computedAt:
          type: string
          x-format:
            isoDate: true
        rowCount:
          type: integer
          description: All findings of the day
          example: 3
        truncated:
          type: boolean
          description: >-
            True when there were more than 2000 rows; the largest are returned.
            From 14 Nov 2026 hedge, copy and group reports are never cut short
          example: false
        stats:
          $ref: '#/components/schemas/stats'
        rows:
          $ref: '#/components/schemas/Model1109'
        redacted:
          type: boolean
          description: >-
            Shared devices only: true when device ids and addresses are
            shortened because your role lacks Risk investigations
          example: false
    copy_groups:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Model1110'
        computedAt:
          type: string
          x-format:
            isoDate: true
        rowCount:
          type: integer
          description: All findings of the day
          example: 3
        truncated:
          type: boolean
          description: >-
            True when there were more than 2000 rows; the largest are returned.
            From 14 Nov 2026 hedge, copy and group reports are never cut short
          example: false
        stats:
          $ref: '#/components/schemas/stats'
        rows:
          $ref: '#/components/schemas/Model1118'
        redacted:
          type: boolean
          description: >-
            Shared devices only: true when device ids and addresses are
            shortened because your role lacks Risk investigations
          example: false
    shared_devices:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Model1119'
        computedAt:
          type: string
          x-format:
            isoDate: true
        rowCount:
          type: integer
          description: All findings of the day
          example: 3
        truncated:
          type: boolean
          description: >-
            True when there were more than 2000 rows; the largest are returned.
            From 14 Nov 2026 hedge, copy and group reports are never cut short
          example: false
        stats:
          $ref: '#/components/schemas/stats'
        rows:
          $ref: '#/components/schemas/Model1128'
        redacted:
          type: boolean
          description: >-
            Shared devices only: true when device ids and addresses are
            shortened because your role lacks Risk investigations
          example: false
    news_window_fills:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Model1129'
        computedAt:
          type: string
          x-format:
            isoDate: true
        rowCount:
          type: integer
          description: All findings of the day
          example: 3
        truncated:
          type: boolean
          description: >-
            True when there were more than 2000 rows; the largest are returned.
            From 14 Nov 2026 hedge, copy and group reports are never cut short
          example: false
        stats:
          $ref: '#/components/schemas/stats'
        rows:
          $ref: '#/components/schemas/Model1132'
        redacted:
          type: boolean
          description: >-
            Shared devices only: true when device ids and addresses are
            shortened because your role lacks Risk investigations
          example: false
    Model1083:
      type: string
      description: '`pending`: not computed yet for this day'
      example: ready
      enum:
        - ready
        - failed
        - pending
    stats:
      type: object
    Model1095:
      type: array
      items:
        $ref: '#/components/schemas/Model1094'
    Model1096:
      type: string
      description: '`pending`: not computed yet for this day'
      example: ready
      enum:
        - ready
        - failed
        - pending
    Model1109:
      type: array
      items:
        $ref: '#/components/schemas/Model1108'
    Model1110:
      type: string
      description: '`pending`: not computed yet for this day'
      example: ready
      enum:
        - ready
        - failed
        - pending
    Model1118:
      type: array
      items:
        $ref: '#/components/schemas/Model1117'
    Model1119:
      type: string
      description: '`pending`: not computed yet for this day'
      example: ready
      enum:
        - ready
        - failed
        - pending
    Model1128:
      type: array
      items:
        $ref: '#/components/schemas/Model1127'
    Model1129:
      type: string
      description: '`pending`: not computed yet for this day'
      example: ready
      enum:
        - ready
        - failed
        - pending
    Model1132:
      type: array
      items:
        $ref: '#/components/schemas/Model1131'
    Model1094:
      type: object
      properties:
        id:
          type: string
          description: Stable id of the finding; the same in the webhook event
          x-format:
            guid: true
        underlying:
          type: string
          description: 'The market: MNQ and NQ are both `NQ`'
          example: NQ
        overlapFrom:
          type: string
          x-format:
            isoDate: true
        overlapTo:
          type: string
          x-format:
            isoDate: true
        overlapSeconds:
          type: number
          example: 412
        openGapSeconds:
          type: number
          description: Seconds between the two positions opening
          example: 95
        closeGapSeconds:
          type: number
          example: 3
        legs:
          $ref: '#/components/schemas/Model1085'
        rule:
          $ref: '#/components/schemas/Model1086'
        pair:
          $ref: '#/components/schemas/Model1087'
        rows:
          $ref: '#/components/schemas/Model1089'
        overlapRows:
          $ref: '#/components/schemas/overlapRows'
        assessment:
          $ref: '#/components/schemas/assessment'
    Model1108:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid: true
        traderA:
          $ref: '#/components/schemas/Model1099'
        traderB:
          $ref: '#/components/schemas/Model1099'
        underlyings:
          $ref: '#/components/schemas/Model1100'
        matches:
          type: integer
          description: Positions opened together on the day
          example: 6
        avgSecondsApart:
          type: number
          example: 2.4
        similarSizeShare:
          type: number
          description: Share of matches whose sizes are within 20% of each other
          example: 0.83
          minimum: 0
          maximum: 1
        firstAt:
          type: string
          x-format:
            isoDate: true
        lastAt:
          type: string
          x-format:
            isoDate: true
        samples:
          $ref: '#/components/schemas/Model1103'
        daysSeen:
          type: integer
          description: >-
            Trading days in the last 30, this one included, on which these two
            traders matched
          example: 3
        flagged:
          type: boolean
          description: >-
            True from 2 days on; from 14 Nov 2026 always true (every row is a
            medium or high finding)
          example: true
        pair:
          $ref: '#/components/schemas/Model1104'
        assessment:
          $ref: '#/components/schemas/Model1107'
    Model1117:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid: true
        underlying:
          type: string
          example: NQ
        side:
          $ref: '#/components/schemas/Model1111'
        traders:
          type: integer
          example: 4
        firstAt:
          type: string
          x-format:
            isoDate: true
        lastAt:
          type: string
          x-format:
            isoDate: true
        spanSeconds:
          type: number
          example: 3.1
        members:
          $ref: '#/components/schemas/Model1113'
        daysSeen:
          type: integer
          description: >-
            Trading days in the last 30, this one included, with a group holding
            at least three of these traders
          example: 2
        crowd:
          type: integer
          description: >-
            From 14 Nov 2026: traders opening that market and side in the same
            30 s
          example: 6
        exitsMatched:
          type: boolean
          description: >-
            From 14 Nov 2026: at least 3 and two thirds of them closed within 30
            s of each other
        assessment:
          $ref: '#/components/schemas/Model1116'
    Model1127:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid: true
        type:
          $ref: '#/components/schemas/Model1120'
        value:
          type: string
          description: The device id or the address
          example: d_8f2c41e09a
        traderCount:
          type: integer
          example: 2
        firstSeen:
          type: string
          x-format:
            isoDate: true
        lastSeen:
          type: string
          x-format:
            isoDate: true
        traders:
          $ref: '#/components/schemas/Model1124'
        pairs:
          $ref: '#/components/schemas/Model1126'
        overlapping:
          type: boolean
          description: Sessions or trading of two of the traders overlapped
          example: true
    Model1131:
      type: object
      properties:
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          x-format:
            guid: true
        accountNumber:
          type: string
          example: ACC-50K-000123
        customerId:
          type: string
          description: Your customer id for the account (`customerId` at account creation)
          example: cust-4471
        accountType:
          type: string
          example: sim_funded
        status:
          type: string
          example: in_progress
        planId:
          type: string
          x-format:
            guid: true
        traderId:
          type: string
          description: >-
            Your trader record when the account has one, otherwise the trader's
            login
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        userId:
          type: string
          description: The trader's Hyperprop login
          x-format:
            guid: true
        traderName:
          type: string
          example: Jane Trader
        traderEmail:
          type: string
          example: jane@example.com
        id:
          type: string
          x-format:
            guid: true
        windowId:
          type: string
          description: Your id of the news window
          example: nfp-2026-12-04
        windowName:
          type: string
          example: Non-Farm Payrolls
        eventAt:
          type: string
          x-format:
            isoDate: true
        secondsFromEvent:
          type: number
          description: Negative before the event
          example: -35
        opening:
          type: boolean
          description: >-
            The order opened or added to a position; false when it reduced or
            closed one
          example: true
        contract:
          type: string
          example: ESZ6
        side:
          $ref: '#/components/schemas/Model1130'
        quantity:
          type: number
          example: 2
        price:
          type: number
          example: 6012.25
        filledAt:
          type: string
          x-format:
            isoDate: true
        pnl:
          type: number
          example: 0
    Model1085:
      type: array
      description: One position of each trader, on opposite sides
      x-constraint:
        length: 2
      items:
        $ref: '#/components/schemas/Model1084'
    Model1086:
      type: string
      description: >-
        Which rule matched: `open_close` (opened and closed close together) or
        `open_overlap` (opened together and held against each other for minutes,
        however far apart they closed; listed only, flags nobody). Absent on
        days stored before 14 Nov 2026, which are all `open_close`
      example: open_close
      enum:
        - open_close
        - open_overlap
    Model1087:
      type: object
      description: 'From 14 Nov 2026: the trader pair''s measures for the day'
      properties:
        tight:
          type: integer
          description: >-
            Tight matches: copies opened within 3 s, or hedges opened and closed
            within 30 s with similar size, while at most 10 traders did the same
          example: 3
        matches:
          type: integer
          description: 'Copies: all matches of the day; hedges: all hedge rows'
          example: 5
        positionsA:
          type: integer
          example: 12
        positionsB:
          type: integer
          example: 40
        followerShare:
          type: number
          description: Tight matches as a share of the quieter trader's positions that day
          example: 0.25
        leaderShare:
          type: number
          description: The same for the busier trader
          example: 0.075
        weight:
          type: number
          description: Each match counts 1 / (other traders doing the same at that moment)
          example: 2.5
        daysSeen:
          type: integer
          description: Days with tight matches in the last 30, this one included
          example: 2
        tightPnlA:
          type: number
        tightPnlB:
          type: number
        tightSimilar:
          type: integer
    Model1089:
      type: array
      description: >-
        From 14 Nov 2026: the pair's other hedges that day (same fields as this
        row), at most 19
      items:
        $ref: '#/components/schemas/Model1088'
    overlapRows:
      type: array
      description: >-
        From 14 Nov 2026: the pair's wider-rule overlaps that day, as context;
        they never set the level
      items:
        $ref: '#/components/schemas/Model1090'
    assessment:
      type: object
      description: 'From 14 Nov 2026: the level and its reasons'
      properties:
        level:
          $ref: '#/components/schemas/Model1091'
        reasons:
          $ref: '#/components/schemas/Model1093'
    Model1099:
      type: object
      properties:
        traderId:
          type: string
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        userId:
          type: string
          x-format:
            guid: true
        traderName:
          type: string
        traderEmail:
          type: string
        accounts:
          $ref: '#/components/schemas/Model1098'
    Model1100:
      type: array
      example:
        - ES
      items:
        type: string
    Model1103:
      type: array
      description: First matches of the day, at most 5
      items:
        $ref: '#/components/schemas/Model1102'
    Model1104:
      type: object
      description: 'From 14 Nov 2026: the trader pair''s measures for the day'
      properties:
        tight:
          type: integer
          description: >-
            Tight matches: copies opened within 3 s, or hedges opened and closed
            within 30 s with similar size, while at most 10 traders did the same
          example: 3
        matches:
          type: integer
          description: 'Copies: all matches of the day; hedges: all hedge rows'
          example: 5
        positionsA:
          type: integer
          example: 12
        positionsB:
          type: integer
          example: 40
        followerShare:
          type: number
          description: Tight matches as a share of the quieter trader's positions that day
          example: 0.25
        leaderShare:
          type: number
          description: The same for the busier trader
          example: 0.075
        weight:
          type: number
          description: Each match counts 1 / (other traders doing the same at that moment)
          example: 2.5
        daysSeen:
          type: integer
          description: Days with tight matches in the last 30, this one included
          example: 2
        tightPnlA:
          type: number
        tightPnlB:
          type: number
        tightSimilar:
          type: integer
    Model1107:
      type: object
      description: 'From 14 Nov 2026: the level and its reasons'
      properties:
        level:
          $ref: '#/components/schemas/Model1105'
        reasons:
          $ref: '#/components/schemas/Model1106'
    Model1111:
      type: string
      enum:
        - long
        - short
    Model1113:
      type: array
      items:
        $ref: '#/components/schemas/Model1112'
    Model1116:
      type: object
      description: 'From 14 Nov 2026: the level and its reasons'
      properties:
        level:
          $ref: '#/components/schemas/Model1114'
        reasons:
          $ref: '#/components/schemas/Model1115'
    Model1120:
      type: string
      example: device
      enum:
        - device
        - ip
    Model1124:
      type: array
      items:
        $ref: '#/components/schemas/Model1123'
    Model1126:
      type: array
      items:
        $ref: '#/components/schemas/Model1125'
    Model1130:
      type: string
      enum:
        - buy
        - sell
    Model1084:
      type: object
      properties:
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          x-format:
            guid: true
        accountNumber:
          type: string
          example: ACC-50K-000123
        customerId:
          type: string
          description: Your customer id for the account (`customerId` at account creation)
          example: cust-4471
        accountType:
          type: string
          example: sim_funded
        status:
          type: string
          example: in_progress
        planId:
          type: string
          x-format:
            guid: true
        traderId:
          type: string
          description: >-
            Your trader record when the account has one, otherwise the trader's
            login
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        userId:
          type: string
          description: The trader's Hyperprop login
          x-format:
            guid: true
        traderName:
          type: string
          example: Jane Trader
        traderEmail:
          type: string
          example: jane@example.com
        contract:
          type: string
          example: NQZ6
        side:
          $ref: '#/components/schemas/side'
        openedAt:
          type: string
          example: '2026-11-12T14:31:02.000Z'
          x-format:
            isoDate: true
        closedAt:
          type: string
          description: Null while the position was still open at the end of the day
          example: '2026-11-12T14:38:10.000Z'
          x-format:
            isoDate: true
        quantity:
          type: number
          description: Largest position held, in contracts of `contract`
          example: 1
        size:
          type: number
          description: The same in full-size contracts of the market (10 MNQ = 1 NQ)
          example: 1
        pnl:
          type: number
          description: Realized profit or loss of the position
          example: 1250
        costs:
          type: number
          description: Fees and commissions of the position
          example: 4.2
    Model1088:
      type: object
    Model1090:
      type: object
    Model1091:
      type: string
      example: medium
      enum:
        - medium
        - high
    Model1093:
      type: array
      items:
        $ref: '#/components/schemas/Model1092'
    Model1098:
      type: array
      items:
        $ref: '#/components/schemas/Model1097'
    Model1102:
      type: object
      properties:
        atA:
          type: string
          x-format:
            isoDate: true
        atB:
          type: string
          x-format:
            isoDate: true
        accountA:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          x-format:
            guid: true
        accountB:
          type: string
          example: 9d1e6679-7425-40de-944b-e07fc1f90ae8
          x-format:
            guid: true
        underlying:
          type: string
          example: ES
        side:
          $ref: '#/components/schemas/Model1101'
        secondsApart:
          type: number
          example: 2
        overlapSeconds:
          type: number
          example: 240
    Model1105:
      type: string
      example: medium
      enum:
        - medium
        - high
    Model1106:
      type: array
      items:
        $ref: '#/components/schemas/Model1092'
    Model1112:
      type: object
      properties:
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          x-format:
            guid: true
        accountNumber:
          type: string
          example: ACC-50K-000123
        customerId:
          type: string
          description: Your customer id for the account (`customerId` at account creation)
          example: cust-4471
        accountType:
          type: string
          example: sim_funded
        status:
          type: string
          example: in_progress
        planId:
          type: string
          x-format:
            guid: true
        traderId:
          type: string
          description: >-
            Your trader record when the account has one, otherwise the trader's
            login
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        userId:
          type: string
          description: The trader's Hyperprop login
          x-format:
            guid: true
        traderName:
          type: string
          example: Jane Trader
        traderEmail:
          type: string
          example: jane@example.com
        contract:
          type: string
          example: NQZ6
        openedAt:
          type: string
          example: '2026-11-12T14:31:02.000Z'
          x-format:
            isoDate: true
        closedAt:
          type: string
          description: Null while the position was still open at the end of the day
          example: '2026-11-12T14:38:10.000Z'
          x-format:
            isoDate: true
        quantity:
          type: number
          description: Largest position held, in contracts of `contract`
          example: 1
        size:
          type: number
          description: The same in full-size contracts of the market (10 MNQ = 1 NQ)
          example: 1
        pnl:
          type: number
          description: Realized profit or loss of the position
          example: 1250
        costs:
          type: number
          description: Fees and commissions of the position
          example: 4.2
    Model1114:
      type: string
      example: medium
      enum:
        - medium
        - high
    Model1115:
      type: array
      items:
        $ref: '#/components/schemas/Model1092'
    Model1123:
      type: object
      properties:
        userId:
          type: string
          x-format:
            guid: true
        traderId:
          type: string
          example: 8a2e1d0f-3c4b-4d5e-9f6a-7b8c9d0e1f2a
        traderName:
          type: string
        traderEmail:
          type: string
        accounts:
          $ref: '#/components/schemas/Model1121'
        firstSeen:
          type: string
          x-format:
            isoDate: true
        lastSeen:
          type: string
          x-format:
            isoDate: true
        signIns:
          type: integer
          example: 3
        apps:
          $ref: '#/components/schemas/apps'
        versions:
          $ref: '#/components/schemas/versions'
        countries:
          $ref: '#/components/schemas/Model1122'
        hostingNetwork:
          type: boolean
          description: A sign-in came from a hosting or VPN network; null when unknown
    Model1125:
      type: object
      properties:
        userA:
          type: string
          x-format:
            guid: true
        userB:
          type: string
          x-format:
            guid: true
        sessionOverlapSeconds:
          type: number
          description: >-
            Seconds the two traders' sessions on it overlapped; null while no
            session of either was recorded
          example: 1800
        signInGapSeconds:
          type: number
          description: Shortest time between their sign-ins on it
          example: 40
        tradingOverlapMinutes:
          type: integer
          description: Minutes of the day in which both had an executed order
          example: 12
    side:
      type: string
      example: long
      enum:
        - long
        - short
    Model1092:
      type: object
      properties:
        code:
          type: string
        text:
          type: string
    Model1097:
      type: object
      properties:
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          x-format:
            guid: true
        accountNumber:
          type: string
          example: ACC-50K-000123
        customerId:
          type: string
          description: Your customer id for the account (`customerId` at account creation)
          example: cust-4471
        accountType:
          type: string
          example: sim_funded
        status:
          type: string
          example: in_progress
        planId:
          type: string
          x-format:
            guid: true
        traderId:
          type: string
          description: >-
            Your trader record when the account has one, otherwise the trader's
            login
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        userId:
          type: string
          description: The trader's Hyperprop login
          x-format:
            guid: true
        traderName:
          type: string
          example: Jane Trader
        traderEmail:
          type: string
          example: jane@example.com
    Model1101:
      type: string
      enum:
        - long
        - short
    Model1121:
      type: array
      items:
        $ref: '#/components/schemas/Model1097'
    apps:
      type: array
      description: Apps that signed in, when the app sent it
      example:
        - web
      items:
        type: string
    versions:
      type: array
      example:
        - 3.14.0
      items:
        type: string
    Model1122:
      type: array
      example:
        - US
      items:
        type: string
  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

- [List daily risk reports](https://docs.hyperprop.com/platform-api/risk/list-daily-risk-reports.md)
- [List every risk match of a trading day](https://docs.hyperprop.com/platform-api/risk/list-every-risk-match-of-a-trading-day.md)
- [Read the risk flags of accounts](https://docs.hyperprop.com/platform-api/risk/read-the-risk-flags-of-accounts.md)
- [Read one trader's risk findings with their proof](https://docs.hyperprop.com/platform-api/risk/read-one-traders-risk-findings-with-their-proof.md)
- [Rebuild the full risk match list of a trading day](https://docs.hyperprop.com/platform-api/risk/rebuild-the-full-risk-match-list-of-a-trading-day.md)


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