> ## 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 Realized PnL (Public) > Projected realised PnL timeline with backend-owned category grouping and hover breakdown for public profiles. Returns a projected realized PnL timeline for any public profile, grouped by market category with a per-point hover breakdown. The service computes values best-effort from the canonical five-minute PnL buckets available at request time. * `timeframe` — echoes the requested window (`1d`, `1w`, or `1m`). Defaults to `1w`. * `windowStart` — start of the effective timeline, anchored on the current closed UTC five-minute boundary. * `current` — realized PnL over the effective window. * `categories` — per-category realized PnL sorted descending. Markets attributed through navigation pages fall under their category slug. Anything unattributed collapses into the synthetic `other` bucket, which has no `slug`, `path`, or `icon`. * `data` — cumulative realized PnL timeline. Each point carries a `breakdown` with the top 3 named categories at that timestamp plus the synthetic `Other` residual. The legacy [`GET /portfolio/{account}/pnl-chart`](/api-reference/public-portfolio/pnl-chart) endpoint remains as the deprecated contract for existing consumers. Use this endpoint for new integrations. ## OpenAPI ````yaml GET /portfolio/{account}/realized-pnl 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}/realized-pnl: get: tags: - Public Portfolio summary: Get public profile realized PnL description: >- Projected realised PnL timeline with backend-owned category grouping and hover breakdown for public profiles. operationId: PublicPortfolioController_getRealizedPnl parameters: - name: account required: true in: path description: User Ethereum address schema: example: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e' type: string - name: timeframe required: false in: query description: >- Best-effort realised PnL timeline window from available closed five-minute buckets. schema: default: 1w type: string enum: - 1d - 1m - 1w responses: '200': description: Realized PnL timeline content: application/json: schema: $ref: '#/components/schemas/PortfolioPnlProfileDto' '400': description: Invalid Ethereum address or timeframe '404': description: User not found '503': description: Portfolio PnL is temporarily disabled components: schemas: PortfolioPnlProfileDto: type: object properties: timeframe: type: string description: Requested timeframe enum: - 1d - 1m - 1w example: 1w windowStart: type: string description: >- Requested timeline start derived from the current closed UTC five-minute boundary example: '2026-08-05T21:50:00.000Z' current: description: Current realised PnL over the selected effective timeline allOf: - $ref: '#/components/schemas/PortfolioPnlValueDto' categories: description: Period categories sorted by realised PnL descending type: array items: $ref: '#/components/schemas/PortfolioPnlProfileCategoryDto' data: description: Cumulative realised PnL timeline type: array items: $ref: '#/components/schemas/PortfolioPnlProfilePointDto' required: - timeframe - windowStart - current - categories - data PortfolioPnlValueDto: type: object properties: raw: type: string description: PnL value in base units example: '-7047204' formatted: type: string description: PnL value formatted using token decimals example: '-7.047204' usd: type: string description: PnL value formatted in USD (if available) example: '-7.047204' nullable: true required: - raw - formatted PortfolioPnlProfileCategoryDto: type: object properties: id: type: string description: Backend category id. The synthetic residual bucket uses "other". example: sport name: type: string description: Display name example: Sport slug: type: string description: Navigation slug, or null for synthetic categories example: sport nullable: true path: type: string description: Navigation path, or null for synthetic categories example: /markets/sport nullable: true icon: type: string description: Navigation icon URL/key, or null when not configured example: null nullable: true realisedPnl: description: Realised PnL for this category over the selected effective timeline allOf: - $ref: '#/components/schemas/PortfolioPnlValueDto' required: - id - name - slug - path - icon - realisedPnl PortfolioPnlProfilePointDto: type: object properties: timestamp: type: number description: Point timestamp (ms) example: 1700000000000 value: type: number description: >- Total realised PnL over the selected effective timeline at this point example: 123.45 breakdown: description: >- Point-in-time tooltip breakdown: top 3 named categories by cumulative realised PnL plus synthetic Other residual. type: array items: $ref: '#/components/schemas/PortfolioPnlProfileBreakdownDto' required: - timestamp - value - breakdown PortfolioPnlProfileBreakdownDto: type: object properties: id: type: string description: Backend category id. The synthetic residual bucket uses "other". example: sport name: type: string description: Display name example: Sport slug: type: string description: Navigation slug, or null for synthetic categories example: sport nullable: true path: type: string description: Navigation path, or null for synthetic categories example: /markets/sport nullable: true icon: type: string description: Navigation icon URL/key, or null when not configured example: null nullable: true realisedPnl: description: Realised PnL for this category over the selected effective timeline allOf: - $ref: '#/components/schemas/PortfolioPnlValueDto' required: - id - name - slug - path - icon - realisedPnl ````