> ## 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 open positions and equity for many accounts > Equity, unrealized P&L and open positions of many trading accounts in one call, with the organization API key: each account as in `GET .../equity`, plus its `positions` list (as in `GET .../positions`). Use it to catch up after a real-time stream disconnect: page through every account (or only those with open positions, `openOnly=true`), or read a specific set with `accountId`. Accounts come in account-ID order; follow `pagination.nextCursor` until it is null. Each page is read at its own `asOf`. Requires **view** permission on traders. About 60 requests per minute per organization. **Example queries:** ```http # Every account that can hold positions, 200 per page GET /organization/trading-accounts/positions?limit=200 # Only accounts with open positions GET /organization/trading-accounts/positions?openOnly=true&limit=200 # Specific accounts GET /organization/trading-accounts/positions?accountId=7c9e6679-...,9d1e6679-... ``` ```bash curl "https://api.hyperprop.com/platform/v1/organization/trading-accounts/positions?openOnly=true&limit=200" \ -H "X-API-Key: hp_live_your_key_here" ``` ## OpenAPI ````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/positions 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 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 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/positions: get: tags: - Trading accounts summary: Get open positions and equity for many accounts description: >- Equity, unrealized P&L and open positions of many trading accounts in one call, with the organization API key: each account as in `GET .../equity`, plus its `positions` list (as in `GET .../positions`). Use it to catch up after a real-time stream disconnect: page through every account (or only those with open positions, `openOnly=true`), or read a specific set with `accountId`. Accounts come in account-ID order; follow `pagination.nextCursor` until it is null. Each page is read at its own `asOf`. Requires **view** permission on traders. About 60 requests per minute per organization. **Example queries:** ```http # Every account that can hold positions, 200 per page GET /organization/trading-accounts/positions?limit=200 # Only accounts with open positions GET /organization/trading-accounts/positions?openOnly=true&limit=200 # Specific accounts GET /organization/trading-accounts/positions?accountId=7c9e6679-...,9d1e6679-... ``` ```bash curl "https://api.hyperprop.com/platform/v1/organization/trading-accounts/positions?openOnly=true&limit=200" \ -H "X-API-Key: hp_live_your_key_here" ``` operationId: getV1OrganizationTradingaccountsPositions parameters: - description: >- Specific accounts: one account ID or a comma-separated list (max 200). Every ID must belong to your organization, otherwise 404 ACCOUNT_NOT_FOUND. `status`, `limit` and `cursor` do not apply. name: accountId in: query required: false schema: type: string - description: >- Account statuses to include, comma-separated. Default: `not_started,in_progress,inactive`, every account that can hold positions. name: status in: query required: false schema: type: string pattern: >- ^(not_started|in_progress|inactive|passed|failed|expired)(,(not_started|in_progress|inactive|passed|failed|expired))*$ - description: >- `true`: leave out accounts without open positions. A page can then hold fewer than `limit` accounts; keep following `nextCursor` until it is null. name: openOnly in: query schema: type: boolean default: false - description: Accounts per page (default 100, max 200) name: limit in: query schema: type: integer minimum: 1 maximum: 200 default: 100 - description: >- Cursor for pagination. Pass the `nextCursor` value from the previous response to get the next page. When using cursor, do not send `offset` — it will be ignored. **How it works:** The cursor is an opaque string that points to the last item you received. The server uses it to efficiently fetch the next set of results without scanning previous pages. **Backwards compatible:** If you don't send a cursor, offset/limit pagination works as before. name: cursor in: query required: false schema: type: string responses: '200': description: Accounts retrieved content: '*/*': schema: $ref: '#/components/schemas/Model579' '400': description: >- Bad Request - Invalid parameter (`VALIDATION_ERROR`), more than 200 account IDs (`TOO_MANY_ACCOUNT_IDS`), an ID that is not a trading account ID (`INVALID_ACCOUNT_ID`) or an invalid cursor (`INVALID_CURSOR`) content: '*/*': schema: $ref: '#/components/schemas/Model581' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model11' '403': description: >- Forbidden - The caller lacks traders:view (`INSUFFICIENT_PERMISSIONS`) content: '*/*': schema: $ref: '#/components/schemas/Model582' '404': description: >- Account(s) not found in your organization: 9d1e6679-7425-40de-944b-e07fc1f90ae8 content: '*/*': schema: $ref: '#/components/schemas/Model583' '429': description: >- Too Many Requests - More than about 60 requests per minute for your organization (`RATE_LIMITED`). Wait `retryAfterSeconds` (also in the `Retry-After` header). content: '*/*': schema: $ref: '#/components/schemas/Model585' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model6' '503': description: Live account state is temporarily unavailable; retry shortly content: '*/*': schema: $ref: '#/components/schemas/Model586' '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: '*/*': schema: $ref: '#/components/schemas/Model587' security: - X-API-Key: [] components: schemas: Model579: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model578' Model581: type: object properties: success: type: boolean example: false statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: accountId accepts at most 200 IDs per request code: $ref: '#/components/schemas/Model580' Model11: 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 Model582: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Your role does not have view access to "Traders & accounts" code: $ref: '#/components/schemas/code' Model583: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: >- Account(s) not found in your organization: 9d1e6679-7425-40de-944b-e07fc1f90ae8 code: type: string description: Machine-readable error code — switch on this, not on message text example: ACCOUNT_NOT_FOUND Model585: type: object properties: success: type: boolean example: false statusCode: type: number example: 429 error: type: string example: Too Many Requests message: type: string example: Too many live state requests; retry in 12s code: $ref: '#/components/schemas/Model584' retryAfterSeconds: type: integer example: 12 Model6: 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 Model586: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 503 error: type: string example: Error message: type: string example: Live account state is temporarily unavailable; retry shortly code: type: string description: Machine-readable error code — switch on this, not on message text example: LIVE_STATE_UNAVAILABLE Model587: 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 Model578: type: object properties: organizationId: type: string description: Your organization ID asOf: type: string description: >- When the read started. Every value reflects all changes up to at least this time. example: '2026-10-30T14:41:07.118Z' accounts: $ref: '#/components/schemas/Model576' pagination: $ref: '#/components/schemas/Model577' Model580: type: string example: TOO_MANY_ACCOUNT_IDS enum: - VALIDATION_ERROR - TOO_MANY_ACCOUNT_IDS - INVALID_ACCOUNT_ID - INVALID_CURSOR code: type: string example: INSUFFICIENT_PERMISSIONS enum: - INSUFFICIENT_PERMISSIONS Model584: type: string example: RATE_LIMITED enum: - RATE_LIMITED Model576: type: array items: $ref: '#/components/schemas/Model575' Model577: type: object properties: limit: type: integer example: 100 hasMore: type: boolean example: false nextCursor: type: string description: Pass as `?cursor=` for the next page. Null on the last page. example: null Model575: type: object properties: accountId: type: string example: 7c9e6679-7425-40de-944b-e07fc1f90ae7 x-format: guid: true accountNumber: type: string example: ACC-50K-000123 customerId: type: string description: Your customer ID for this account, if set example: crm-cust-4471 status: $ref: '#/components/schemas/Model573' currentBalance: type: number description: >- Balance after the last booked fill (realized P&L, fees and commissions applied), the live value example: 50300 unrealizedPnl: type: number description: Sum of `unrealizedPnl` over the open positions example: 41 equity: type: number description: >- `currentBalance + unrealizedPnl`, the same value as `equity` on the stream's `AccountUpdate` example: 50341 initialBalance: type: number example: 50000 highWaterMark: type: number description: Peak used by trailing drawdown rules example: 50500 dailyStartingBalance: type: number description: Balance at the start of the current trading day example: 50100 dailyPnl: type: number description: >- `currentBalance − dailyStartingBalance`: closed trades only, as `dailyPnl` on the account read and `daily_pnl` on the stream example: 200 dailyPnlWithUnrealized: type: number description: >- `equity − dailyStartingBalance`: the day's result including open positions example: 241 totalPnl: type: number description: '`currentBalance − initialBalance`: closed trades only' example: 300 currentDrawdown: type: number description: >- `highWaterMark − equity`, never below 0; `current_drawdown` on the stream example: 159 lossFloorBalance: type: number description: >- The loss floor locked at a payout, if any (as on the account read). Null when none is locked. example: null positionsVersion: type: integer description: >- The account's position version at this read. Stream `PositionUpdate` messages with a lower `state_version` are older than this read and can be skipped. example: 12 riskLimits: $ref: '#/components/schemas/riskLimits' positions: $ref: '#/components/schemas/positions' Model573: type: string example: in_progress enum: - not_started - in_progress - inactive - passed - failed - expired riskLimits: type: object description: >- Loss floors and profit target as absolute balances, from the same rule check that enforces them. Null when Hyperprop has no live limits for the account, for example one that is no longer active. properties: maxLossFloor: type: number description: >- Balance at which the account fails: when equity, net of `estimatedClosingFees`, reaches it, open positions are closed and the account fails. The highest of the floor locked at a payout (`lossFloorBalance`), `initialBalance − maxLoss` and the drawdown floor. Null when the rule has no max loss or drawdown limit. example: 48500 maxLossFloorType: $ref: '#/components/schemas/maxLossFloorType' trailingLocked: type: boolean description: >- True when the floor no longer moves up: a trailing or end-of-day floor that reached its cap (the rule's trail ceiling above the initial balance), or a floor locked at a payout example: false dailyLossFloor: type: number description: >- Balance at which the trading day ends: when equity, net of `estimatedClosingFees`, reaches it, open positions are closed and trading stops until the next daily reset; the account does not fail. The higher of `dailyStartingBalance − dailyLoss` and the daily percentage drawdown floor. Null when the rule has no daily loss limit or it is switched off (`dailyLossLimitOff`). example: 49100 dailyLossLimitActive: type: boolean description: True when a daily loss limit applies today (`dailyLossFloor` is set) example: true dailyLossLimitOff: type: boolean description: >- True when the account's daily loss limit has been switched off (see `dailyLossOff` on the account read) example: false profitTarget: type: number description: >- Balance at which the profit target is reached: `initialBalance + profitTarget`. Null when the rule has no profit target and for funded accounts. example: 53000 estimatedClosingFees: type: number description: >- Commissions and fees closing every open position now would cost. Limits are judged on equity minus this amount. example: 1.24 distanceToMaxLoss: type: number description: >- `equity − estimatedClosingFees − maxLossFloor`: how far equity can fall before the account fails. The account fails when it reaches 0 (for a drawdown limit, once it is below 0). example: 1838.76 distanceToDailyLoss: type: number description: >- `equity − estimatedClosingFees − dailyLossFloor`: how far equity can fall before the trading day ends; it ends at 0 example: 1238.76 positions: type: array items: $ref: '#/components/schemas/Model574' maxLossFloorType: type: string description: >- Which limit sets `maxLossFloor`: `static` (from the initial balance: max loss, or a static drawdown), `trailing` (drawdown from the highest equity reached, open positions included), `eod` (drawdown from the highest end-of-day balance; moves at the daily reset) or `locked` (the floor locked at a payout). example: trailing enum: - static - trailing - eod - locked Model574: type: object properties: positionId: type: string description: >- Stable ID of this position from open to flat: unchanged by adds, partial closes and a reversal through zero in one fill; a position reopened after flat gets a new ID. Same as `position.position_id` on the real-time stream with `v=2`. example: 3f6c1d2e-8a4b-5c7d-9e0f-1a2b3c4d5e6f x-format: guid: true contract: type: string description: Contract symbol, as on the real-time stream example: MNQZ6 side: $ref: '#/components/schemas/side' quantity: type: number description: >- Open size, always positive (`side` gives the direction). Futures: contracts. Perpetuals: increments of the contract's `quantityStep`, as on the real-time stream, where `quantity` is signed (negative = short). example: 2 avgEntryPrice: type: number description: Volume-weighted average entry price example: 20000.25 markPrice: type: number description: >- Price `unrealizedPnl` was computed at. Null when no current price is available; `unrealizedPnl` is then the value at the position's last change. example: 20010.5 markedAt: type: string description: When `unrealizedPnl` was computed (null with `markPrice`) example: '2026-10-30T14:41:07.250Z' unrealizedPnl: type: number description: Open profit or loss at `markPrice`, before closing fees example: 41 realizedPnl: type: number description: >- Gross profit or loss already taken by partial closes of this position (fees not included) example: 0 isolatedMargin: type: number description: 'Perpetuals in isolated margin only: the margin backing the position' example: null openedAt: type: string description: >- When the position opened from flat; unchanged by adds and partial closes example: '2026-10-30T14:30:00.000Z' updatedAt: type: string description: When the position last changed (fill or margin change) example: '2026-10-30T14:35:12.000Z' stateVersion: type: integer description: >- The account's position version at this position's last change. Same as `state_version` on the stream's `PositionUpdate`: an update with a lower version is older than this read. example: 12 side: type: string example: long enum: - long - short 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 an account's open positions](https://docs.hyperprop.com/platform-api/trading-accounts/get-an-accounts-open-positions.md) - [Get an account's equity and unrealized P&L](https://docs.hyperprop.com/platform-api/trading-accounts/get-an-accounts-equity-and-unrealized-p&l.md) - [Real-time trading stream](https://docs.hyperprop.com/guides/realtime-trading-stream.md) - [Get current trading account with equity and P&L](https://docs.hyperprop.com/trade-api/account/get-current-trading-account-with-equity-and-p&l.md) - [Rate limits & quotas](https://docs.hyperprop.com/concepts/rate-limits.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.