Skip to main content
The Predexy REST API gives you programmatic access to cross-platform prediction market data, scored arbitrage opportunities, unified market indexes, and your Developer Console. All endpoints are served under /api/v1/ and return JSON. This page covers the conventions that apply to every request you make.

​
Base URLs

EnvironmentBase URL
Productionhttps://api.predexy.com
Staginghttps://staging-api.predexy.com
Use the staging environment for testing integrations without affecting production data. All endpoints, response shapes, and authentication methods are identical across environments.

​
API version

The current version is 1.0.0. Every endpoint path begins with /api/v1/. The two health endpoints — GET /health and GET /ready — sit at the root with no version prefix.

​
Request format

Set Content-Type: application/json on all requests that include a body. Query parameters are accepted as standard URL-encoded key-value pairs.

​
Authentication

Predexy supports three authentication methods depending on the endpoint group:
MethodCredentialUsed for
Session JWTAuthorization: Bearer <jwt> or pdx_access cookieWeb app, discovery, arbitrage, watchlists, alerts, wallet tracker, console
SIWE sessionpredex_siwe cookieWallet-connected product routes
API keyX-API-Key: pdx_... headerExternal arbitrage endpoint for trading bots and paid integrations
See Authentication for full details on obtaining tokens, refreshing sessions, and creating API keys.

​
Health endpoints

Two liveness probes are available with no authentication required:
  • GET /health — returns 200 OK when the API server process is running.
  • GET /ready — returns 200 OK when the database and dependencies are reachable.
Both return the same shape: 
{
  "status": "ok",
  "service": "predexy-api",
  "version": "1.0.0"
}

​
Response envelope

Successful responses wrap the payload in a data key. List endpoints additionally include a meta object with pagination details: 
{
  "data": [...],
  "meta": {
    "count": 20,
    "total": 142,
    "offset": 0,
    "limit": 50
  }
}
Single-resource endpoints return data as an object rather than an array. Some endpoints include additional top-level keys (for example, tokens on auth responses).

​
Error envelope

All errors follow the same shape: 
{
  "status": "MACHINE_READABLE_CODE",
  "message": "Human-readable description"
}
Internal server details are never exposed. Common status codes include INVALID_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, RATE_LIMITED, INTERNAL_ERROR, INVALID_API_KEY, and QUOTA_EXCEEDED. See Error reference for the full list.

​
Pagination

List endpoints accept limit and offset query parameters and return pagination state in meta:
​
limit
number
default:"50"
Maximum items to return per page. Range 1–200.
​
offset
number
default:"0"
Number of items to skip. Use this to page through results.
See Pagination for full details and examples.

​
Rate limits

All responses include rate-limit headers:
HeaderDescription
X-RateLimit-LimitMaximum requests per window
X-RateLimit-RemainingRequests remaining in the current window
X-RateLimit-ResetUnix timestamp when the window resets
TierRequests / minBurst
Product read (unauthenticated)12040
Authenticated session6020
API key60050
See Rate limits for full details and retry guidance.

​
Key sections

Markets & Discovery

Browse canonical questions with index prices, divergence metrics, and platform slugs.

Arbitrage

Scored arbitrage opportunities with session auth or API key access.

Account

Register, log in, manage watchlists, set price alerts, and track wallet positions.

Console

Create and revoke API keys, and inspect usage statistics and request logs.