Fetch Events

Fetch events with optional keyword search. Events group related markets together (e.g., “Who will be Fed Chair?” contains multiple candidate markets).

GET /api/{exchange}/fetchEvents

cURL

Interactive Example

curl --request GET \
  --url https://api.pmxt.dev/api/{exchange}/fetchEvents \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "error": {
    "message": "<string>"
  },
  "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": {}
            }
          ],
          "resolutionDate": "2023-11-07T05:31:56Z",
          "volume24h": 123,
          "liquidity": 123,
          "url": "<string>",
          "eventId": "<string>",
          "slug": "<string>",
          "volume": 123,
          "openInterest": 123,
          "image": "<string>",
          "category": "<string>",
          "tags": [
            "<string>"
          ],
          "tickSize": 123,
          "status": "<string>",
          "contractAddress": "<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>"
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Required when calling the hosted API directly (curl, requests, fetch). SDK users pass credentials via constructor params instead.

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

Query Parameters

query · string

For keyword search

limit · number

Maximum number of results to return

offset · number

Pagination offset — number of results to skip

sort · enum<string>

Sort order for results

Available options: volume, liquidity, newest

status · enum<string>

Filter by event status (default: 'active', 'inactive' and 'closed' are interchangeable)

Available options: active, inactive, closed, all

searchIn · enum<string>

Where to search (default: 'title')

Available options: title, description, both

eventId · string

Direct lookup by event ID

slug · string

Lookup by event slug

Response

200 - application/json

Fetch Events response

success · boolean

Example:

true

error · object

Show child attributes

data · object[]

Show child attributes