券商管理 API
模块: brokers
本模块包含 15 个API端点。
📋 端点列表
- 🔍
GET /api/v1/brokers- Get All Brokers - ➕
POST /api/v1/brokers- Create Broker - 🔍
GET /api/v1/brokers/{broker_id}- Get Broker - ✏️
PUT /api/v1/brokers/{broker_id}- Update Broker - 🗑️
DELETE /api/v1/brokers/{broker_id}- Delete Broker - ➕
POST /api/v1/brokers/{broker_id}/test- Test Broker Connection - 🔍
GET /api/v1/data-sources- Get All Data Sources - ➕
POST /api/v1/data-sources- Create Data Source - 🔍
GET /api/v1/data-sources/{data_source_id}- Get Data Source - ✏️
PUT /api/v1/data-sources/{data_source_id}- Update Data Source - 🗑️
DELETE /api/v1/data-sources/{data_source_id}- Delete Data Source - ➕
POST /api/v1/data-sources/{data_source_id}/test- Test Data Source Connection - 🔍
GET /api/v1/brokers/{broker_id}/fee-config- Get Fee Config - ✏️
PUT /api/v1/brokers/{broker_id}/fee-config- Update Fee Config - ➕
POST /api/v1/brokers/{broker_id}/fee-config/calculate- Calculate Fee
📖 详细说明
🔍 Get All Brokers
获取券商列表
请求方式: GET /api/v1/brokers
响应:
// 数组: BrokerResponse[]
- `name` (string) - **必填** - 券商名称
- `code` (string) - **必填** - 券商代码
- `type` (object) - **必填** - 券商类型
- 类型: `BrokerType`
- `status` (object) - 可选 - 状态
- 类型: `BrokerStatus`
- `config` (object) - **必填** - 券商配置(脱敏)
- `user_id` (string) - **必填** - 所属用户ID
- `id` (string) - **必填** - 券商ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
➕ Create Broker
创建券商
请求方式: POST /api/v1/brokers
请求体:
// 参考模型: BrokerCreate
- `name` (string) - **必填** - 券商名称
- `code` (string) - **必填** - 券商代码
- `type` (object) - **必填** - 券商类型
- 类型: `BrokerType`
- `status` (object) - 可选 - 状态
- 类型: `BrokerStatus`
- `config` (object) - **必填** - 券商配置
- 类型: `BrokerConfig`
- `user_id` (string) - **必填** - 所属用户ID
响应:
// 参考模型: BrokerResponse
- `name` (string) - **必填** - 券商名称
- `code` (string) - **必填** - 券商代码
- `type` (object) - **必填** - 券商类型
- 类型: `BrokerType`
- `status` (object) - 可选 - 状态
- 类型: `BrokerStatus`
- `config` (object) - **必填** - 券商配置(脱敏)
- `user_id` (string) - **必填** - 所属用户ID
- `id` (string) - **必填** - 券商ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
错误响应:
422: Validation Error
🔍 Get Broker
获取券商详情
请求方式: GET /api/v1/brokers/{broker_id}
路径参数:
broker_id(string) - 必填 -
响应:
// 参考模型: BrokerResponse
- `name` (string) - **必填** - 券商名称
- `code` (string) - **必填** - 券商代码
- `type` (object) - **必填** - 券商类型
- 类型: `BrokerType`
- `status` (object) - 可选 - 状态
- 类型: `BrokerStatus`
- `config` (object) - **必填** - 券商配置(脱敏)
- `user_id` (string) - **必填** - 所属用户ID
- `id` (string) - **必填** - 券商ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
错误响应:
422: Validation Error
✏️ Update Broker
更新券商
请求方式: PUT /api/v1/brokers/{broker_id}
路径参数:
broker_id(string) - 必填 -
请求体:
// 参考模型: BrokerUpdate
- `name` (object) - 可选 -
- `code` (object) - 可选 -
- `type` (object) - 可选 -
- `status` (object) - 可选 -
- `config` (object) - 可选 -
响应:
// 参考模型: BrokerResponse
- `name` (string) - **必填** - 券商名称
- `code` (string) - **必填** - 券商代码
- `type` (object) - **必填** - 券商类型
- 类型: `BrokerType`
- `status` (object) - 可选 - 状态
- 类型: `BrokerStatus`
- `config` (object) - **必填** - 券商配置(脱敏)
- `user_id` (string) - **必填** - 所属用户ID
- `id` (string) - **必填** - 券商ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
错误响应:
422: Validation Error
🗑️ Delete Broker
删除券商
请求方式: DELETE /api/v1/brokers/{broker_id}
路径参数:
broker_id(string) - 必填 -
错误响应:
204: Successful Response422: Validation Error
➕ Test Broker Connection
测试券商连接
请求方式: POST /api/v1/brokers/{broker_id}/test
路径参数:
broker_id(string) - 必填 -
响应:
// 参考模型: TestResponse
- `success` (boolean) - **必填** - 测试结果
- `message` (string) - **必填** - 测试消息
- `response_time` (object) - 可选 - 响应时间(毫秒)
错误响应:
422: Validation Error
🔍 Get All Data Sources
获取数据源列表
请求方式: GET /api/v1/data-sources
响应:
// 数组: DataSource[]
- `name` (string) - **必填** - 数据源名称
- `type` (object) - **必填** - 数据源类型
- 类型: `DataSourceType`
- `broker_id` (string) - **必填** - 关联券商ID
- `status` (object) - 可选 - 状态
- 类型: `DataSourceStatus`
- `priority` (integer) - 可选 - 优先级
- `id` (string) - **必填** - 数据源ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
➕ Create Data Source
创建数据源(仅管理员)
请求方式: POST /api/v1/data-sources
请求体:
// 参考模型: DataSourceCreate
- `name` (string) - **必填** - 数据源名称
- `type` (object) - **必填** - 数据源类型
- 类型: `DataSourceType`
- `broker_id` (string) - **必填** - 关联券商ID
- `status` (object) - 可选 - 状态
- 类型: `DataSourceStatus`
- `priority` (integer) - 可选 - 优先级
响应:
// 参考模型: DataSource
- `name` (string) - **必填** - 数据源名称
- `type` (object) - **必填** - 数据源类型
- 类型: `DataSourceType`
- `broker_id` (string) - **必填** - 关联券商ID
- `status` (object) - 可选 - 状态
- 类型: `DataSourceStatus`
- `priority` (integer) - 可选 - 优先级
- `id` (string) - **必填** - 数据源ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
错误响应:
422: Validation Error
🔍 Get Data Source
获取数据源详情
请求方式: GET /api/v1/data-sources/{data_source_id}
路径参数:
data_source_id(string) - 必填 -
响应:
// 参考模型: DataSource
- `name` (string) - **必填** - 数据源名称
- `type` (object) - **必填** - 数据源类型
- 类型: `DataSourceType`
- `broker_id` (string) - **必填** - 关联券商ID
- `status` (object) - 可选 - 状态
- 类型: `DataSourceStatus`
- `priority` (integer) - 可选 - 优先级
- `id` (string) - **必填** - 数据源ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
错误响应:
422: Validation Error
✏️ Update Data Source
更新数据源(仅管理员)
请求方式: PUT /api/v1/data-sources/{data_source_id}
路径参数:
data_source_id(string) - 必填 -
请求体:
// 参考模型: DataSourceUpdate
- `name` (object) - 可选 -
- `type` (object) - 可选 -
- `broker_id` (object) - 可选 -
- `status` (object) - 可选 -
- `priority` (object) - 可选 -
响应:
// 参考模型: DataSource
- `name` (string) - **必填** - 数据源名称
- `type` (object) - **必填** - 数据源类型
- 类型: `DataSourceType`
- `broker_id` (string) - **必填** - 关联券商ID
- `status` (object) - 可选 - 状态
- 类型: `DataSourceStatus`
- `priority` (integer) - 可选 - 优先级
- `id` (string) - **必填** - 数据源ID
- `created_at` (string) - **必填** - 创建时间
- `updated_at` (string) - **必填** - 更新时间
错误响应:
422: Validation Error
🗑️ Delete Data Source
删除数据源(仅管理员)
请求方式: DELETE /api/v1/data-sources/{data_source_id}
路径参数:
data_source_id(string) - 必填 -
错误响应:
204: Successful Response422: Validation Error
➕ Test Data Source Connection
测试数据源连接
请求方式: POST /api/v1/data-sources/{data_source_id}/test
路径参数:
data_source_id(string) - 必填 -
响应:
// 参考模型: TestResponse
- `success` (boolean) - **必填** - 测试结果
- `message` (string) - **必填** - 测试消息
- `response_time` (object) - 可选 - 响应时间(毫秒)
错误响应:
422: Validation Error
🔍 Get Fee Config
获取券商费用配置
Args: broker_id: 券商ID current_user: 当前用户
Returns: FeeConfig: 费用配置对象
请求方式: GET /api/v1/brokers/{broker_id}/fee-config
路径参数:
broker_id(string) - 必填 -
响应:
// 参考模型: FeeConfig-Output
- `us_fees` (object) - 可选 - 美股费用配置
- 类型: `USFeeConfig-Output`
- `hk_fees` (object) - 可选 - 港股费用配置
- 类型: `HKFeeConfig-Output`
错误响应:
422: Validation Error
✏️ Update Fee Config
更新券商费用配置
Args: broker_id: 券商ID fee_config: 费用配置对象 current_user: 当前用户
Returns: FeeConfig: 更新后的费用配置对象
请求方式: PUT /api/v1/brokers/{broker_id}/fee-config
路径参数:
broker_id(string) - 必填 -
请求体:
// 参考模型: FeeConfig-Input
- `us_fees` (object) - 可选 - 美股费用配置
- 类型: `USFeeConfig-Input`
- `hk_fees` (object) - 可选 - 港股费用配置
- 类型: `HKFeeConfig-Input`
响应:
// 参考模型: FeeConfig-Output
- `us_fees` (object) - 可选 - 美股费用配置
- 类型: `USFeeConfig-Output`
- `hk_fees` (object) - 可选 - 港股费用配置
- 类型: `HKFeeConfig-Output`
错误响应:
422: Validation Error
➕ Calculate Fee
计算预估交易费用
Args: broker_id: 券商ID request: 费用计算请求(包含数量、价格、方向、市场) current_user: 当前用户
Returns: FeeCalculateResponse: 费用计算结果(包含明细和总成本)
请求方式: POST /api/v1/brokers/{broker_id}/fee-config/calculate
路径参数:
broker_id(string) - 必填 -
请求体:
// 参考模型: FeeCalculateRequest
- `broker_id` (string) - **必填** - 券商ID
- `quantity` (object) - **必填** - 成交数量
- `price` (object) - **必填** - 成交价格
- `side` (string) - **必填** - 买卖方向(buy/sell)
- `market` (string) - **必填** - 市场类型(US/HK)
响应:
// 参考模型: FeeCalculateResponse
- `fee_details` (object) - **必填** - 费用明细
- 类型: `TradingFee`
- `trade_amount` (string) - **必填** - 交易金额
- `total_cost` (string) - **必填** - 总成本(交易金额+费用)
错误响应:
422: Validation Error