Skip to main content

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 fee curve (charged on both the maker and the taker leg of a fill).

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 vault contract, 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 — outcomes are resolved from external data — sports-data providers for sports markets, Chainlink price data (CoinGecko for dominance, market-cap and rank products) for crypto markets — and posted on-chain with a bond-backed challenge window (2 hours by default).

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 live on the web app (https://app.dev.predictstreet.sde.adifoundation.ai on testnet, https://adipredictstreet.com on mainnet) and are out of scope for this documentation.

Environments

All examples in this documentation use the testnet environment by default. Production endpoints require a separate partner onboarding step — contact partners@predictstreet.com.

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.