Position Management
Get Positions
Get all positions for a specific wallet address
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
Ethereum wallet address to retrieve positions for.Format: 42-character hex string starting with “0x”
Example: “0x742d35cc6C6C7532B1140Da4C8A2f6C8ECfC9B46”
Example: “0x742d35cc6C6C7532B1140Da4C8A2f6C8ECfC9B46”
Response Structure
Position Collections
Currently active positions with reserved margin
Positions manually closed by user, may be pending payout
Positions fully processed (liquidated or payout completed)
Position Object Properties
Unique identifier for the position (contract position ID)
Trading pair symbol (e.g., “BTC-USD”, “ETH-USD”, “SOL-USD”, “BNB-USD”, “XRP-USD”, “HYPE-USD”)
Owner’s wallet address (lowercase hex format)
Position size in base asset units (positive=long, negative=short)
Initial margin amount used to open the position (USD)
Price at which the position was opened
Price at which the position will be liquidated
Price at which position was closed (null for open positions)
Final realized profit/loss when closed (0.00 for open positions)
Total fees paid on the position (0.00 for open positions)
Position status: “open”, “closed”, or “settled”
ISO timestamp when the position was created
ISO timestamp when the position was closed (null for open positions)
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
Invalid wallet address format
Wallet address not found in system (no positions)
Related Endpoints
- Dashboard - Includes position data plus other account information
- Queue Positions - Check payout queue status for closed positions
- Close Position - Close open positions manually
- Emergency Exit - Emergency exit from positions