xtraderClient/docs/api/position.md
2026-03-02 11:47:34 +08:00

19 lines
663 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# position.ts
**路径**`src/api/position.ts`
## 功能用途
持仓相关 API分页获取持仓列表以及将 `ClobPositionItem` 映射为钱包展示项。`PageResult` 来自 `@/api/types`,使用 `buildQuery` 构建请求参数。
## 核心能力
- `getPositionList`:分页获取持仓列表(需鉴权)
- `mapPositionToDisplayItem`:将接口项转为展示结构(含 locked、availableSharesNum、outcome 等);`outcome` 保留 API 原始值(如 "Up"/"Down"、"Yes"/"No"),供 TradeDetail 与市场 outcomes 匹配
## 使用方式
```typescript
import { getPositionList, mapPositionToDisplayItem } from '@/api/position'
```