> ## 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 your alert limits

> Your alert limits, whether each figure is above its limit now, and the figures a limit can be set on.

| Figure | What it measures | Unit |
|--------|------------------|------|
| `open_profit_owed` | Profit above the starting balance on active funded accounts | USD |
| `accounts_near_breach` | Active accounts with 10% or less of their loss limit left | count |
| `exposure_limits_breached` | Markets whose live net size is above the exposure limit set for them | count |

**Permissions:** requires **view** access to "Analytics".

**Access:** read-only and full-access API keys. Dashboard members need view access to Analytics & audit log.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/alert-limits
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/alert-limits:
    get:
      tags:
        - Risk
      summary: Get your alert limits
      description: >-
        Your alert limits, whether each figure is above its limit now, and the
        figures a limit can be set on.


        | Figure | What it measures | Unit |

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

        | `open_profit_owed` | Profit above the starting balance on active
        funded accounts | USD |

        | `accounts_near_breach` | Active accounts with 10% or less of their
        loss limit left | count |

        | `exposure_limits_breached` | Markets whose live net size is above the
        exposure limit set for them | count |


        **Permissions:** requires **view** access to "Analytics".


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Analytics & audit log.
      operationId: getV1OrganizationRiskAlertlimits
      parameters:
        - 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: Alert limits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model576'
        '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.
        '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: Failed to read the alert limits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model577'
        '503':
          description: '`FEATURE_NOT_READY`: alerts are not available yet'
        '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/Model578'
      security:
        - X-API-Key: []
components:
  schemas:
    Model576:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model575'
    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
    Model577:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: Internal Server Error
        message:
          type: string
          example: Failed to read the alert limits
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: ALERT_LIMITS_ERROR
    Model578:
      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
    Model575:
      type: object
      properties:
        organizationId:
          type: string
          example: 55555555-5555-4555-8555-555555555555
          x-format:
            guid: true
        limits:
          $ref: '#/components/schemas/limits'
        metrics:
          $ref: '#/components/schemas/Model574'
    limits:
      type: array
      items:
        $ref: '#/components/schemas/Model571'
    Model574:
      type: array
      description: Every figure a limit can be set on
      items:
        $ref: '#/components/schemas/Model573'
    Model571:
      type: object
      properties:
        metric:
          $ref: '#/components/schemas/metric'
        label:
          type: string
          example: Open profit owed
        unit:
          $ref: '#/components/schemas/Model569'
        description:
          type: string
          example: Profit above the starting balance on active funded accounts
        threshold:
          type: number
          description: The alert fires when the figure reaches this value
          example: 250000
        enabled:
          type: boolean
          example: true
        crossed:
          type: boolean
          description: >-
            True while the figure is at or above the limit (since the limit was
            last changed)
          example: false
        lastAlert:
          $ref: '#/components/schemas/lastAlert'
        updatedAt:
          type: string
          x-format:
            isoDate: true
        updatedBy:
          type: string
          description: 'Team member name, or "API key: <name>"'
          example: Jane Doe
    Model573:
      type: object
      properties:
        metric:
          $ref: '#/components/schemas/metric'
        label:
          type: string
          example: Open profit owed
        unit:
          $ref: '#/components/schemas/Model572'
        description:
          type: string
          example: Profit above the starting balance on active funded accounts
    metric:
      type: string
      example: open_profit_owed
      enum:
        - open_profit_owed
        - accounts_near_breach
        - exposure_limits_breached
    Model569:
      type: string
      example: usd
      enum:
        - usd
        - count
    lastAlert:
      type: object
      description: The latest alert of this limit since it was last changed
      properties:
        state:
          $ref: '#/components/schemas/Model570'
        value:
          type: number
          example: 262410
        at:
          type: string
          x-format:
            isoDate: true
    Model572:
      type: string
      example: usd
      enum:
        - usd
        - count
    Model570:
      type: string
      enum:
        - crossed
        - cleared
  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

- [Set your alert limits](https://docs.hyperprop.com/platform-api/risk/set-your-alert-limits.md)
- [List alerts raised by your limits](https://docs.hyperprop.com/platform-api/risk/list-alerts-raised-by-your-limits.md)
- [Get trading rules for your organization](https://docs.hyperprop.com/platform-api/trading-rules/get-trading-rules-for-your-organization.md)
- [Get purchases for your organization](https://docs.hyperprop.com/platform-api/purchases/get-purchases-for-your-organization.md)
- [Get integration health (alerts, errors, insights)](https://docs.hyperprop.com/platform-api/logs-and-health/get-integration-health-alerts-errors-insights.md)


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