Filter Events

Filter a list of events by criteria. Can filter by string query, structured criteria object, or custom filter function.

POST /api/{exchange}/filterEvents

cURL

Interactive Example

curl --request POST \
  --url https://api.pmxt.dev/api/{exchange}/filterEvents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "args": [
    [
      {
        "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>"
          }
        ],
        "volume24h": 123,
        "url": "<string>",
        "volume": 123,
        "image": "<string>",
        "category": "<string>",
        "tags": [
          "<string>"
        ]
      }
    ]
  ],
  "credentials": {
    "apiKey": "<string>",
    "apiSecret": "<string>",
    "passphrase": "<string>",
    "apiToken": "<string>",
    "privateKey": "<string>",
    "signatureType": 123,
    "funderAddress": "<string>"
  }
}
'

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

Body

application/json

args · object[] · string · object · object[] · required

Required array length: 2 elements

Show child attributes

credentials · object

Optional authentication credentials for exchange operations.

Show child attributes

Response

200 - application/json

Filter Events response

success · boolean

Example:

true

error · object

Show child attributes

data · object[]

Show child attributes