> ## 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 today's provisional risk pairs

> Copy and hedge pairs of the trading day still in progress, at most about 5 minutes behind the fills, rated with the same cut-offs as the daily risk report. They are provisional: shared devices and addresses are not considered until the night, nothing here is a finding, flags a trader or sends a webhook, and the report after the close decides the day. `enabled` is false while same-day checks are not switched on for your firm (the list is then empty). `asOf`: fills up to this time are included; `catchingUp` is true while the check is still working through earlier fills.

```bash
curl "https://api.hyperprop.com/platform/v1/organization/risk/today?minLevel=medium" \
  -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/today
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/today:
    get:
      tags:
        - Risk
      summary: List today's provisional risk pairs
      description: >-
        Copy and hedge pairs of the trading day still in progress, at most about
        5 minutes behind the fills, rated with the same cut-offs as the daily
        risk report. They are provisional: shared devices and addresses are not
        considered until the night, nothing here is a finding, flags a trader or
        sends a webhook, and the report after the close decides the day.
        `enabled` is false while same-day checks are not switched on for your
        firm (the list is then empty). `asOf`: fills up to this time are
        included; `catchingUp` is true while the check is still working through
        earlier fills.


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/risk/today?minLevel=medium"
        \
          -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: getV1OrganizationRiskToday
      parameters:
        - description: Only `copy` or only `hedge` pairs
          name: kind
          in: query
          required: false
          schema:
            type: string
            enum:
              - copy
              - hedge
        - description: Only pairs at this level or above so far today
          name: minLevel
          in: query
          schema:
            type: string
            enum:
              - low
              - medium
              - high
            default: medium
        - description: Rows to skip
          name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            maximum: 100000
            default: 0
        - description: Rows to return, at most 200
          name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
        - 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 today's provisional pairs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model720'
        '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'
        '429':
          description: >-
            Too many requests: this endpoint allows 60 calls per minute per
            organization. Wait the number of seconds in the `Retry-After`
            header.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 429
                  error:
                    type: string
                    example: Too Many Requests
                  message:
                    type: string
                    example: >-
                      Too many requests to this endpoint. Try again in 12
                      second(s).
                  code:
                    type: string
                    enum:
                      - RATE_LIMITED
                    example: RATE_LIMITED
                    description: >-
                      Machine-readable error code — switch on this, not on
                      message text
        '500':
          description: Internal error (`RISK_TODAY_ERROR`)
        '503':
          description: >-
            Same-day risk checks 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/Model721'
      security:
        - X-API-Key: []
components:
  schemas:
    Model720:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model719'
    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
    Model721:
      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
    Model719:
      type: object
      properties:
        organizationId:
          type: string
          x-format:
            guid: true
        tradingDay:
          type: string
          example: '2026-11-16'
        provisional:
          type: boolean
          example: true
        enabled:
          type: boolean
          example: true
        asOf:
          type: string
          x-format:
            isoDate: true
        catchingUp:
          type: boolean
          example: false
        total:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        rows:
          $ref: '#/components/schemas/rows'
    rows:
      type: array
      items:
        $ref: '#/components/schemas/Model718'
    Model718:
      type: object
      properties:
        kind:
          $ref: '#/components/schemas/Model714'
        key:
          type: string
          description: Stable key of the pair within the day
        level:
          $ref: '#/components/schemas/level'
        reasons:
          $ref: '#/components/schemas/reasons'
        traders:
          $ref: '#/components/schemas/Model717'
        pair:
          $ref: '#/components/schemas/pair'
        firstAt:
          type: string
          x-format:
            isoDate: true
        lastAt:
          type: string
          x-format:
            isoDate: true
    Model714:
      type: string
      example: copy
      enum:
        - copy
        - hedge
    level:
      type: string
      example: medium
      enum:
        - low
        - medium
        - high
    reasons:
      type: array
      items:
        $ref: '#/components/schemas/Model715'
    Model717:
      type: array
      items:
        $ref: '#/components/schemas/Model716'
    pair:
      type: object
      description: >-
        The numbers the level was decided on so far today; positions count every
        position each trader opened today
      properties:
        tight:
          type: integer
          example: 3
        positionsA:
          type: integer
          example: 12
        positionsB:
          type: integer
          example: 40
        followerShare:
          type: number
          example: 0.25
        leaderShare:
          type: number
          example: 0.075
        weight:
          type: number
          example: 1.5
        daysSeen:
          type: integer
          example: 1
    Model715:
      type: object
      properties:
        code:
          type: string
          example: tight_matches
        text:
          type: string
    Model716:
      type: object
      properties:
        traderId:
          type: string
        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

- [List every risk match of a trading day](https://docs.hyperprop.com/platform-api/risk/list-every-risk-match-of-a-trading-day.md)
- [List link clearances](https://docs.hyperprop.com/platform-api/risk/list-link-clearances.md)
- [List flagged traders](https://docs.hyperprop.com/platform-api/risk/list-flagged-traders.md)
- [List stored trading patterns](https://docs.hyperprop.com/platform-api/risk/list-stored-trading-patterns.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.