Skip to main content
GET
/
events
List events
curl --request GET \
  --url https://api.polyrouter.io/functions/v1/events \
  --header 'X-API-Key: <api-key>'
{
  "events": [
    {
      "id": "<string>",
      "platform": "polymarket",
      "platform_id": "<string>",
      "series_id": "<string>",
      "title": "<string>",
      "event_slug": "<string>",
      "description": "<string>",
      "image_url": "<string>",
      "resolution_source_url": "<string>",
      "event_start_at": "2023-11-07T05:31:56Z",
      "event_end_at": "2023-11-07T05:31:56Z",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "market_count": 123,
      "total_volume": 123,
      "raw_data": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "has_more": true,
    "next_offset": 123
  },
  "meta": {
    "request_time": 123,
    "cache_hit": true,
    "data_freshness": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

platform
enum<string>

Filter by platform (single value only, not comma-separated): polymarket, kalshi

Available options:
polymarket,
kalshi
query
string

Search markets by name or description

include_raw
boolean

Include raw data from the platform API

with_nested_markets
boolean

Include nested markets in the response

limit
integer
default:10

Number of results per page (1-25)

Required range: 1 <= x <= 25
cursor
string

Cursor for pagination

Response

Events retrieved successfully

events
object[]
pagination
object
meta
object