Skip to main content
GET
/
v1
/
api
/
metrics
/
historical
Metrics historical
curl --request GET \
  --url https://api.dotprediction.io/v1/api/metrics/historical \
  --header 'X-API-Key: <api-key>'
{
  "market_id": "<string>",
  "platform": "<string>",
  "interval": "<string>",
  "data": [
    {
      "timestamp": 123,
      "price": {
        "open": 123,
        "high": 123,
        "low": 123,
        "close": 123
      },
      "volume": 123,
      "open_interest": 123,
      "liquidity": {
        "best_bid": 123,
        "best_ask": 123,
        "spread": 123,
        "midpoint": 123
      },
      "trade_count": 123,
      "notional_value": 123
    }
  ],
  "data_availability": {
    "price": true,
    "volume": true,
    "open_interest": true,
    "liquidity": true,
    "trade_count": true,
    "notional_value": true
  },
  "meta": {
    "platforms": [
      "<string>"
    ],
    "time_range": {
      "start": 123,
      "end": 123
    },
    "interval": "<string>",
    "total_candles": 123,
    "request_time": 123,
    "cache_hit": true,
    "data_freshness": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication. Generate one via the dashboard or the /v1/api/auth/api-keys endpoint.

Query Parameters

platform
enum<string>
required

The platform to query.

Available options:
kalshi,
polymarket,
limitless
market_id
string
required

The market ID.

start_ts
integer<int64>
required

Start time as Unix timestamp.

end_ts
integer<int64>
required

End time as Unix timestamp.

interval
enum<string>
default:1d

Candle interval.

Available options:
1m,
5m,
15m,
1h,
4h,
1d
limit
integer
default:1000

Max results to return (default 1000, max 5000).

Required range: x <= 5000

Response

Historical market metrics.

market_id
string
platform
string
interval
string
data
object[]
data_availability
object
meta
object