> ## Documentation Index > Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt > Use this file to discover all available pages before exploring further. # List positions > Open and resolved positions, one per market. `redeemStatus` turns `eligible` once a market resolves in the user's favour. Needs a linked Agg session (`POST /link`). Not available to account-abstracted clients. ## OpenAPI ````yaml /openapi/client-api.yaml get /clients/me/integrations/agg/positions openapi: 3.1.0 info: title: Portal Client API version: '3.0' description: > The Portal Client API provides endpoints for managing wallets, building transactions, and interacting with blockchain networks. All endpoints require authentication via a Client API Key or Client Session Token (CST) passed as a Bearer token. ## Base URL `https://api.portalhq.io/api/v3` ## Authentication Include your Client API Key or Client Session Token as a Bearer token in the `Authorization` header of every request. ## Chain ID Format Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or CAIP-2 format (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using CAIP-2 format in URLs, ensure the colon is URI-encoded (`%3A`). ## Support requests Every response carries an `X-Trace-Id` header. Include it when you contact support about a request, so Portal can find that exact request in its logs. servers: - url: https://api.portalhq.io/api/v3 description: Production security: - bearerAuth: [] tags: - name: Clients description: Core client management endpoints - name: Wallet description: >- Read wallet state — balances, NFTs, transaction history, capabilities, and transaction details - name: Transactions description: Build, broadcast, and evaluate blockchain transactions - name: Funding description: Fund wallets with testnet tokens - name: Wallet Shares description: Manage signing and backup share pairs - name: Delegations description: Manage token approvals, revocations, and delegated transfers - name: Session Keys description: Manage EIP-7702 session keys for smart accounts - name: 0x description: Token swap endpoints powered by the 0x protocol - name: Yield.xyz description: Yield opportunities and staking actions powered by Yield.xyz - name: Yield.xyz Borrow description: >- Supply collateral, borrow, repay and withdraw from lending markets (Aave V3, Morpho Blue, SparkLend, Lista) powered by Yield.xyz Borrow - name: Yield.xyz Perps description: >- Trade perpetual futures — open/close leveraged positions, manage stop-loss/take-profit, and fund/withdraw a trading account — powered by Yield.xyz Perps - name: Agg description: >- Prediction markets across venues (Polymarket, Kalshi and more) through one Agg account per client — powered by Agg - name: Li.Fi description: Cross-chain swaps and bridging powered by Li.Fi - name: CCTP description: >- Crosschain USDC transfers powered by Circle's Cross-Chain Transfer Protocol (CCTP) - name: Blockaid description: Transaction and address security scanning powered by Blockaid - name: Hypernative description: >- Transaction, address, token, and NFT security scanning powered by Hypernative - name: Noah description: KYC onboarding, payins, and payouts powered by Noah - name: Meld description: Buy and sell crypto with fiat through aggregated providers powered by Meld - name: Due description: Payins, payouts, virtual accounts, and FX powered by Due - name: EIP-7702 description: EIP-7702 account type detection and authorization management - name: Deprecated description: >- Legacy endpoints scheduled for removal. Use the newer equivalents listed in each endpoint's description. paths: /clients/me/integrations/agg/positions: get: tags: - Agg summary: List positions description: >- Open and resolved positions, one per market. `redeemStatus` turns `eligible` once a market resolves in the user's favour. Needs a linked Agg session (`POST /link`). Not available to account-abstracted clients. operationId: listAggPositions parameters: - name: status in: query required: false description: '`active` or `closed`.' schema: type: string enum: - active - closed - name: mode in: query required: false description: >- `live` (default) or `paper`. Paper rows only appear on reads that pass the same mode. schema: type: string enum: - live - paper - name: limit in: query required: false description: Page size, 1 to 100. schema: type: integer - name: cursor in: query required: false description: '`nextCursor` from the previous page.' schema: type: string responses: '200': description: Success content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/AggPositionsPage' '400': description: >- Invalid request, or Agg rejected it (Agg error codes are surfaced as `details.code`). Also `AGG_ACCOUNT_ABSTRACTION_UNSUPPORTED` for an account-abstracted client. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: >- Unauthorized, or the Agg session expired and could not be refreshed (`AGG_SESSION_EXPIRED`): link again. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- The venue is geo-blocked for this user, or the withdrawal destination is not on the allowlist. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: >- No Agg link for this client (`AGG_LINK_REQUIRED`), or a duplicate idempotency key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Agg rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: >- Agg returned a response that does not match the schema Portal expects (`id: INTEGRATION_RESPONSE_SCHEMA_DRIFT`). content: application/json: schema: $ref: '#/components/schemas/IntegrationSchemaDriftErrorResponse' '503': description: >- Agg is unreachable or returned an upstream error, or another request is refreshing this session (`AGG_SESSION_REFRESH_IN_PROGRESS`): retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: AggPositionsPage: type: object properties: data: type: array items: $ref: '#/components/schemas/AggPosition' nextCursor: anyOf: - type: string - type: 'null' description: Pass as `cursor` for the next page; `null` on the last page. hasMore: type: boolean required: - data - nextCursor - hasMore additionalProperties: false ErrorResponse: type: object properties: error: type: string description: Error message describing what went wrong IntegrationSchemaDriftErrorResponse: type: object description: >- Returned (HTTP 500) when a third-party response no longer matches the schema Portal proxies for it. The `id` is stable: SDKs should key off it and fail gracefully. Portal is alerted automatically and fixes the mapping server-side. required: - error - id - details properties: error: type: string example: >- yield-xyz-borrow returned a response for GET /v1/positions that does not match the expected schema id: type: string enum: - INTEGRATION_RESPONSE_SCHEMA_DRIFT details: type: object required: - integration - endpoint - issues properties: integration: type: string example: yield-xyz-borrow endpoint: type: string description: The upstream vendor endpoint whose response drifted. example: GET /v1/positions issues: type: array items: type: object required: - path - message - code properties: path: type: string description: Dotted path of the offending field in the vendor response. example: supplyBalances.0.balanceUsd message: type: string example: Expected string, received number code: type: string example: invalid_type AggPosition: type: object properties: targetMarketId: type: string eventId: description: Paper positions only. type: string redeemStatus: type: string status: type: string description: '`active` or `closed`.' side: description: '`long` or `short`.' type: string resolutionDate: anyOf: - type: string - type: 'null' venueMarket: type: object properties: venueEventId: type: string question: type: string image: anyOf: - type: string - type: 'null' status: type: string venueMarketOutcomes: type: array items: $ref: '#/components/schemas/AggPositionOutcome' required: - venueEventId - question - image - status - venueMarketOutcomes additionalProperties: false required: - targetMarketId - redeemStatus - status - resolutionDate - venueMarket additionalProperties: false AggPositionOutcome: type: object properties: label: type: string title: anyOf: - type: string - type: 'null' side: description: '`long` or `short`.' type: string venueBreakdown: type: array items: $ref: '#/components/schemas/AggPositionLeg' totalSize: type: number avgEntryPrice: type: number costBasisUnknown: type: boolean currentPrice: type: number realizedPnl: type: number totalValue: type: number unrealizedPnl: type: number unrealizedPnlPercent: type: number winner: anyOf: - type: boolean - type: 'null' description: '`null` until the market resolves.' priceSource: type: string bookQuality: description: Absent in paper mode. type: string required: - label - title - venueBreakdown - totalSize - avgEntryPrice - currentPrice - realizedPnl - totalValue - unrealizedPnl - unrealizedPnlPercent - winner - priceSource additionalProperties: false AggPositionLeg: type: object properties: venue: type: string venueMarketId: type: string venueMarketOutcomeId: description: The venue's own outcome id, which is what `POST /redemptions` wants. anyOf: - type: string - type: 'null' size: type: number side: description: '`long` or `short`.' type: string executionBackend: type: string custodyKind: description: One of `EOA`, `DEPOSIT_WALLET`, `VENUE_OMNIBUS`, `VENUE_ACCOUNT`. type: string venueAccountId: type: string externalAccountId: type: string required: - venue - venueMarketId - size additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: > Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.