> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shuriken.trade/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Positions



## OpenAPI

````yaml GET /api/v2/perp/positions
openapi: 3.0.3
info:
  description: Multi-chain DEX trading API for developers
  license:
    name: ''
  title: Shuriken API v2
  version: 2.0.0
servers:
  - url: https://api.shuriken.trade
security: []
tags:
  - description: SplitNOW cross-chain split plan + execute
    name: V2 Splits
  - description: Wallet archive lifecycle (archive / unarchive / bulk-archive)
    name: Wallets
  - description: Token discovery, metadata, and pricing
    name: V2 Tokens
  - description: Quote and execute swaps
    name: V2 Swap
  - description: Limit orders and stop-loss
    name: V2 Trigger
  - description: Managed-agent invocation
    name: V2 Agents
  - description: Portfolio positions and PnL
    name: V2 Portfolio
  - description: User account management
    name: V2 Account
  - description: WebSocket stream discovery, session bootstrap, and channel authorization
    name: V2 WebSocket
  - description: Perpetual trading on Hyperliquid
    name: V2 Perps
  - description: Agent-proposed trade suggestions
    name: V2 Suggestions
paths:
  /api/v2/perp/positions:
    get:
      tags:
        - V2 Perps
      summary: GET /api/v2/perp/positions — Open positions
      operationId: get_perp_positions
      parameters:
        - description: Wallet ID (uses default HL wallet if omitted)
          in: query
          name: wallet_id
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_PerpPositionsResponse'
          description: Open positions
      security:
        - bearer_auth: []
components:
  schemas:
    ApiResponse_PerpPositionsResponse:
      description: V2 success response envelope
      properties:
        data:
          properties:
            accountValue:
              type: string
            positions:
              items:
                $ref: '#/components/schemas/Position'
              type: array
            spotBalances:
              description: >-
                Spot-side balances on HyperCore (USDC, HYPE, etc.). Under
                Unified

                Account mode these back perp positions as margin.
              items:
                $ref: '#/components/schemas/SpotBalance'
              type: array
            totalMarginUsed:
              type: string
            totalNtlPos:
              type: string
            withdrawable:
              type: string
          required:
            - positions
            - accountValue
            - totalMarginUsed
            - totalNtlPos
            - withdrawable
          type: object
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
          nullable: true
        requestId:
          type: string
      required:
        - data
        - requestId
      type: object
    Position:
      properties:
        coin:
          type: string
        entryPx:
          type: string
        leverageType:
          type: string
        leverageValue:
          type: string
        liquidationPx:
          type: string
        marginUsed:
          type: string
        positionValue:
          type: string
        returnOnEquity:
          type: string
        szi:
          type: string
        unrealizedPnl:
          type: string
      required:
        - coin
        - szi
        - entryPx
        - unrealizedPnl
        - returnOnEquity
        - liquidationPx
        - leverageType
        - leverageValue
        - marginUsed
        - positionValue
      type: object
    SpotBalance:
      properties:
        coin:
          type: string
        hold:
          type: string
        total:
          type: string
      required:
        - coin
        - total
        - hold
      type: object
    PaginationInfo:
      description: Page-based pagination info (per RFC)
      properties:
        hasMore:
          type: boolean
        limit:
          format: int32
          minimum: 0
          type: integer
        page:
          format: int32
          minimum: 0
          type: integer
        total:
          format: int32
          minimum: 0
          nullable: true
          type: integer
      required:
        - page
        - limit
        - hasMore
      type: object
  securitySchemes:
    bearer_auth:
      bearerFormat: JWT or sk_{keyId}_{secret}
      description: >-
        Use `Authorization: Bearer <jwt>` for user auth or `Authorization:
        Bearer sk_{keyId}_{secret}` for API key auth.
      scheme: bearer
      type: http

````