> ## 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 active traders

> Returns how many traders had a live account at any time in a period, the same
figure for the period of equal length before it, and the number of traders
live on each day.

A live account is one with status `in_progress` or `not_started`. An account
counts as live from its `createdAt` until it ended (passed, failed, expired
or turned inactive), so a trader whose account failed during the period still
counts for that period. Each trader counts once, however many accounts they
hold. `type` counts only accounts of that type.

**Previous period:** `previousActiveTraders` covers the same length of time
directly before `startDate` (null without one).

**Range limit:** `startDate` to `endDate` (or to now) may span at most
1096 days (three years); a longer range returns `400 DATE_RANGE_TOO_LONG`.
For a longer view, leave out `startDate` or request consecutive ranges.

**Daily values:** `activity` has one point per UTC day, from the start of the
previous period to `endDate` (the 365 days up to `endDate` without a
`startDate`), counting the traders with a live account at any time that day.

**All traders:** `allTimeTraders` is every trader added to your organization,
whatever their accounts, the same population as `summary.totalTraders` in
GET /organization/analytics.

Figures may be up to a few minutes old. A range that ends now (its end is less than an hour ago, or later) is read in full hours: the start moves back to the full hour and the end covers everything up to now. A range that ended earlier is read exactly as sent.

**Example:**
```http
GET /organization/trading-accounts/active-traders?startDate=2026-07-01&endDate=2026-07-31
```

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

**Authentication:** send your organization API key in the `X-API-Key` header.

