Fetch Events Paginated

Paginated variant of {@link fetchEvents}. On the first call (no `cursor`), all events are fetched from the exchange and cached in an in-memory snapshot. A cursor is returned along with the first page. Subsequent calls with that cursor serve additional pages directly from the cached snapshot -- no additional API calls are made. The snapshot is invalidated after `snapshotTTL` ms (configured via `ExchangeOptions` in the constructor). A request using a cursor from an expired snapshot throws `'Cursor has expired'`.

GET /api/{exchange}/fetchEventsPaginated

Python

Polymarket

import pmxt

# API key optional — enables faster catalog-backed lookups
exchange = pmxt.Polymarket(
    pmxt_api_key="YOUR_PMXT_API_KEY",
)
result = exchange.fetch_events_paginated(limit=10, cursor="abc123")

200

{
  "success": true,
  "error": {
    "message": "<string>",
    "code": "HOSTED_TRADING_ERROR",
    "retryable": true,
    "exchange": "<string>",
    "detail": {}
  },
  "data": {
    "data": [
      {
        "id": "<string>",
        "title": "<string>",
        "description": "<string>",
        "slug": "<string>",
        "markets": [
          {
            "marketId": "<string>",
            "title": "<string>",
            "description": "<string>",
            "outcomes": [
              {
                "outcomeId": "<string>",
                "label": "<string>",
                "price": 123,
                "marketId": "<string>",
                "priceChange24h": 123,
                "metadata": {}
              }
            ],
            "volume24h": 123,
            "liquidity": 123,
            "url": "<string>",
            "eventId": "<string>",
            "slug": "<string>",
            "resolutionDate": "2023-11-07T05:31:56Z",
            "volume": 123,
            "openInterest": 123,
            "image": "<string>",
            "category": "<string>",
            "tags": [
              "<string>"
            ],
            "tickSize": 123,
            "status": "<string>",
            "contractAddress": "<string>",
            "sourceMetadata": {},
            "sourceExchange": "<string>",
            "yes": {
              "outcomeId": "<string>",
              "label": "<string>",
              "price": 123,
              "marketId": "<string>",
              "priceChange24h": 123,
              "metadata": {}
            },
            "no": {
              "outcomeId": "<string>",
              "label": "<string>",
              "price": 123,
              "marketId": "<string>",
              "priceChange24h": 123,
              "metadata": {}
            },
            "up": {
              "outcomeId": "<string>",
              "label": "<string>",
              "price": 123,
              "marketId": "<string>",
              "priceChange24h": 123,
              "metadata": {}
            },
            "down": {
              "outcomeId": "<string>",
              "label": "<string>",
              "price": 123,
              "marketId": "<string>",
              "priceChange24h": 123,
              "metadata": {}
            }
          }
        ],
        "volume24h": 123,
        "url": "<string>",
        "volume": 123,
        "image": "<string>",
        "category": "<string>",
        "tags": [
          "<string>"
        ],
        "sourceMetadata": {},
        "sourceExchange": "<string>"
      }
    ],
    "total": 123,
    "nextCursor": "<string>"
  }
}

Faster with an API key — With a PMXT API key this endpoint is served from an indexed catalog (~10 ms) instead of proxying to the venue (~500 ms). No code changes required — same request, same response, just faster. Learn more.

Path Parameters

exchange · enum<string> · required

The prediction market exchange to target.

Available options: polymarket, kalshi, kalshi-demo, limitless, probable, baozi, myriad, opinion, metaculus, smarkets, polymarket_us, gemini-titan, hyperliquid, suibets, rain, hunch, router

Query Parameters

limit · number

cursor · string

filter · object

Show child attributes

Response

200 - application/json

Fetch Events Paginated response

success · boolean

Example:

true

error · object

Structured error envelope returned inside BaseResponse.error and ErrorResponse.error. Hosted-mode endpoints populate code, retryable, and optionally exchange / detail; legacy local-mode endpoints may still return only message.

Show child attributes

data · object

Shape returned by fetchEventsPaginated

Show child attributes