Skip to main content
POST
prediction.markets.correlations

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
category
enum<string>
required

Category (correlations are within-category only).

Available options:
crypto,
culture,
economics,
financials,
politics,
stem,
sports
conditionId
string

Filter to pairs involving this market.

Required string length: 1 - 512
limit
number

How many to return, 1 to 20. Default 10.

Required range: x >= 1
minCorrelation
number

Minimum absolute correlation. Defaults to 0.5.

Required range: 0 <= x <= 1000000000

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.