> ## 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 概覽

> 事件市場 API 的基礎位址、存取模型、分頁、時間與錯誤約定。

## Base URL

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

公開行情 REST 介面使用 `/api/v4/prediction`，無需認證。私有交易、持倉與帳戶介面使用 `/api/v4/broker/prediction`。請以 Broker API Key 簽名，並在 `X-User-Wallet-Address` 傳入目標使用者錢包地址。詳見 [Broker API Key 與簽名](https://dexbuilder.mintlify.site/zh-TW/api-reference/common/broker-authentication.md) 和 [代表使用者存取](https://dexbuilder.mintlify.site/zh-TW/api-reference/common/sub-user-wallet.md)。私有 WebSocket 頻道使用獨立的 [Broker WebSocket 認證](https://dexbuilder.mintlify.site/zh-TW/event-markets/websocket/authentication.md) 流程。

## 介面存取模型

| 介面類型 | 是否需要認證 | 典型能力 |
| - | - | - |
| 市場發現 | 否 | 事件、市場、標籤 |
| 市場資料 | 否 | 價格、Ticker、訂單簿、歷史資料、K 線 |
| 交易 | 是 | 下單、查詢訂單、撤單 |
| 帳戶 | 是 | 持倉、資產、餘額、費率、個人成交 |
| 結算 | 是 | 平倉、領取、資金處理 |

## 分頁

清單介面使用游標分頁：

```json theme={null}
{"items":[],"next_cursor":"opaque-cursor"}
```

將上一頁回傳的 `next_cursor` 原樣作為下一頁的 `cursor`。不要自行解析或修改游標。

## 時間約定

* 事件與市場日期欄位通常使用 Unix 秒；
* `from`、`to` 等範圍參數通常使用 Unix 毫秒；
* 幣種 K 線介面的 `start_ts`、`end_ts` 和 `history[].t` 使用 Unix 秒；Token 價格歷史的 `from`、`to` 和時間欄位使用 Unix 毫秒。訂單和帳戶生命週期時間以各介面欄位說明為準。

## 多語言欄位

部分文本欄位使用語言對象回傳：

```json theme={null}
{"en":"Yes","cn":"是","tw":"是"}
```

## 數值欄位

價格、數量、成交額、餘額、手續費等金額類欄位通常以字串回傳。建議使用 Decimal 精度處理，避免二進制浮點誤差。

## 狀態欄位

Market 的 `status` 描述市場狀態；REST 訂單的 `status` 使用 `processing`、`open`、`matched`、`canceled`、`failed`。WebSocket 訊息的 `type` 表示推送訊息類型。請分別依市場、REST 訂單及 WebSocket 頻道的定義解析，不要共用一套狀態枚舉。

## 標準錯誤

錯誤回應包含 `label` 和 `message`。公開行情介面的參數錯誤使用 `INVALID_PARAM_VALUE`，行情來源不可用使用 `QUOTE_UNAVAILABLE`；Broker 私有業務介面的參數錯誤可能使用 `INVALID_ARGUMENT`。請以各介面的錯誤定義為準。

| HTTP 狀態 | 說明 |
| - | - |
| `400` | 請求參數或 Body 無效 |
| `401` | 私有介面認證失敗 |
| `404` | 資源不存在或目前不可見 |
| `503` | 上游或服務暫時不可用 |


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