**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/trading-accounts/active-traders
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/trading-accounts/active-traders:
    get:
      tags:
        - Trading accounts
      summary: Get active traders
      description: >-
        Returns how many traders had a live account at any time in a period, the
        same

        figure for the period of equal length before it, and the number of
        traders

        live on each day.


        A live account is one with status `in_progress` or `not_started`. An
        account

        counts as live from its `createdAt` until it ended (passed, failed,
        expired

        or turned inactive), so a trader whose account failed during the period
        still

        counts for that period. Each trader counts once, however many accounts
        they

        hold. `type` counts only accounts of that type.


        **Previous period:** `previousActiveTraders` covers the same length of
        time

        directly before `startDate` (null without one).


        **Range limit:** `startDate` to `endDate` (or to now) may span at most

        1096 days (three years); a longer range returns `400
        DATE_RANGE_TOO_LONG`.

        For a longer view, leave out `startDate` or request consecutive ranges.


        **Daily values:** `activity` has one point per UTC day, from the start
        of the

        previous period to `endDate` (the 365 days up to `endDate` without a

        `startDate`), counting the traders with a live account at any time that
        day.


        **All traders:** `allTimeTraders` is every trader added to your
        organization,

        whatever their accounts, the same population as `summary.totalTraders`
        in

        GET /organization/analytics.


        Figures may be up to a few minutes old. A range that ends now (its end
        is less than an hour ago, or later) is read in full hours: the start
        moves back to the full hour and the end covers everything up to now. A
        range that ended earlier is read exactly as sent.


        **Example:**

        ```http

        GET
        /organization/trading-accounts/active-traders?startDate=2026-07-01&endDate=2026-07-31

        ```


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


        **Authentication:** send your organization API key in the `X-API-Key`
        header.


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Traders & accounts.
      operationId: getV1OrganizationTradingaccountsActivetraders
      parameters:
        - description: >-
            Start of the period. Without it, every trader who ever had an
            account counts.
          x-format:
            isoDate: true
          name: startDate
          in: query
          required: false
          example: '2026-07-01'
          schema:
            type: string
        - description: >-
            End of the period (a plain date includes the whole day). Defaults to
            now.
          x-format:
            isoDate: true
          name: endDate
          in: query
          required: false
          example: '2026-07-31'
          schema:
            type: string
        - description: Only count accounts of this type
          name: type
          in: query
          required: false
          example: evaluation
          schema:
            type: string
            enum:
              - evaluation
              - sim_funded
              - competition
        - 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: Active traders in the period and the period before
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model793'
        '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 query or endDate before startDate (`VALIDATION_ERROR`), or a
            range longer than 1096 days (`DATE_RANGE_TOO_LONG`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model794'
        '401':
          description: Missing, invalid or revoked API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 401
                  error:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Invalid or missing API key
                  code:
                    type: string
                    enum:
                      - UNAUTHORIZED
                    example: UNAUTHORIZED
                    description: >-
                      Machine-readable error code — switch on this, not on
                      message text
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model86'
        '429':
          description: >-
            Too many requests to this endpoint. Try again in 12 second(s). Also
            returned while your organization already has 6 reports being
            computed at once; wait the `Retry-After` seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model795'
        '500':
          description: An unexpected error occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model10'
        '503':
          description: >-
            The report took too long right now (`REPORT_TIMEOUT`). Wait the
            seconds in the `Retry-After` header (also `retryAfterSeconds` in the
            body) before asking again; the wait grows while the report keeps
            running out of time.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 503
                  error:
                    type: string
                    example: Service Unavailable
                  message:
                    type: string
                    example: The report took too long right now; try again later
                  code:
                    type: string
                    enum:
                      - REPORT_TIMEOUT
                    example: REPORT_TIMEOUT
                    description: >-
                      Machine-readable error code — switch on this, not on
                      message text
        '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/Model796'
      security:
        - X-API-Key: []
components:
  schemas:
    Model793:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model792'
    Model794:
      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: The range from startDate to endDate may be at most 1096 days
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: DATE_RANGE_TOO_LONG
    Model86:
      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: Access denied
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: FORBIDDEN
    Model795:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          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
          description: Machine-readable error code — switch on this, not on message text
          example: RATE_LIMITED
    Model10:
      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: An unexpected error occurred
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INTERNAL_ERROR
    Model796:
      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
    Model792:
      type: object
      properties:
        organizationId:
          type: string
          description: Your organization ID
        organizationName:
          type: string
          description: Your organization name
        generatedAt:
          type: string
          description: When the counts were calculated
          x-format:
            isoDate: true
        filters:
          $ref: '#/components/schemas/Model789'
        activeTraders:
          type: integer
          description: Traders with a live account at any time in the period
          example: 412
        previousActiveTraders:
          type: integer
          description: >-
            The same for the period of equal length before startDate; null
            without startDate
          example: 380
        allTimeTraders:
          type: integer
          description: Every trader added to your organization
          example: 1291
        activity:
          $ref: '#/components/schemas/Model791'
    Model789:
      type: object
      properties:
        startDate:
          type: string
        endDate:
          type: string
        type:
          type: string
          example: evaluation
    Model791:
      type: array
      example:
        - date: '2026-07-20'
          activeTraders: 298
        - date: '2026-07-21'
          activeTraders: 305
      items:
        $ref: '#/components/schemas/Model790'
    Model790:
      type: object
      properties:
        date:
          type: string
          description: UTC calendar day
          example: '2026-07-21'
        activeTraders:
          type: integer
          description: Traders with a live account at any time on this day
          example: 305
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key (`hp_live_...`), sent in the `X-API-Key` header.
        Create, rotate and restrict keys in the dashboard or with the API keys
        endpoints; an organization can have two active keys, so you can rotate
        without downtime. A **full-access** key can call every endpoint in this
        reference. A **read-only** key can call `GET` endpoints (and create a
        trading stream token); any other request returns `403 READ_ONLY_KEY`. A
        key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other
        address. Each endpoint lists which keys can call it under **Access**.

````

## Related topics

- [Get a specific trader](https://docs.hyperprop.com/platform-api/traders/get-a-specific-trader.md)
- [Get traders for your organization](https://docs.hyperprop.com/platform-api/traders/get-traders-for-your-organization.md)
- [Get active working orders](https://docs.hyperprop.com/trade-api/orders/get-active-working-orders.md)
- [Get trader behavior by plan](https://docs.hyperprop.com/platform-api/risk/get-trader-behavior-by-plan.md)
- [Get daily account and trader activity](https://docs.hyperprop.com/platform-api/trading-accounts/get-daily-account-and-trader-activity.md)


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