# polymarket.search

**stable** **Advanced**

Search Polymarket events.

`GET /v1/polymarket/search`

## 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 |
| --- | --- | --- | --- | --- | --- |
| `q` | string | yes | (required) | Search text | max 80 chars; must match `[\w .,'&+:()-]{1,80}`; trimmed, repeated spaces collapsed |
| `limit` | string | no | `10` | Rows per type (1-20) | max 2 chars; must match `[1-9]\|1\d\|20`; trimmed |

## Request

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

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/polymarket/search",
    params={"q": "election", "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({ q: "election", limit: "5" });
const res = await fetch(`https://api.onekey.dev/v1/polymarket/search?${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": "580320",
        "name": "Which party will Trump Endorse in the 2026 Israeli Election? ",
        "slug": "which-party-will-trump-endorse-in-the-2026-israeli-election-20260610144125261",
        "description": "Legislative elections are scheduled to be held in Israel by October 27, 2026.\n\nThis market will resolve based on which party Donald Trump announces that he supports, endorses, or otherwise tells people to vote for in the 2026 Israeli legislative election. \n\nIn the event that Donald Trump endorses a candidate to be Prime Minister of Israel, this market will resolve in favor of the party that the in",
        "date": "2027-01-01T04:59:00Z"
      },
      "media": {
        "thumbnailUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/who-will-trump-endorse-in-the-2026-israeli-election-20260608183907960-QeXr8ObEt0Rg.jpg"
      },
      "market": {
        "volume": 50455.613736,
        "liquidity": 179295.67144,
        "openInterest": 5264.298825000001,
        "volume24h": 781.568631
      },
      "engagement": {
        "comments": 6
      },
      "ext": {
        "active": true,
        "closed": false
      }
    },
    {
      "entity": {
        "id": "902823",
        "name": "Mississippi gubernatorial election: Presley (D) vs. Reeves (R)",
        "slug": "mississippi-gubernatorial-election-presley-d-vs-reeves-r",
        "description": "This market will resolve to \"Presley\" if Brandon Presley (D) wins the 2023 Mississippi gubernatorial election, scheduled for November 7, 2023. This market will resolve to \"Reeves\" if Tate Reeves (R) wins.\n\nDetermination of the winner of the 2023 U.S. Gubernatorial election for Mississippi will be based on a consensus of credible reporting, or if there is ambiguity, the final state election authori",
        "date": "2023-11-07T00:00:00Z"
      },
      "media": {
        "thumbnailUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/mississippi+flag.png"
      },
      "market": {
        "volume": 60047.36,
        "liquidity": 0,
        "openInterest": 0,
        "volume24h": 0
      },
      "engagement": {
        "comments": 17
      },
      "ext": {
        "active": true,
        "closed": true
      }
    }
  ],
  "metadata": {
    "platform": "polymarket",
    "endpoint": "search",
    "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).