> ## 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 events > Events across venues, one row per matched cluster, each with up to three markets. Most of the feed is resolved, so filter on `status=open` before offering anything as tradable. No Agg session needed. ## OpenAPI ````yaml /openapi/client-api.yaml get /clients/me/integrations/agg/events 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/events: get: tags: - Agg summary: List events description: >- Events across venues, one row per matched cluster, each with up to three markets. Most of the feed is resolved, so filter on `status=open` before offering anything as tradable. No Agg session needed. operationId: listAggEvents parameters: - name: status in: query required: false description: Market status, e.g. `open`. schema: type: string - name: search in: query required: false description: Text matched against the event title. schema: type: string - name: venues in: query required: false description: Comma-separated venue slugs. schema: type: string - name: categoryIds in: query required: false description: Comma-separated category ids. schema: type: string - name: sortBy in: query required: false description: Sort field. schema: type: string enum: - volume - volume24hr - createdAt - endDate - arbReturn - name: sortDir in: query required: false description: Sort order. schema: type: string enum: - asc - desc - 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/AggVenueEventsPage' '400': description: >- Invalid request, or Agg rejected it. Agg error codes are surfaced as `details.code`. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized 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 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: AggVenueEventsPage: type: object properties: data: type: array items: $ref: '#/components/schemas/AggVenueEvent' 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 AggVenueEvent: type: object properties: id: type: string externalIdentifier: type: string title: type: string description: anyOf: - type: string - type: 'null' image: anyOf: - type: string - type: 'null' venue: type: string deployerVenue: anyOf: - type: string - type: 'null' volume: anyOf: - type: number - type: 'null' status: type: string startDate: anyOf: - type: string - type: 'null' endDate: anyOf: - type: string - type: 'null' creationDate: anyOf: - type: string - type: 'null' gameStartTime: anyOf: - type: string - type: 'null' categories: type: array items: $ref: '#/components/schemas/AggEventCategory' slug: anyOf: - type: string - type: 'null' subtitle: anyOf: - type: string - type: 'null' venues: type: array items: type: string marketCount: description: Number of markets on the event; a list row embeds at most three. type: integer venueCount: type: integer groupMarketCount: type: integer groupParentId: anyOf: - type: string - type: 'null' updatedAt: anyOf: - type: string - type: 'null' venueMarkets: type: array items: $ref: '#/components/schemas/AggVenueMarket' arbReturn: anyOf: - type: number - type: 'null' series: anyOf: - $ref: '#/components/schemas/AggSeries' - type: 'null' recurrence: anyOf: - type: string - type: 'null' aggKey: anyOf: - type: string - type: 'null' structureType: description: One of `candidate`, `sport`, `axis`, `dates`. anyOf: - type: string - type: 'null' sport: anyOf: - type: string - type: 'null' settlementDiff: anyOf: - $ref: '#/components/schemas/AggSettlementDiff' - type: 'null' settlementDiffStatus: description: One of `computed`, `pending`, `not_applicable`. type: string matchedVenueEvents: type: array items: $ref: '#/components/schemas/AggMatchedVenueEvent' required: - id - externalIdentifier - title - image - venue - categories additionalProperties: false AggEventCategory: type: object properties: id: type: string category: $ref: '#/components/schemas/AggCategory' required: - id - category additionalProperties: false AggVenueMarket: type: object properties: id: type: string venue: type: string deployerVenue: anyOf: - type: string - type: 'null' marketId: anyOf: - type: string - type: 'null' externalIdentifier: type: string venueEventId: anyOf: - type: string - type: 'null' question: type: string shortTitle: anyOf: - type: string - type: 'null' detailsDeferred: description: >- True under `projection=summary`: description and rules were left out. type: boolean description: anyOf: - type: string - type: 'null' rulesPrimary: anyOf: - type: string - type: 'null' rulesSecondary: anyOf: - type: string - type: 'null' conditionId: anyOf: - type: string - type: 'null' volume: anyOf: - type: number - type: 'null' volume24hr: anyOf: - type: number - type: 'null' image: anyOf: - type: string - type: 'null' venueMarketOutcomes: type: array items: $ref: '#/components/schemas/AggVenueMarketOutcome' status: description: One of `open`, `closed`, `resolved`, `unopened`, `paused`. type: string startDate: anyOf: - type: string - type: 'null' endDate: anyOf: - type: string - type: 'null' creationDate: anyOf: - type: string - type: 'null' createdAt: anyOf: - type: string - type: 'null' updatedAt: type: string resolutionDate: anyOf: - type: string - type: 'null' negRisk: type: boolean venues: type: array items: type: string venueCount: type: integer arbReturn: anyOf: - type: number - type: 'null' aggKey: description: Deterministic cross-venue join key for the same real-world contract. anyOf: - type: string - type: 'null' sportsMarketType: anyOf: - type: string - type: 'null' sectionRank: anyOf: - type: integer - type: 'null' period: anyOf: - type: string - type: 'null' marketCategory: anyOf: - type: string - type: 'null' marketGroup: anyOf: - type: string - type: 'null' marketSubtype: anyOf: - type: string - type: 'null' lineValue: anyOf: - type: number - type: 'null' minOrderSize: description: >- Order constraints for this market: validate size and price against them before quoting. anyOf: - type: number - type: 'null' tickSize: anyOf: - type: number - type: 'null' feeRate: anyOf: - type: number - type: 'null' feeExponent: anyOf: - type: number - type: 'null' feeBasis: description: One of `fill`, `fill_in_game_only`, `winnings`, `exit`. anyOf: - type: string - type: 'null' matchedVenueMarkets: type: array items: $ref: '#/components/schemas/AggMatchedVenueMarket' venueEvent: anyOf: - $ref: '#/components/schemas/AggMarketEvent' - type: 'null' required: - id - venue - externalIdentifier - question - venueMarketOutcomes additionalProperties: false AggSeries: type: object properties: id: type: string externalIdentifier: type: string name: anyOf: - type: string - type: 'null' venue: type: string recurrence: anyOf: - type: string - type: 'null' required: - externalIdentifier additionalProperties: false AggSettlementDiff: type: object properties: sharedSummary: type: string differences: type: array items: type: object properties: type: type: string title: type: string perVenue: type: object propertyNames: type: string additionalProperties: type: string description: Keyed by venue slug. summary: type: string required: - type - title - perVenue additionalProperties: false required: - sharedSummary - differences additionalProperties: false AggMatchedVenueEvent: type: object properties: id: type: string venue: type: string externalIdentifier: type: string title: type: string slug: anyOf: - type: string - type: 'null' status: type: string series: anyOf: - $ref: '#/components/schemas/AggSeries' - type: 'null' required: - id - venue - externalIdentifier - title additionalProperties: false AggCategory: type: object properties: id: type: string name: type: string displayName: anyOf: - type: string - type: 'null' parentId: anyOf: - type: string - type: 'null' eventCount: type: integer volume24hr: type: number volume: type: number required: - id - name - displayName - parentId - eventCount - volume24hr - volume additionalProperties: false AggVenueMarketOutcome: type: object properties: id: type: string venueMarketId: type: string externalIdentifier: anyOf: - type: string - type: 'null' label: type: string title: anyOf: - type: string - type: 'null' priceChange24h: description: >- Change over the last 24 hours, in absolute probability points. Live prices come from `/midpoints`. anyOf: - type: number - type: 'null' winner: anyOf: - type: boolean - type: 'null' payoutPerShare: description: >- What one winning share pays out; below 1 on venues that take a settlement fee. anyOf: - type: number - type: 'null' refundAtCost: description: The venue voided the market and refunds every holder their stake. type: boolean matchedVenueMarketOutcomes: type: array items: type: object properties: venueMarketId: type: string venueMarketOutcomeId: type: string required: - venueMarketId - venueMarketOutcomeId additionalProperties: false required: - id - venueMarketId - label additionalProperties: false AggMatchedVenueMarket: type: object properties: id: type: string venue: type: string deployerVenue: anyOf: - type: string - type: 'null' externalIdentifier: type: string question: type: string shortTitle: anyOf: - type: string - type: 'null' detailsDeferred: type: boolean description: anyOf: - type: string - type: 'null' rulesPrimary: anyOf: - type: string - type: 'null' rulesSecondary: anyOf: - type: string - type: 'null' volume: anyOf: - type: number - type: 'null' volume24hr: anyOf: - type: number - type: 'null' status: type: string conditionId: anyOf: - type: string - type: 'null' arbReturn: anyOf: - type: number - type: 'null' image: anyOf: - type: string - type: 'null' venueEvent: description: A trimmed event; `title` can be `null` here. anyOf: - type: object properties: id: type: string externalIdentifier: type: string title: anyOf: - type: string - type: 'null' slug: anyOf: - type: string - type: 'null' description: anyOf: - type: string - type: 'null' image: anyOf: - type: string - type: 'null' venue: type: string deployerVenue: anyOf: - type: string - type: 'null' volume: anyOf: - type: number - type: 'null' status: type: string sport: anyOf: - type: string - type: 'null' structureType: anyOf: - type: string - type: 'null' subtitle: anyOf: - type: string - type: 'null' startDate: anyOf: - type: string - type: 'null' endDate: anyOf: - type: string - type: 'null' creationDate: anyOf: - type: string - type: 'null' updatedAt: anyOf: - type: string - type: 'null' gameStartTime: anyOf: - type: string - type: 'null' categories: type: array items: $ref: '#/components/schemas/AggEventCategory' series: anyOf: - $ref: '#/components/schemas/AggSeries' - type: 'null' venues: type: array items: type: string marketCount: type: integer venueCount: type: integer groupMarketCount: type: integer groupParentId: anyOf: - type: string - type: 'null' arbReturn: anyOf: - type: number - type: 'null' recurrence: anyOf: - type: string - type: 'null' aggKey: anyOf: - type: string - type: 'null' settlementDiff: anyOf: - $ref: '#/components/schemas/AggSettlementDiff' - type: 'null' settlementDiffStatus: type: string matchedVenueEvents: type: array items: $ref: '#/components/schemas/AggMatchedVenueEvent' required: - id - externalIdentifier additionalProperties: false - type: 'null' venueMarketOutcomes: type: array items: $ref: '#/components/schemas/AggVenueMarketOutcome' required: - id - venue - externalIdentifier - question additionalProperties: false AggMarketEvent: type: object properties: id: type: string externalIdentifier: type: string title: type: string slug: anyOf: - type: string - type: 'null' description: anyOf: - type: string - type: 'null' image: anyOf: - type: string - type: 'null' venue: type: string deployerVenue: anyOf: - type: string - type: 'null' volume: anyOf: - type: number - type: 'null' status: type: string sport: anyOf: - type: string - type: 'null' structureType: anyOf: - type: string - type: 'null' subtitle: anyOf: - type: string - type: 'null' startDate: anyOf: - type: string - type: 'null' endDate: anyOf: - type: string - type: 'null' creationDate: anyOf: - type: string - type: 'null' updatedAt: anyOf: - type: string - type: 'null' gameStartTime: anyOf: - type: string - type: 'null' categories: type: array items: $ref: '#/components/schemas/AggEventCategory' series: anyOf: - $ref: '#/components/schemas/AggSeries' - type: 'null' venues: type: array items: type: string marketCount: type: integer venueCount: type: integer groupMarketCount: type: integer groupParentId: anyOf: - type: string - type: 'null' arbReturn: anyOf: - type: number - type: 'null' recurrence: anyOf: - type: string - type: 'null' aggKey: anyOf: - type: string - type: 'null' settlementDiff: anyOf: - $ref: '#/components/schemas/AggSettlementDiff' - type: 'null' settlementDiffStatus: type: string matchedVenueEvents: type: array items: $ref: '#/components/schemas/AggMatchedVenueEvent' required: - id - externalIdentifier 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.