> ## 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 an account's open positions

> The open positions of one trading account, each marked at the current price when you call, with the organization API key. No trader session or trader API key is needed.

The values are the ones the trader sees and the real-time trading stream sends: `unrealizedPnl` is the same as in `PositionUpdate` messages. An account without open positions returns an empty `positions` list.

Use it with `GET .../equity` or the many-accounts read (`GET /organization/trading-accounts/positions`) to catch up after a stream disconnect; see the real-time trading stream guide.

Requires **view** permission on traders. About 600 requests per minute per organization, shared with `GET .../equity`.

```bash
curl "https://api.hyperprop.com/platform/v1/organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/positions" \
  -H "X-API-Key: hp_live_your_key_here"
```



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/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/{accountId}/positions:
    get:
      tags:
        - Trading accounts
      summary: Get an account's open positions
      description: >-
        The open positions of one trading account, each marked at the current
        price when you call, with the organization API key. No trader session or
        trader API key is needed.


        The values are the ones the trader sees and the real-time trading stream
        sends: `unrealizedPnl` is the same as in `PositionUpdate` messages. An
        account without open positions returns an empty `positions` list.


        Use it with `GET .../equity` or the many-accounts read (`GET
        /organization/trading-accounts/positions`) to catch up after a stream
        disconnect; see the real-time trading stream guide.


        Requires **view** permission on traders. About 600 requests per minute
        per organization, shared with `GET .../equity`.


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/trading-accounts/7c9e6679-7425-40de-944b-e07fc1f90ae7/positions"
        \
          -H "X-API-Key: hp_live_your_key_here"
        ```
      operationId: getV1OrganizationTradingaccountsAccountidPositions
      parameters:
        - description: Trading account ID
          x-format:
            guid: true
          name: accountId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Open positions retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model752'
        '400':
          description: Validation failed
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model25'
        '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: Trading account not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model753'
        '429':
          description: >-
            Too Many Requests - More than about 600 requests per minute for your
            organization (`RATE_LIMITED`). Wait `retryAfterSeconds` (also in the
            `Retry-After` header).
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Model755'
        '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/Model756'
      security:
        - X-API-Key: []
components:
  schemas:
    Model752:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model751'
    Model25:
      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: Validation failed
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: VALIDATION_ERROR
    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'
    Model753:
      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: Trading account not found
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: ACCOUNT_NOT_FOUND
    Model755:
      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/Model754'
        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
    Model756:
      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
    Model751:
      type: object
      properties:
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          x-format:
            guid: true
        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'
        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
        unrealizedPnl:
          type: number
          description: Sum of `unrealizedPnl` over the open positions
          example: 41
        positions:
          $ref: '#/components/schemas/positions'
    code:
      type: string
      example: INSUFFICIENT_PERMISSIONS
      enum:
        - INSUFFICIENT_PERMISSIONS
    Model754:
      type: string
      example: RATE_LIMITED
      enum:
        - RATE_LIMITED
    positions:
      type: array
      items:
        $ref: '#/components/schemas/Model574'
    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 open positions and equity for many accounts](https://docs.hyperprop.com/platform-api/trading-accounts/get-open-positions-and-equity-for-many-accounts.md)
- [Get open positions with real-time P&L](https://docs.hyperprop.com/trade-api/positions/get-open-positions-with-real-time-p&l.md)
- [Close all open positions for an account](https://docs.hyperprop.com/trade-api/positions/close-all-open-positions-for-an-account.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)


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