Dashboard

Documentation

Base URL: https://api.traderspredict.com

Auth: send X-API-Key: pmx_... on every request. Get a key from API Keys.

Markets

GET /markets

List markets ordered by 24h volume. Filters: closed, category, tag.

GET /markets/:condition_id

Single market by condition_id.

GET /markets/by-slug/:slug

Lookup by human readable slug.

GET /markets/:condition_id/trades

Trades for both outcomes in one query.

Trades

GET /trades?token_id&from&to&limit

Trades for a token in a time window.

GET /trades/recent?limit

N most recent trades across all markets.

GET /trades/stats

Approximate row count plus earliest and latest timestamp.

Candles

GET /candles?token_id&resolution&from&to&limit&format

OHLCV bars. format=udf returns TradingView UDF.

GET /candles/resolutions

Allowed resolution values.

Live orderbook

GET /orderbook/:token_id

Best bid, best ask, spread, mid, depth. Sub second freshness.

Traders

GET /traders?sort_by&limit

Leaderboard of active wallets, 30 day window.

GET /traders/:address

Summary stats for one wallet.

GET /traders/:address/trades

Trades involving this wallet.

Global aggregates

GET /global/stats

Platform wide KPIs.

GET /global/top-markets?window&limit

Top markets by 24h, 7d, or 30d volume.

Webhooks

GET /webhooks

List your webhook subscriptions.

POST /webhooks

Create a subscription, receive the signing secret once.

PATCH /webhooks/:id

Update URL, events, filters, or active state.

DELETE /webhooks/:id

Remove a subscription.

GET /webhooks/:id/deliveries

Recent delivery attempts.

Billing

GET /billing/plan

Your current plan, credit balance, cycle start.

GET /billing/tiers

Catalog of all plan tiers.

POST /billing/checkout

Coming soon. Returns 501 until Stripe is wired.

Your usage

GET /usage/summary?window

Requests, credits, latency, errors.

GET /usage/timeline?window&granularity

Time series for plotting.

Auth

POST /auth/signup

Body: email, name (optional). Creates user plus first API key. Shown ONCE.

GET /auth/me

Current user record.

GET /auth/keys

List your API keys, metadata only.

POST /auth/keys

Body: name (optional). Creates an additional key. Shown ONCE.

DELETE /auth/keys/:id

Revoke a key.

GET /auth/verify?token=X

Consume an email verification token.

POST /auth/resend-verification

Send a fresh verification email.

Cache plus rate limits

  • Most reads include Cache-Control headers honored by Cloudflare edge.
  • Typical TTLs: 30 seconds for live data, 24 hours for immutable history.
  • Rate limit per minute by plan: free 30, hobby 120, startup 600, scale 3000.
  • 429 responses include Retry-After seconds.
  • Each response carries X-RateLimit-Limit and X-RateLimit-Remaining.