Prediction Hunt/ API
REST API / Prices / Orderbook

Orderbook

Live orderbook data proxied and normalized from source platforms. Returns the full bid/ask ladder for a given market. Kalshi, Polymarket, Opinion, and Predict.fun are supported. Returns 404 when no orderbook data is available for the market.

GET/v2/orderbook

Query Parameters

platformstringRequired

polymarket | kalshi | opinion (required).

market_idstringRequired

Platform-native market ID (required).

Response Schema

market_idstring

Platform-native market ID.

platformstring

Platform name.

timestampstring

Timestamp of the orderbook snapshot (ISO 8601).

yesobject

YES outcome orderbook.

bidsobject[]

Bid levels.

pricenumber

Price level.

sizenumber

Size/quantity at this level.

asksobject[]

Ask levels.

pricenumber

Price level.

sizenumber

Size/quantity at this level.

noobject

NO outcome orderbook.

bidsobject[]

Bid levels.

pricenumber

Price level.

sizenumber

Size/quantity at this level.

asksobject[]

Ask levels.

pricenumber

Price level.

sizenumber

Size/quantity at this level.

Error Responses

All errors return the same envelope. The code field is stable and programmatically branchable; error and message are human-readable. errors[] is present only on validation failures with field-level detail. See the full error code reference →

successboolean

Always `false` on error responses.

errorstring

Short, human-readable title (e.g. 'Invalid API Key.').

messagestring

Human-readable explanation for the error. Safe to surface in UIs.

codestring

Stable, hierarchical machine-readable code (e.g. 'validation.invalid_enum'). Use for programmatic handling.

doc_urlstring

Link to this code's entry in the Error Reference.

errorsobject[]

Optional. Present only on validation failures with field-level detail.

fieldstring

Name of the offending parameter.

codestring

Field-level machine code.

messagestring

Human-readable explanation.

Authentication

API Key

To secure your requests, we strongly recommend passing your API key via the X-API-Key header. This prevents sensitive keys from being exposed in access logs or browser history.

Request HeaderX-API-Key: pmx_test_5e8f...

Rate Limits

API rate limits are enforced based on the tier associated with your API key. Limits are tracked on two dimensions: requests per second and requests per month. Each completed request counts toward the global monthly quota. Separate endpoint-group monthly limits (matched markets, arbitrage, EV) only advance when the response body has success: true.

Usage is returned on responses via headers such as:

Response Headers (global)X-RateLimit-Limit-Second: 10X-RateLimit-Remaining-Second: 9X-RateLimit-Limit-Month: 1000X-RateLimit-Remaining-Month: 842Example (endpoint-group, when applicable)X-RateLimit-Limit-Arb-Month: 500X-RateLimit-Remaining-Arb-Month: 412

If you exceed a rate limit, the API returns a 429 status with a Retry-After header indicating when you can resume.

Request

Live API Key

Demo Mode
Verified

Parameters

PlatformRequired
Market IDRequired

Response

Click EXECUTE to send a request →