Documentation Index
Fetch the complete documentation index at: https://docs.nexfi.robert.dpdns.org/llms.txt
Use this file to discover all available pages before exploring further.
Quant 策略与执行
本页对应量化模块的策略管理、回测、执行和风控接口，补充每个接口的用途、主要入参、出参与示例。
POST /api/v1/admin/strategies
创建量化策略配置，用于策略上线前的初始化。
Body 参数
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|
strategyId | String | 是 | 策略唯一 ID | arb_binance_okx_btc |
strategyType | Enum | 是 | 策略类型 | cross_exchange_arbitrage |
symbols | String[] | 是 | 交易对列表 | ["BTC/USDT"] |
exchanges | Enum[] | 是 | 交易所列表 | ["binance","okx"] |
params | Object | 是 | 策略参数 | { "spreadBps": 8 } |
riskProfileId | String | 否 | 关联风控档案 ID | risk_default |
响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.strategyId | String | 策略 ID | arb_binance_okx_btc |
data.status | String | 初始状态 | created |
GET /api/v1/admin/strategies
获取策略列表，用于策略管理后台。
Query 参数
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|
status | String | 否 | 状态过滤 | running |
strategyType | String | 否 | 类型过滤 | cross_exchange_arbitrage |
page | Integer | 否 | 页码 | 1 |
pageSize | Integer | 否 | 每页大小 | 20 |
典型响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.items[].strategyId | String | 策略 ID | arb_binance_okx_btc |
data.items[].strategyType | String | 策略类型 | cross_exchange_arbitrage |
data.items[].symbols | String[] | 交易对列表 | ["BTC/USDT"] |
data.items[].exchanges | String[] | 交易所列表 | ["binance","okx"] |
data.items[].status | String | 策略状态 | running |
GET /api/v1/admin/strategies/{strategyId}
获取策略详情。
Path 参数
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|
strategyId | String | 是 | 策略 ID | arb_binance_okx_btc |
PUT /api/v1/admin/strategies/{strategyId}
更新策略参数或绑定的风控配置。
Body 参数
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|
params | Object | 否 | 新策略参数 | { "spreadBps": 10 } |
riskProfileId | String | 否 | 风控档案 ID | risk_conservative |
POST /api/v1/admin/strategies/{strategyId}/start
启动策略实例。
响应字段
返回：
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.strategyId | String | 策略 ID | arb_binance_okx_btc |
data.status | String | 启动后的状态 | running |
POST /api/v1/admin/strategies/{strategyId}/pause
暂停策略实例。
POST /api/v1/admin/strategies/{strategyId}/stop
停止策略实例。
GET /api/v1/admin/strategies/{strategyId}/runs
查询策略运行历史，用于排查异常和评估运行稳定性。
典型响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.items[].runId | String | 运行实例 ID | run_001 |
data.items[].strategyId | String | 策略 ID | arb_binance_okx_btc |
data.items[].status | String | 运行状态 | stopped |
data.items[].startedAt | String | 开始时间 | 2026-05-11T10:00:00.000Z |
data.items[].endedAt | String | 结束时间 | 2026-05-11T12:00:00.000Z |
POST /api/v1/admin/backtests
创建回测任务，用于策略验证和参数评估。
Body 参数
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|
strategyType | String | 是 | 策略类型 | cross_exchange_arbitrage |
symbols | String[] | 是 | 回测标的 | ["BTC/USDT"] |
timeRange | Object | 是 | 时间区间 | { "from": "2026-01-01", "to": "2026-03-01" } |
params | Object | 是 | 回测参数 | { "spreadBps": 8 } |
响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.backtestId | String | 回测任务 ID | bt_001 |
data.status | String | 回测状态 | queued |
GET /api/v1/admin/backtests/{backtestId}
获取回测结果。
典型响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.backtestId | String | 回测 ID | bt_001 |
data.status | String | 状态 | completed |
data.metrics | Object | 收益、夏普、最大回撤等指标 | { "sharpe": 1.8 } |
data.trades | Array | 交易明细 | [] |
POST /api/v1/execution/orders
提交执行订单。
Body 参数
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|
exchange | Enum | 是 | 交易所 | binance |
symbol | String | 是 | 交易对 | BTC/USDT |
side | String | 是 | 方向 | buy |
type | String | 是 | 订单类型 | limit |
price | Number | 否 | 限价单价格 | 62000 |
quantity | Number | 是 | 数量 | 0.1 |
响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.clientOrderId | String | 平台订单号 | ord_001 |
data.exchangeOrderId | String | 交易所订单号 | 998877 |
data.exchange | String | 交易所 | binance |
data.symbol | String | 交易对 | BTC/USDT |
data.status | String | 订单状态 | new |
GET /api/v1/execution/orders
查询执行订单列表。
Query 参数
| 参数 | 类型 | 必填 | 说明 | 示例 |
|---|
exchange | Enum | 否 | 交易所过滤 | binance |
symbol | String | 否 | 交易对过滤 | BTC/USDT |
status | String | 否 | 状态过滤 | filled |
GET /api/v1/execution/orders/{clientOrderId}
查询单笔执行订单详情。
POST /api/v1/execution/orders/{clientOrderId}/cancel
撤销未成交或部分成交订单。
GET /api/v1/execution/positions
获取当前持仓列表。
典型响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.items[].exchange | String | 交易所 | binance |
data.items[].symbol | String | 交易对 | BTC/USDT |
data.items[].positionSide | String | 持仓方向 | long |
data.items[].netQuantity | Number | 净持仓数量 | 0.5 |
GET /api/v1/execution/balances
获取交易所余额列表。
典型响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.items[].exchange | String | 交易所 | okx |
data.items[].asset | String | 资产 | USDT |
data.items[].available | Number | 可用余额 | 100000 |
data.items[].frozen | Number | 冻结余额 | 5000 |
GET /api/v1/risk/config
获取当前风控配置。
典型响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.maxPosition | Number | 单标的最大仓位 | 2 |
data.maxTotalExposure | Number | 总敞口上限 | 1000000 |
data.maxOrderSize | Number | 单笔最大下单量 | 100000 |
data.maxOrdersPerSecond | Integer | 每秒最大下单数 | 5 |
data.maxDailyLoss | Number | 每日最大亏损 | 20000 |
data.maxDrawdown | Number | 最大回撤阈值 | 0.15 |
data.killSwitch | Boolean | 是否启用熔断总开关 | false |
PUT /api/v1/risk/config
更新风控配置。
GET /api/v1/risk/events
查询风控事件列表，用于风控审计与异常排查。
典型响应字段
| 字段路径 | 类型 | 说明 | 示例 |
|---|
data.items[].eventId | String | 事件 ID | risk_evt_001 |
data.items[].eventType | String | 事件类型 | max_drawdown_triggered |
data.items[].level | String | 严重级别 | critical |
data.items[].message | String | 事件说明 | Drawdown threshold exceeded |
data.items[].createdAt | String | 事件时间 | 2026-05-11T10:00:00.000Z |