Docs
View as Markdown

polymarket.research

stable Standard

Research a topic across Polymarket: matching prediction-market events with volume, liquidity and dates.

GET /v1/polymarket/research

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#

  • Standard · 1 credit 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#

NameTypeRequiredDefaultWhat it isConstraints
querystringyes(required)Research topic, free text (e.g. bitcoin halving)max 200 chars; must match [^\r\n]{1,200}; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/polymarket/research?query=bitcoin" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

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": "1074544",
        "name": "Bitcoin above ___ on October 1?",
        "slug": "bitcoin-above-on-october-1-2026",
        "description": "This market will resolve to \"Yes\" if the Binance 1 minute candle for BTC/USDT 12:00 in the ET timezone (noon) on the date specified in the title has a final \"Close\" price higher than the price specifi"
      },
      "market": {
        "volume": 1673901.948019,
        "liquidity": null,
        "openInterest": 1069649.4128250002
      },
      "event": {
        "endDate": "2026-10-01T16:00:00Z",
        "startDate": "2026-09-24T16:00:14Z"
      },
      "media": {
        "thumbnailUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/BTC+fullsize.png"
      },
      "engagement": {
        "comments": 0
      }
    },
    {
      "entity": {
        "id": "211888",
        "name": "Bitcoin above ___ on February 23?",
        "slug": "bitcoin-above-on-february-23",
        "description": "This market will resolve to \"Yes\" if the Binance 1 minute candle for BTC/USDT 12:00 in the ET timezone (noon) on the date specified in the title has a final \"Close\" price higher than the price specifi"
      },
      "market": {
        "volume": 5476990.364345,
        "liquidity": null,
        "openInterest": 0
      },
      "event": {
        "endDate": "2026-02-23T17:00:00Z",
        "startDate": "2026-02-16T17:05:32Z"
      },
      "media": {
        "thumbnailUrl": "https://polymarket-upload.s3.us-east-2.amazonaws.com/BTC+fullsize.png"
      },
      "engagement": {
        "comments": 0
      }
    }
  ],
  "metadata": {
    "platform": "polymarket",
    "endpoint": "research",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
identity.id-
titleentity.name-
slugentity.slug-
descriptionentity.description-
volumemarket.volumetoNumber
liquiditymarket.liquiditytoNumber
openInterestmarket.openInteresttoNumber
endDateevent.endDatetoIsoDate
startDateevent.startDatetoIsoDate
imagemedia.thumbnailUrlsafeUrl
commentCountengagement.commentstoNumber

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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).