> ## Documentation Index
> Fetch the complete documentation index at: https://dexbuilder.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Prediction Markets API REST API and WebSocket overview.

Prediction Markets API provides REST API for market discovery, market data, orders, positions, account data, and claims, plus WebSocket for real-time updates.

## Base URL

```text theme={null}
https://api.dexbuilder.com
```

Public market-data REST endpoints use `/api/v4/prediction` and do not require authentication. Private order, position, account, and claim endpoints use `/api/v4/broker/prediction`. Call private endpoints with a Broker API Key and pass the target user's wallet address in `X-User-Wallet-Address`. See [Broker API Key and signing](https://dexbuilder.mintlify.site/en/api-reference/common/broker-authentication.md) and [Access on behalf of a user](https://dexbuilder.mintlify.site/en/api-reference/common/sub-user-wallet.md). Private WebSocket subscriptions use the separate [Broker WebSocket authentication](https://dexbuilder.mintlify.site/en/event-markets/websocket/authentication.md) flow.

## Status fields

Market `status` describes the market state. REST order `status` uses `processing`, `open`, `matched`, `canceled`, and `failed`. A WebSocket message's `type` identifies the push message type. Interpret market, REST order, and WebSocket values according to their own endpoint or channel definitions.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.