# polymarket.events

**stable** **Advanced**

Top active prediction events by 24h volume (Gamma).

`GET /v1/polymarket/events`

## What you get

A list of Polymarket results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

## What it costs

- **Advanced · 5 credits** for a fresh fetch, charged only when it succeeds.
- **Free when served from cache (0.2 credit for a cached response over 100 KB).**
- **Free** if the request is invalid (never charged) or the source fails or reports not found (refunded).

## Parameters

| Name | Type | Required | Default | What it is | Constraints |
| --- | --- | --- | --- | --- | --- |
| `limit` | string | no | `10` | Rows (1-20) | max 2 chars; must match `[1-9]\|1\d\|20`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/polymarket/events?limit=5" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/polymarket/events",
    params={"limit": "5"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ limit: "5" });
const res = await fetch(`https://api.onekey.dev/v1/polymarket/events?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real Polymarket response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "1027446",
        "name": "Belgium vs. France",
        "slug": "unl-bel-fra-2026-09-28",
        "description": "This event is for the upcoming UEFA Nations League game, scheduled for Monday, September 28, 2026 between Belgium and France.",
        "date": "2026-09-28T18:45:00Z"
      },
      "media": {
        "thumbnailUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/soccer-leagues/unl.png"
      },
      "market": {
        "volume": 5006159.329664998,
        "liquidity": 148884.6487,
        "openInterest": 4403753.105971,
        "volume24h": 4770510.695021
      },
      "engagement": {
        "comments": 0
      },
      "ext": {
        "active": true,
        "closed": false
      }
    },
    {
      "entity": {
        "id": "870381",
        "name": "Eagles vs. Bears",
        "slug": "nfl-phi-chi-2026-09-29",
        "description": "In the upcoming NFL game, scheduled for September 28 at 8:15PM ET:\nIf Eagles wins, the market will resolve to \"Eagles\".\nIf Bears wins, the market will resolve to \"Bears\".\nIf the game is postponed, this market will remain open until the game has been completed.\nIf the game is canceled entirely or ends in a tie, with no make-up game, this market will resolve 50-50.",
        "date": "2026-09-29T00:15:00Z"
      },
      "media": {
        "thumbnailUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/nfl.png"
      },
      "market": {
        "volume": 4644497.468924999,
        "liquidity": 14096664.85986,
        "openInterest": 3662756.0895550004,
        "volume24h": 3618162.1000030003
      },
      "engagement": {
        "comments": 0
      },
      "ext": {
        "active": true,
        "closed": false
      }
    }
  ],
  "metadata": {
    "platform": "polymarket",
    "endpoint": "events",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `entity.id` | `toString` |
| `title` | `entity.name` | - |
| `slug` | `entity.slug` | - |
| `description` | `entity.description` | - |
| `image` | `media.thumbnailUrl` | `safeUrl` |
| `endDate` | `entity.date` | `toIsoDate` |
| `volume` | `market.volume` | `toNumber` |
| `liquidity` | `market.liquidity` | `toNumber` |
| `openInterest` | `market.openInterest` | `toNumber` |
| `volume24hr` | `market.volume24h` | `toNumber` |
| `commentCount` | `engagement.comments` | `toNumber` |
| `active` | `ext.active` | `toBoolean` |
| `closed` | `ext.closed` | `toBoolean` |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 minutes the cached copy is still served instantly and marked `stale: true` while Onekey refreshes it in the background.
- If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
- A "not found" is remembered for 1 minute and is free.
- The cache is shared across all customers, which is what keeps repeat calls cheap.

## What can go wrong

| Status | Code | What to do |
| --- | --- | --- |
| 401 | `unauthorized` | Check the `x-api-key` header. |
| 402 | `insufficient_credits` | [Add credits](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 422 | `invalid_params` | Fix the parameters using the table above. Free. |
| 429 | `rate_limited` | Wait `Retry-After` seconds, then retry. |
| 502 | `upstream_error` | The source failed. Refunded; retry with backoff. |

See [Errors](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).