Skip to main content
GET

Overview

Retrieve all positions for a specific wallet address, organized by their current status. This endpoint provides comprehensive position data including real-time PnL calculations for open positions.
This endpoint does NOT require authentication and can be called for any wallet address. Position data is publicly accessible on the blockchain.

Path Parameters

string
required
Ethereum wallet address to retrieve positions for.Format: 42-character hex string starting with “0x”
Example: “0x742d35cc6C6C7532B1140Da4C8A2f6C8ECfC9B46”

Response Structure

Position Collections

array
Currently active positions with reserved margin
array
Positions manually closed by user, may be pending payout
array
Positions fully processed (liquidated or payout completed)

Position Object Properties

integer
Unique identifier for the position (contract position ID)
string
Trading pair symbol (e.g., “BTC-USD”, “ETH-USD”, “SOL-USD”, “BNB-USD”, “XRP-USD”, “HYPE-USD”)
string
Owner’s wallet address (lowercase hex format)
string
Position size in base asset units (positive=long, negative=short)
string
Initial margin amount used to open the position (USD)
string
Price at which the position was opened
string
Price at which the position will be liquidated
string
Price at which position was closed (null for open positions)
string
Final realized profit/loss when closed (0.00 for open positions)
string
Total fees paid on the position (0.00 for open positions)
string
Position status: “open”, “closed”, or “settled”
string
ISO timestamp when the position was created
string
ISO timestamp when the position was closed (null for open positions)
string
ISO timestamp when position was fully settled (null for open/closed positions)

Position Status Definitions

Open Positions

  • Status: “open”
  • Characteristics: Active positions with ongoing market exposure
  • PnL: Real-time unrealized profit/loss calculations
  • Actions: Can be closed manually or liquidated automatically
  • Margin: Reserved from account balance

Closed Positions

  • Status: “closed”
  • Characteristics: Manually closed by user through Close Position
  • PnL: Final realized profit/loss (unrealizedPnl shows 0)
  • Closure: User-initiated at market price
  • Settlement: Immediate or queued based on available funds

Settled Positions

  • Status: “liquidated” or “settled”
  • Characteristics: Automatically closed by the system
  • Liquidation: Closed when reaching liquidation price
  • Settlement: System-initiated closure
  • Timing: Occurs automatically based on market conditions

Error Responses

object
Invalid wallet address format
object
Wallet address not found in system (no positions)
Monitor open positions frequently as unrealized PnL changes with market prices. Consider setting up alerts for positions approaching liquidation.
Position data includes sensitive trading information. While publicly accessible, use appropriate security measures when displaying this data in applications.

Path Parameters

wallet_address
string
required

Ethereum wallet address

Pattern: ^0x[a-fA-F0-9]{40}$

Response

Positions retrieved successfully

openPositions
object[]
closedPositions
object[]
settledPositions
object[]