Skip to content

Introduction

The PredictEX API is the programmatic gateway to PredictEX.

The API bridges standard exchange style REST clients to the onchain markets. Wallet custody, order signing, and transaction submission are handled server side, so a client integrates the way it would with any centralized exchange, using an API key, HMAC signed requests, and JSON in both directions. It exposes fixture listings, quoting, and order placement.

Conventions

The API is served as REST over HTTPS with JSON request and response bodies. All decimal values are transmitted as strings to preserve precision, for example "20" rather than 20. Timestamps are Unix milliseconds, except on GET /settlements, whose timestamp is an ISO 8601 string passed through from the settlement source. String identifiers such as contractId, team, and side are case insensitive on input and returned in canonical uppercase.

Requests go to the following base URL.

https://api.predictex.com

The OpenAPI specification is available at https://api.predictex.com/openapi.yaml, and it can be browsed in the Swagger console at https://api.predictex.com/swagger.

Terminology

Term Definition
fixture A single match, identified by a contractId such as MLB_CLE_DET_260813. The format is league, away team, home team, date.
bet A position on one team of a fixture, opened with a BUY order.
amount Funds debited from the wallet, denominated in the pool currency.
contracts Position size in market units, the alternative sizing parameter.
price The win probability of a team, a value between 0 and 1.
boost How hard a bet is pushed, from 0 to 100 percent. At 0 the bet is unboosted, at 100 it takes the most this market allows on that team. The same money buys more contracts as the boost rises.
knockout The index price at which a boosted bet is knocked out and loses.