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

# API 概览 - 基础 URL、约定与端点

> Apexium API 的基础 URL、格式和约定，以及端点一览：健康状态、账户、行情数据、投注单、订单、注单、持仓和盈亏。

## 基础 URL

| 环境 | 基础 URL |
| - | - |
| 生产 | `https://api.apexiumbet.com` |

集成期间可按需提供测试环境，它有自己的基础 URL 和密钥。每个路径都以 `/v1` 开头。请在 `x-api-key` 头中发送您的密钥；参见[认证](https://docs.apexiumbet.com/zh/api-reference/authentication.md)。

## 语言

只有行情数据带有语言，作为其路径的第一段：`/v1/{lang}/…`。`lang` 取 `en`、`es`、`fr`、`pt`、`de`、`it`、`ru`、`zh` 之一。

```
/v1/en/fixtures
/v1/de/fixtures
```

* **名称**（例如 `sportName`）在有翻译时使用该语言。
* **标识符**永远不依赖于语言。
* **API 参考**以英语展示行情数据路径：将 `en` 替换为您需要的语言。
* **其他端点**没有需要翻译的文本，也不带语言。

在 WebSocket 上，登录时的 `lang` 决定 `fixtures` 频道的语言；参见 [WebSocket 语言](https://docs.apexiumbet.com/zh/websocket/overview.md#语言)。

## 约定

* 请求和响应均使用 **JSON**，请求体需带上 `content-type: application/json`。
* **金额**是一个包含十进制字符串、以整数分表示的同一金额和货币的对象：`{ "amount": "12.50", "amountCents": 1250, "currency": "USD" }`。参见[金额](https://docs.apexiumbet.com/zh/guides/money.md)。
* **价格**是以字符串表示的十进制赔率：`"1.95"`。
* **时间**采用 UTC 的 ISO 8601 格式：`"2026-10-05T14:30:00.000Z"`。
* **标识符**：订单和注单使用 UUID。`fixtureId`、`outcomeId` 和 `playerId` 是行情数据所使用的 OddsPapi 标识符。
* **列表**按最新优先排序，并通过游标分页：将 `nextCursor` 作为 `cursor` 传回，直到它为 `null`。
* **枚举**可能新增取值。请妥善处理您不认识的取值。
* **错误**带有稳定的 `code`；参见[错误](https://docs.apexiumbet.com/zh/api-reference/errors.md)。

## 端点

### 健康状态

| 端点 | 返回内容 |
| - | - |
| `GET /v1/health` | API 是否可用，以及其每个服务的状态 |

`GET /v1/health` 是 `/v1` 下唯一无需 API 密钥的端点。

```bash theme={null}
curl https://api.apexiumbet.com/v1/health
```

```json theme={null}
{
  "status": "degraded",
  "time": "2026-11-10T14:30:00.000Z",
  "services": {
    "database": "healthy",
    "caching": "healthy",
    "betPlacement": "healthy",
    "betUpdates": "degraded"
  }
}
```

* **状态。** 每个服务的状态为 `healthy`、`degraded` 或 `unhealthy`。`status` 取其中最差的一个。
* **`200`**：API 健康或降级时返回。降级的 API 仍可下单。
* **`503`**：API 不健康时返回相同的响应体；API 被关闭时返回 `503 PUBLIC_API_DISABLED`。
* **时效。** 结果最多每 15 秒刷新一次：更频繁地轮询只会得到相同的结果。
* **限制。** 每个地址每分钟 120 个请求；参见[限制](https://docs.apexiumbet.com/zh/api-reference/limits.md#健康检查)。

### 账户

| 端点 | 返回内容 |
| - | - |
| `GET /v1/me` | 密钥所属的账户：身份、状态、博彩公司、当前使用的密钥 |
| `GET /v1/balance` | 现金余额、授信额度、风险敞口和可用余额 |

### 行情数据

行情数据是 **OddsPapi v5**，位于 `/v1/{lang}` 下，使用 OddsPapi 的路径、参数、响应和标识符。`lang` 参见[语言](#语言)。

| 分组 | `/v1/{lang}` 下的路径 |
| - | - |
| Reference data | `sports`、`tournaments`、`seasons`、`venues`、`participants`、`players`、`markets`、`currencies`、`bookmakers` |
| Fixtures | `fixtures`、`fixtures/today`、`fixtures/live`、`fixtures/search` |
| Odds | `fixtures/odds`、`fixtures/odds/main`、`fixtures/odds/clv`、`fixtures/odds/historical` |

其他路径返回 `404`。赔率仅限于您账户的博彩公司：请求其他博彩公司会返回 `403 BOOKMAKER_NOT_AVAILABLE`。

```bash theme={null}
curl "https://api.apexiumbet.com/v1/en/fixtures/odds?fixtureId=id1000001761300868" \
  -H "x-api-key: apx_live_…"
```

有关运动、赛事、盘口和选项如何组合在一起，以及一行赔率如何变成订单，参见[行情数据与标识符](https://docs.apexiumbet.com/zh/api-reference/market-data.md)。

### 投注单

| 端点 | 返回内容 |
| - | - |
| `GET /v1/betslip` | 针对一个投注选项，您每家博彩公司的价格和投注额限额（已应用您账户的规则） |

投注单价格才是您下单所用的价格。它可能与行情数据中的赔率不同：参见[行情赔率与投注单](https://docs.apexiumbet.com/zh/guides/feed-odds-and-betslip.md)。

### 订单

| 端点 | 作用 |
| - | - |
| `POST /v1/orders` | 预览或下达订单；参见[预览与下单](https://docs.apexiumbet.com/zh/guides/preview-and-place.md) |
| `GET /v1/orders` | 列出您的订单 |
| `GET /v1/orders/{id}` | 读取一个订单及其注单 |
| `GET /v1/orders/by-client-id/{clientOrderId}` | 通过您自己的标识符读取一个订单 |
| `POST /v1/orders/{id}/cancel` | 撤销一个订单；参见[撤单](https://docs.apexiumbet.com/zh/guides/cancellation.md) |
| `POST /v1/orders/cancel-all` | 撤销账户、某场赛事或某个订单列表中挂单中的订单 |

### 注单、持仓与盈亏

| 端点 | 返回内容 |
| - | - |
| `GET /v1/bets` | 您的注单，可按状态、结算、赛事、博彩公司和时间筛选 |
| `GET /v1/bets/{id}` | 一个注单 |
| `GET /v1/positions` | 您的未结注单，按投注选项、赛事或博彩公司分组 |
| `GET /v1/pnl` | 您在某个时间窗口内的已结算结果 |

从仪表板下达的订单和注单也会出现在这些端点中。

## 参考文档

侧边栏中的端点页面是生成的：

* **健康状态、账户、投注单、订单、注单、持仓和盈亏。** 来自 API 导出的 OpenAPI 契约：字段、类型和状态码与 API 完全一致。
* **行情数据。** 来自 OddsPapi v5 参考文档，仅限于 Apexium 提供的路径和参数。


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