Who this is for
This documentation is for teams integrating with PredictStreet:Market makers
Provide liquidity across binary and categorical markets using the
EIP-712 signed-order flow. Hot path is HTTP + WebSocket; settlement
is on-chain with a dual-signature vault custody model.
Trading partners
Route customer flow into PredictStreet markets via a key-authenticated
REST API (API keys), real-time market data
feeds, and a predictable fee schedule derived from the on-chain
quadratic taker-fee curve.
Liquidity aggregators
Consume market, orderbook, and trade streams to integrate PredictStreet
pricing into your own distribution surfaces. Read-only access is
available without posting collateral.
Research / analytics
Access historical trades, fee ledger, and on-chain settlement records
for modelling, benchmarking, and market-microstructure research.
What PredictStreet is
A regulated prediction-market platform running on a dedicated L2 with the following architectural split:- Off-chain hot path — order intake, signature validation, balance locking, matching, and trade recording happen off-chain for sub-second latency.
- On-chain custody — every user’s collateral and outcome-token balances live in their own EIP-1167 vault clone, not in an exchange- owned pooled contract. Nothing moves without the user’s EIP-712 signature.
- On-chain settlement — fills are batched to the CTFExchange contract; withdrawals, split/merge, and neg-risk conversions require dual signatures (user + backend co-signer) with no unilateral backend authority.
- Automated oracle — three independent sports data feeds (Stats Perform primary + API-Football + SportMonks) feed a consensus resolver. Every outcome posted on-chain has a 2-hour challenge window backed by a bond mechanism.
How the docs are organised
1
Getting Started
Start with the Quickstart for a 5-minute hello-world,
or the Platform overview for a conceptual
picture before writing code.
2
Concepts
Each major surface (trading, markets, portfolio, withdrawals,
WebSocket, settlement, contracts) has a dedicated concept section
that explains the model and then links to the exact endpoints
involved.
3
API Reference
The API Reference tab catalogues every HTTP endpoint, its
request / response schemas, and example payloads, with a
try-it-out panel for supported environments.
API surface at a glance
See Authentication overview and API keys for the partner authentication flow. Retail user logins (SIWE) live on
app.predictstreet.io and are out of scope for this documentation.
Environments
Next steps
Quickstart
Place your first order in 5 minutes.
Platform overview
Understand the off-chain / on-chain split before writing code.
Authentication
API keys — issuance, format, scopes, rotation.
API Reference
Jump straight into the endpoint catalogue.