> ## 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 top traders over time > Your organization's top traders by profit over a recent window, with each trader's running total for every trading day, so you can show how the ranking developed. ## Shape `traders` lists the top traders by total profit over the window, highest first, with a display name and profile picture where the trader has set one. `frames` has one entry per trading day in order; `values` maps each trader's `userId` to their running total up to and including that day. A trader's profit is the sum over all of their accounts at your organization. Reverted trading days are excluded. Results refresh at most every 15 minutes; daily profit is final after each trading day closes. ## Filters | Parameter | Type | Example | Description | |-----------|------|---------|-------------| | `days` | integer 7–90 | `30` | Calendar days to cover. Defaults to 30 | | `limit` | integer 3–20 | `12` | Number of traders. Defaults to 12 | ## Error codes | HTTP | Code | When | |------|------|------| | 400 | `VALIDATION_ERROR` | days or limit is out of range | | 401 | `UNAUTHORIZED` | Missing or invalid API key | | 403 | `FORBIDDEN` | Credentials do not belong to any organization | | 500 | `TOP_TRADERS_ERROR` | Internal error | ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics/top-traders?days=30&limit=10" \ -H "X-API-Key: hp_live_your_key_here" ``` **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/organization/analytics/top-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: 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: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - 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/analytics/top-traders: get: tags: - Analytics summary: Get top traders over time description: >- Your organization's top traders by profit over a recent window, with each trader's running total for every trading day, so you can show how the ranking developed. ## Shape `traders` lists the top traders by total profit over the window, highest first, with a display name and profile picture where the trader has set one. `frames` has one entry per trading day in order; `values` maps each trader's `userId` to their running total up to and including that day. A trader's profit is the sum over all of their accounts at your organization. Reverted trading days are excluded. Results refresh at most every 15 minutes; daily profit is final after each trading day closes. ## Filters | Parameter | Type | Example | Description | |-----------|------|---------|-------------| | `days` | integer 7–90 | `30` | Calendar days to cover. Defaults to 30 | | `limit` | integer 3–20 | `12` | Number of traders. Defaults to 12 | ## Error codes | HTTP | Code | When | |------|------|------| | 400 | `VALIDATION_ERROR` | days or limit is out of range | | 401 | `UNAUTHORIZED` | Missing or invalid API key | | 403 | `FORBIDDEN` | Credentials do not belong to any organization | | 500 | `TOP_TRADERS_ERROR` | Internal error | ## Example ```bash curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics/top-traders?days=30&limit=10" \ -H "X-API-Key: hp_live_your_key_here" ``` **Authentication:** send your organization API key in the `X-API-Key` header. operationId: getV1OrganizationAnalyticsToptraders parameters: - description: Calendar days to cover (7–90). Defaults to 30. name: days in: query schema: type: integer minimum: 7 maximum: 90 default: 30 - description: Number of top traders (3–20). Defaults to 12. name: limit in: query schema: type: integer minimum: 3 maximum: 20 default: 12 responses: '200': description: Success — top traders and their running profit per trading day content: '*/*': schema: $ref: '#/components/schemas/TopTradersResponse' '400': description: Validation error — days or limit out of range content: '*/*': schema: $ref: '#/components/schemas/Model249' '401': description: Unauthorized — missing or invalid API key content: '*/*': schema: $ref: '#/components/schemas/Model250' '403': description: >- Forbidden — authenticated user is not associated with any organization content: '*/*': schema: $ref: '#/components/schemas/Model251' '500': description: Internal error content: '*/*': schema: $ref: '#/components/schemas/Model252' security: - X-API-Key: [] components: schemas: TopTradersResponse: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model248' Model249: 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: '"days" must be less than or equal to 90' code: type: string description: Machine-readable error code — switch on this, not on message text example: VALIDATION_ERROR Model250: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired token code: type: string example: UNAUTHORIZED Model251: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: You do not belong to any organization code: type: string example: FORBIDDEN Model252: type: object properties: statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An error occurred fetching top traders code: type: string example: TOP_TRADERS_ERROR Model248: type: object properties: organizationId: type: string example: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 organizationName: type: string example: Acme Trading generatedAt: type: string example: '2026-10-11T10:30:00.000Z' x-format: isoDate: true days: type: integer example: 30 traders: $ref: '#/components/schemas/Model247' frames: $ref: '#/components/schemas/frames' Model247: type: array description: Top traders by total profit over the window, highest first items: $ref: '#/components/schemas/TopTrader' frames: type: array description: One frame per trading day; values are running totals per userId items: $ref: '#/components/schemas/TopTradersFrame' TopTrader: type: object properties: userId: type: string example: 7e7bbd25-d873-42f4-834f-bda2bf5c16c8 name: type: string example: Ana Ruiz avatarUrl: type: string example: https://example.com/avatars/ana.png totalPnl: type: number example: 18420.5 TopTradersFrame: type: object properties: tradingDay: type: string example: '2026-10-09' values: type: object example: 7e7bbd25-d873-42f4-834f-bda2bf5c16c8: 12650 properties: string: type: number securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Get all-months billing aggregates](/platform-api/billing/get-all-months-billing-aggregates.md) - [Get your organization profile](/platform-api/organization-profile/get-your-organization-profile.md) - [Changelog](/changelog.md) - [Update your organization profile](/platform-api/organization-profile/update-your-organization-profile.md) - [Get an account's order event timeline](/platform-api/trading-accounts/get-an-accounts-order-event-timeline.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.