> ## Documentation Index > Fetch the complete documentation index at: https://docs.limitless.exchange/llms.txt > Use this file to discover all available pages before exploring further. # Get User Positions (Public) > Retrieve all positions for a specific user address `status: RESOLVED` and `winningOutcomeIndex` indicate that the winning outcome is known in the API response. They do **not** guarantee that the underlying conditional token payout has already been settled on-chain or that the position is immediately redeemable. See [Programmatic API - Lifecycle after a trade](/developers/programmatic-api#lifecycle-after-a-trade). ## OpenAPI ````yaml GET /portfolio/{account}/positions openapi: 3.0.0 info: title: Limitless Exchange API description: >- # Limitless Exchange Trading API *Production-ready API for prediction market trading, portfolio management, and market data* > 🎯 **Quick Navigation**: [Authentication](#tag/authentication) | [Markets](#tag/markets) | [Trading](#tag/trading) | [Portfolio](#tag/portfolio) --- ## 🚀 Quick Start Choose your preferred programming language for complete end-to-end implementation: ### Overview The Limitless Exchange API offers both REST and WebSocket integration: **REST API (Trading)**: 1. **🔐 Authentication**: Use API key for all programmatic access 2. **📊 Fetch Market Data**: Get market info including venue contract addresses (once per market) 3. **📋 Order Creation**: Build and sign orders using EIP-712 structured data 4. **🚀 Order Submission**: Submit signed orders and receive confirmations **WebSocket API (Real-Time Data)**: 1. **🔌 Connection**: Connect to `/markets` namespace for real-time updates 2. **📊 Subscriptions**: Subscribe to market prices and position changes 3. **📡 Events**: Handle live market data and transaction updates ### 🔐 Authentication for API Users > **⚠️ DEPRECATION NOTICE**: Cookie-based session authentication is deprecated and will be removed within weeks. Please migrate to API keys immediately. | Method | Header | Status | |--------|--------|--------| | **API Key** | `X-API-Key: lmts_...` | ✅ Required for programmatic access | | Cookie Session | `Cookie: limitless_session=...` | ⚠️ Deprecated (removal imminent) | **Getting an API Key** API keys can only be created via the Limitless Exchange UI: 1. Log in to [limitless.exchange](https://limitless.exchange) using your wallet 2. Click your profile menu (top right) 3. Select "Api keys" 4. Generate a new key **Using Your API Key** Include in all requests via the `X-API-Key` header: ```bash # REST API curl -H "X-API-Key: lmts_your_key_here" https://api.limitless.exchange/markets # WebSocket - pass X-API-Key header during connection handshake ``` ### Migration from Cookie to API Key If you're currently using cookie-based authentication, migrate by: 1. **Generate an API key** via the UI (profile menu → Api keys) 2. **Replace cookie header** with API key header: ```diff # Before (deprecated) - Cookie: limitless_session=your_session_token # After + X-API-Key: lmts_your_key_here ``` 3. **Remove session management code** - no more login flow or cookie handling needed ### Important: Venue System for CLOB Markets CLOB markets use a **venue system** where each market is associated with specific contract addresses. Before placing orders: 1. **Fetch market data once**: `GET /markets/:slug` returns venue information 2. **Use venue.exchange**: This is the `verifyingContract` for EIP-712 order signing 3. **Cache the venue**: Venue data is static per market - fetch once and reuse **Sample venue response:** ```json { "venue": { "exchange": "0xA1b2C3...", "adapter": "0xD4e5F6..." } } ``` ### Required Approvals Before trading, set up token approvals based on order type: | Order Type | Market Type | Approve To | |------------|-------------|------------| | BUY | All CLOB | USDC → `venue.exchange` | | SELL | Simple CLOB | CT → `venue.exchange` | | SELL | NegRisk/Grouped | CT → `venue.exchange` AND `venue.adapter` | ### Checksummed Addresses All addresses must use **checksummed format** (EIP-55 mixed-case): - Authentication: `x-account` header - Orders: `maker` and `signer` fields - Example: `0x5aAeb6053F3E94C9b9A09f33669435E7Ef1BeAed` ### Implementation Guides **[🐍 Python Quick Start](#description/-python-quick-start)** - REST API: eth-account, requests, and web3.py libraries - WebSocket: python-socketio, asyncio integration **[☕ Java Quick Start](#description/-java-quick-start)** - REST API: Web3j, OkHttp3, and Jackson libraries **[📦 Node.js/TypeScript Quick Start](#description/-nodejs-typescript-quick-start)** - REST API: viem, ethers, and cross-fetch libraries - WebSocket: socket.io-client for real-time trading - Full TypeScript support with end-to-end examples **[🔌 WebSocket Integration](#description/-websocket-integration)** - Real-time market data and position updates - Production-ready Python client with authentication --- ## 🐍 Python Quick Start Complete end-to-end Python implementation for Limitless Exchange API integration. ### 🐍 Python E2E Order Creation Guide Complete Python implementation guide is being loaded from external documentation... **Guide Contents:** - 🔐 Complete authentication flow with eth-account - 📋 Order construction with Web3.py calculations - ✍️ EIP-712 structured data signing - 🚀 Order submission with requests library - ⚠️ Comprehensive error handling - 🛠️ Production deployment considerations *For the complete Python guide, ensure the file is available at docs/scripts-samples/python-e2e-order-creation.md* ## ☕ Java Quick Start Complete end-to-end Java implementation for Limitless Exchange API integration. ### ☕ Java E2E Order Creation Guide Complete Java enterprise implementation guide is being loaded from external documentation... **Guide Contents:** - 🔐 Complete authentication flow with Web3j - 📋 Order construction with BigInteger precision - ✍️ EIP-712 structured data signing - 🚀 Order submission with OkHttp3 - ⚠️ Enterprise error handling patterns - 🏗️ Production Maven project structure *For the complete Java guide, ensure the file is available at docs/scripts-samples/java-e2e-order-creation.md* ## 📦 Node.js/TypeScript Quick Start Complete end-to-end Node.js/TypeScript implementation for trading and WebSocket subscriptions. ### 📦 Node.js/TypeScript Trading & WebSocket Guide Complete Node.js/TypeScript implementation guide is being loaded from external documentation... **Guide Contents:** - 🔐 **Authentication**: Wallet-based auth with ethers and viem - 📋 **Order Creation**: EIP-712 signing with viem WalletClient - 🚀 **Order Submission**: REST API integration with cross-fetch - 🔌 **WebSocket Subscriptions**: socket.io-client for real-time updates - 📊 **Market Data**: AMM prices and CLOB orderbook subscriptions - ⚠️ **Type Safety**: Full TypeScript support with proper types - 🛠️ **Production Ready**: Complete end-to-end working example **Key Features:** - **Combined Subscriptions**: Subscribe to both AMM and CLOB markets simultaneously - **Authentication Flow**: Complete wallet-based authentication with session management - **Trading Integration**: Place orders and receive real-time updates - **TypeScript First**: Type-safe implementation with proper interfaces *For the complete Node.js guide, ensure the file is available at docs/scripts-samples/node-socket-trading-and-subscribe.md* ## 🔌 WebSocket Integration Real-time market data and position updates using WebSocket connections. ### 🔌 WebSocket Real-Time Integration Guide Complete WebSocket implementation guide is being loaded from external documentation... **Guide Contents:** - 🔌 **WebSocket Connection**: python-socketio client with async support - 🔐 **Authentication**: JWT session cookie integration - 📊 **Market Subscriptions**: Real-time price updates and position changes - ⚡ **Event Handling**: Comprehensive event processing patterns - 🔄 **Auto-Reconnection**: Production-ready reconnection logic - 🛠️ **Error Recovery**: Robust error handling and fallback strategies **Key Features:** - **Public Mode**: Market price updates without authentication - **Authenticated Mode**: Full access to positions and transactions - **Multi-Market Support**: Subscribe to multiple markets simultaneously - **Production Ready**: Tested patterns for production deployment *For the complete WebSocket guide, ensure the file is available at docs/scripts-samples/python-socket-subscribe.md* version: '1.0' contact: name: API Support url: https://limitless.exchange email: hey@limitless.network servers: - url: https://api.limitless.exchange description: Production API security: [] tags: - name: Authentication description: User authentication and session management - name: Markets description: Browse, search, and analyze prediction markets - name: Market Navigation description: Navigation tree, market pages, and property filters - name: Trading description: Create, manage, and cancel orders - name: Portfolio description: Position tracking, trade history, and performance - name: Feed description: Public trading activity feeds paths: /portfolio/{account}/positions: get: tags: - Public Portfolio summary: Get All User Positions description: Retrieve all positions for a specific user address operationId: PublicPortfolioController_getPositions parameters: - name: account required: true in: path description: User Ethereum address schema: example: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e' type: string responses: '200': description: Complete list of user positions content: application/json: schema: $ref: '#/components/schemas/PortfolioPositionsDto' '400': description: Invalid Ethereum address components: schemas: PortfolioPositionsDto: type: object properties: rewards: description: Rewards information for the portfolio allOf: - $ref: '#/components/schemas/PortfolioRewardsDto' points: type: number description: User points example: 123 accumulativePoints: type: number description: User accumulative points example: 456 amm: description: List of AMM positions type: array items: $ref: '#/components/schemas/AmmPositionDto' clob: description: List of CLOB positions type: array items: $ref: '#/components/schemas/ClobPositionDto' group: description: Grouped CLOB positions (if enabled) type: array items: type: object required: - rewards - points - accumulativePoints - amm - clob PortfolioRewardsDto: type: object properties: todaysRewards: type: string description: Rewards earned today in token decimals example: '50250000' totalUnpaidRewards: type: string description: Total unpaid rewards in token decimals example: '200750000' totalUserRewardsLastEpoch: type: string description: Total user rewards from the last epoch in token decimals example: '150500000' rewardsChartData: description: Chart data showing rewards over time type: array items: $ref: '#/components/schemas/PortfolioRewardsChartEntryDto' rewardsByEpoch: description: Rewards data by epoch type: array items: $ref: '#/components/schemas/EpochRewardDataDto' required: - todaysRewards - totalUnpaidRewards - totalUserRewardsLastEpoch - rewardsByEpoch AmmPositionDto: type: object properties: collateralAmount: type: string description: Amount of collateral invested in token decimals example: '100500000' latestTrade: type: object description: Latest trade associated with this position market: type: object description: Market information for this position outcomeIndex: type: number description: Index of the outcome token example: 0 outcomeTokenAmount: type: string description: Amount of outcome tokens held in token decimals example: '50250000' account: type: string description: Wallet address that was used to create this position example: '0x1234567890123456789012345678901234567890' required: - market - outcomeIndex ClobPositionDto: type: object properties: market: description: Market information allOf: - $ref: '#/components/schemas/Market' positions: description: Position data for the market allOf: - $ref: '#/components/schemas/MarketPositionDataDto' latestTrade: type: object description: Latest trade prices tokensBalance: type: object description: Token balances in token decimals orders: type: object description: Order information rewards: type: object description: Rewards information for this position required: - market - positions - tokensBalance - orders PortfolioRewardsChartEntryDto: type: object properties: timestamp: type: number description: Timestamp of the rewards entry example: 1672531200000 userRewards: type: string description: User rewards for this timestamp in token decimals example: '25000000' totalRewards: type: string description: Total rewards for this timestamp in token decimals example: '60000000' required: - timestamp - userRewards - totalRewards EpochRewardDataDto: type: object properties: epochId: type: number description: Unique identifier of the epoch example: 1 timestamp: format: date-time type: string description: Timestamp when the epoch occurred example: '2024-01-01T00:00:00.000Z' totalRewards: type: string description: Total rewards distributed in this epoch in token decimals example: '1500000' userRewards: type: string description: User rewards earned in this epoch in token decimals example: '150000' earnedPercent: type: number description: Part of total rewards earned by the user - [0; 1] example: 0.1 required: - epochId - timestamp - totalRewards - userRewards - earnedPercent Market: type: object properties: address: type: object description: The address of the FixedProductMarketMaker contract. minLength: 42 maxLength: 42 nullable: true uniqueItems: true title: type: string description: >- Represents the question of the market, the title metadata of the market. nullable: false uniqueItems: true proxyTitle: type: string maxLength: 120 default: null nullable: true uniqueItems: true description: type: string description: The description of the market. uniqueItems: false nullable: false question_id: type: object description: The bytes32 parsed title of the market. minLength: 66 maxLength: 66 uniqueItems: true nullable: true condition_id: type: object description: >- The bytes32 conditionId of the market, representing the conditions defined on condition preparation. minLength: 66 maxLength: 66 nullable: true uniqueItems: true position_ids: description: Array of position IDs (max 2 elements) maxItems: 2 nullable: true items: type: array type: array outcome_slot_count: type: number description: The number of outcomes in the market. minimum: 2 maximum: 2 nullable: false default: 2 winning_index: type: number description: The outcome index that was reported by the oracle. minimum: 0 maximum: 1 nullable: true payout_numerators: description: The oracle payout numerators that the oracle reported. nullable: true type: array items: type: string status: type: object description: Indicates the status of the market. nullable: false og_url: type: string description: The URL of the market OG image for SEO. nullable: true image_url: type: string description: The URL of the market logo image for SEO. nullable: true deadline: type: string description: The deadline of the market. nullable: false startAt: format: date-time type: string description: The start time of the market. nullable: true hidden: type: boolean default: false txHash: type: string default: null resolutionTxHash: type: string default: null priority_index: type: number default: null required: - address - title - proxyTitle - description - question_id - condition_id - position_ids - outcome_slot_count - winning_index - payout_numerators - status - og_url - image_url - deadline - startAt - hidden - txHash - resolutionTxHash - priority_index MarketPositionDataDto: type: object properties: 'yes': description: Position data for YES outcome example: cost: '75000000' fillPrice: '750000' realisedPnl: '0' unrealizedPnl: '25000000' marketValue: '100000000' allOf: - $ref: '#/components/schemas/PositionDataDto' 'no': description: Position data for NO outcome example: cost: '25000000' fillPrice: '250000' realisedPnl: '0' unrealizedPnl: '-5000000' marketValue: '20000000' allOf: - $ref: '#/components/schemas/PositionDataDto' required: - 'yes' - 'no' PositionDataDto: type: object properties: cost: type: string description: Cost basis of the position in token decimals (e.g. 1 USDC = 1000000) example: '75000000' fillPrice: type: string description: >- Average fill price of the position (price per share in token decimals) example: '750000' realisedPnl: type: string description: Realized profit/loss from closed positions in token decimals example: '0' unrealizedPnl: type: string description: >- Unrealized profit/loss based on current market price in token decimals example: '25000000' marketValue: type: string description: Current market value of the position in token decimals example: '100000000' required: - cost - fillPrice - realisedPnl - unrealizedPnl - marketValue ````