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

# List every risk match of a trading day

> Every trader pair and small group the daily risk reports measured that day, not only the findings: pairs with a tight match, a crowd weight of 1 or more (0.5 for hedges), 3 or more matches covering at least 20% of a trader's positions, or a shared device or address, and groups of up to 10 traders in moments when at most 15 opened that market and side. Each row carries its level that day; only `medium` and `high` are findings. `kind=trader` lists each trader's match counts for the day. Kept for 180 days. For the complete list of a day, every pair included, ask for an export with `POST /risk/reports/{tradingDay}/matches/export`.

```bash
curl "https://api.hyperprop.com/platform/v1/organization/risk/reports/2026-11-12/matches?kind=copy&minLevel=low&limit=100" \
  -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}/matches
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}/matches:
    get:
      tags:
        - Risk
      summary: List every risk match of a trading day
      description: >-
        Every trader pair and small group the daily risk reports measured that
        day, not only the findings: pairs with a tight match, a crowd weight of
        1 or more (0.5 for hedges), 3 or more matches covering at least 20% of a
        trader's positions, or a shared device or address, and groups of up to
        10 traders in moments when at most 15 opened that market and side. Each
        row carries its level that day; only `medium` and `high` are findings.
        `kind=trader` lists each trader's match counts for the day. Kept for 180
        days. For the complete list of a day, every pair included, ask for an
        export with `POST /risk/reports/{tradingDay}/matches/export`.


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/risk/reports/2026-11-12/matches?kind=copy&minLevel=low&limit=100"
        \
          -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: getV1OrganizationRiskReportsTradingdayMatches
      parameters:
        - description: >-
            Trading day (YYYY-MM-DD), named after the date its 17:00 to 17:00
            Chicago session ends on
          name: tradingDay
          in: path
          required: true
          example: '2026-11-12'
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - description: >-
            `copy` and `hedge` trader pairs, `overlap` (the wider hedge rule),
            small `group`s, or each `trader`'s match counts
          name: kind
          in: query
          schema:
            type: string
            enum:
              - copy
              - hedge
              - overlap
              - group
              - trader
            default: copy
        - description: Only rows naming this trader (your trader record or the login)
          name: traderId
          in: query
          required: false
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
          schema:
            type: string
            maxLength: 64
        - description: Only rows at this level or above that day
          name: minLevel
          in: query
          schema:
            type: string
            enum:
              - low
              - medium
              - high
            default: low
        - description: >-
            `tight` (tight matches; groups: days seen; traders: copy matches),
            `weight`, `matches` or `recent`
          name: sort
          in: query
          schema:
            type: string
            enum:
              - tight
              - weight
              - matches
              - recent
            default: tight
        - description: Rows to skip
          name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 1000000
            default: 0
        - description: Rows to return, at most 500
          name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
        - 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: One page of the day's matches
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model1241'
        '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_MATCHES_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/Model1242'
      security:
        - X-API-Key: []
components:
  schemas:
    Model1241:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model1240'
    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
    Model1242:
      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
    Model1240:
      type: object
      properties:
        organizationId:
          type: string
          x-format:
            guid: true
        tradingDay:
          type: string
        kind:
          type: string
        total:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        rows:
          $ref: '#/components/schemas/Model1239'
    Model1239:
      type: array
      items:
        $ref: '#/components/schemas/Model1039'
    Model1039:
      type: object
      properties:
        kind:
          $ref: '#/components/schemas/Model1035'
        key:
          type: string
          description: Stable key of the pair, group or trader within the day
        level:
          $ref: '#/components/schemas/Model1036'
        traders:
          $ref: '#/components/schemas/Model1038'
        measures:
          $ref: '#/components/schemas/measures'
    Model1035:
      type: string
      example: copy
      enum:
        - copy
        - hedge
        - overlap
        - group
        - trader
    Model1036:
      type: string
      description: >-
        The level the pair or group got that day; `low` for every row of an
        export
      example: low
      enum:
        - low
        - medium
        - high
    Model1038:
      type: array
      items:
        $ref: '#/components/schemas/Model1037'
    measures:
      type: object
      description: >-
        Copies: matches, tight (opened within 3 s while at most 10 traders did
        the same), fastMatches, tightSimilar, weight, avgSecondsApart,
        similarSizeShare, exitsMatchedShare, crowd, matchedPositionsA/B,
        positionsA/B, daysSeen, firstAt. Hedges and wider-rule overlaps: rows,
        tight, tightPnlA/B, tightPositionsA/B, weight, positionsA/B, daysSeen,
        firstAt. Groups: underlying, side, traders, crowd, daysSeen,
        exitsMatched, closes, firstAt, spanSeconds. Traders: positions,
        copyMatches, copyPartners, hedgeRows, hedgePartners, overlapRows,
        overlapPartners, groups
      example:
        matches: 5
        tight: 1
        weight: 0.4
        positionsA: 22
        positionsB: 140
        daysSeen: 1
        firstAt: '2026-11-12T14:31:02.000Z'
    Model1037:
      type: object
      properties:
        traderId:
          type: string
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        traderName:
          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

- [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)
- [Read the daily risk report of a trading day](https://docs.hyperprop.com/platform-api/risk/read-the-daily-risk-report-of-a-trading-day.md)
- [List stored trading patterns](https://docs.hyperprop.com/platform-api/risk/list-stored-trading-patterns.md)
- [List daily risk reports](https://docs.hyperprop.com/platform-api/risk/list-daily-risk-reports.md)
- [List flagged traders](https://docs.hyperprop.com/platform-api/risk/list-flagged-traders.md)


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