API测试 API
模块: api-test
本模块包含 25 个API端点。
📋 端点列表
- ➕
POST /api/v1/api-test/pull/static-info- Test Static Info - ➕
POST /api/v1/api-test/pull/quote- Test Quote - ➕
POST /api/v1/api-test/pull/depth- Test Depth - ➕
POST /api/v1/api-test/pull/trades- Test Trades - ➕
POST /api/v1/api-test/pull/intraday- Test Intraday - ➕
POST /api/v1/api-test/pull/candlesticks- Test Candlesticks - ➕
POST /api/v1/api-test/pull/trading-days- Test Trading Days - ➕
POST /api/v1/api-test/pull/trading-session- Test Trading Session - ➕
POST /api/v1/api-test/pull/calc-indexes- Test Calc Indexes - ➕
POST /api/v1/api-test/pull/history-candlesticks- Test History Candlesticks - ➕
POST /api/v1/api-test/subscription/subscriptions- Test Subscriptions - ➕
POST /api/v1/api-test/subscription/subscribe- Test Subscribe - ➕
POST /api/v1/api-test/subscription/unsubscribe- Test Unsubscribe - ➕
POST /api/v1/api-test/subscription/realtime-quote- Test Realtime Quote - ➕
POST /api/v1/api-test/subscription/realtime-depth- Test Realtime Depth - ➕
POST /api/v1/api-test/subscription/realtime-trades- Test Realtime Trades - 🔍
GET /api/v1/api-test/trade/supported-order-types/{market}- Get Supported Order Types - 🔍
GET /api/v1/api-test/trade/order-type-fields/{order_type}- Get Order Type Required Fields - ➕
POST /api/v1/api-test/trade/submit-order- Test Submit Order - ➕
POST /api/v1/api-test/trade/replace-order- Test Replace Order - ➕
POST /api/v1/api-test/trade/cancel-order- Test Cancel Order - ➕
POST /api/v1/api-test/trade/today-executions- Test Today Executions - ➕
POST /api/v1/api-test/trade/history-executions- Test History Executions - ➕
POST /api/v1/api-test/trade/order-detail- Test Order Detail - ➕
POST /api/v1/api-test/trade/estimate-max-purchase- Test Estimate Max Purchase Quantity
📖 详细说明
➕ Test Static Info
测试获取标的基础信息
请求方式: POST /api/v1/api-test/pull/static-info
请求体:
// 参考模型: StaticInfoRequest
- `symbols` (object) - **必填** - 股票代码列表或逗号分隔的字符串
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Quote
测试获取标的实时行情
请求方式: POST /api/v1/api-test/pull/quote
请求体:
// 参考模型: QuoteRequest
- `symbols` (object) - **必填** - 股票代码列表或逗号分隔的字符串
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Depth
测试获取标的盘口
请求方式: POST /api/v1/api-test/pull/depth
请求体:
// 参考模型: DepthRequest
- `symbol` (string) - **必填** - 股票代码
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Trades
测试获取标的成交明细
请求方式: POST /api/v1/api-test/pull/trades
请求体:
// 参考模型: TradesRequest
- `symbol` (string) - **必填** - 股票代码
- `count` (integer) - 可选 - 获取数量
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Intraday
测试获取标的分时
请求方式: POST /api/v1/api-test/pull/intraday
请求体:
// 参考模型: IntradayRequest
- `symbol` (string) - **必填** - 股票代码
- `trade_sessions` (string) - 可选 - 交易时段
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Candlesticks
测试获取标的K线
请求方式: POST /api/v1/api-test/pull/candlesticks
请求体:
// 参考模型: CandlesticksRequest
- `symbol` (string) - **必填** - 股票代码
- `period` (string) - 可选 - K线周期
- `count` (integer) - 可选 - 获取数量
- `adjust_type` (string) - 可选 - 复权类型
- `trade_sessions` (string) - 可选 - 交易时段
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Trading Days
测试获取市场交易日
请求方式: POST /api/v1/api-test/pull/trading-days
请求体:
// 参考模型: TradingDaysRequest
- `market` (string) - **必填** - 市场类型
- `begin` (object) - **必填** - 开始日期
- `end` (object) - **必填** - 结束日期
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Trading Session
测试获取各市场当日交易时段
请求方式: POST /api/v1/api-test/pull/trading-session
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
➕ Test Calc Indexes
测试获取标的计算指标
请求方式: POST /api/v1/api-test/pull/calc-indexes
请求体:
// 参考模型: CalcIndexesRequest
- `symbols` (object) - **必填** - 股票代码列表或逗号分隔的字符串
- `indexes` (object) - **必填** - 计算指标列表或逗号分隔的字符串
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test History Candlesticks
测试获取标的历史K线
请求方式: POST /api/v1/api-test/pull/history-candlesticks
请求体:
// 参考模型: HistoryCandlesticksRequest
- `symbol` (string) - **必填** - 股票代码
- `period` (string) - 可选 - K线周期
- `adjust_type` (string) - 可选 - 复权类型
- `start` (object) - **必填** - 开始日期
- `end` (object) - **必填** - 结束日期
- `trade_sessions` (string) - 可选 - 交易时段
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Subscriptions
测试获取已订阅标的行情
请求方式: POST /api/v1/api-test/subscription/subscriptions
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
➕ Test Subscribe
测试订阅行情数据
请求方式: POST /api/v1/api-test/subscription/subscribe
请求体:
// 参考模型: SubscribeRequest
- `symbols` (object) - **必填** - 股票代码列表或逗号分隔的字符串
- `sub_types` (object) - **必填** - 订阅类型列表或逗号分隔的字符串
- `is_first_push` (boolean) - 可选 - 是否立即推送
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Unsubscribe
测试取消订阅行情数据
请求方式: POST /api/v1/api-test/subscription/unsubscribe
请求体:
// 参考模型: UnsubscribeRequest
- `symbols` (object) - **必填** - 股票代码列表或逗号分隔的字符串
- `sub_types` (object) - **必填** - 订阅类型列表或逗号分隔的字符串
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Realtime Quote
测试实时价格推送
请求方式: POST /api/v1/api-test/subscription/realtime-quote
请求体:
// 参考模型: RealtimeQuoteRequest
- `symbols` (object) - **必填** - 股票代码列表或逗号分隔的字符串
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Realtime Depth
测试实时盘口推送
请求方式: POST /api/v1/api-test/subscription/realtime-depth
请求体:
// 参考模型: RealtimeDepthRequest
- `symbol` (string) - **必填** - 股票代码
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Realtime Trades
测试实时成交明细推送
请求方式: POST /api/v1/api-test/subscription/realtime-trades
请求体:
// 参考模型: RealtimeTradesRequest
- `symbol` (string) - **必填** - 股票代码
- `count` (integer) - 可选 - 获取数量
响应:
// 参考模型: ApiTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
🔍 Get Supported Order Types
获取指定市场支持的订单类型
请求方式: GET /api/v1/api-test/trade/supported-order-types/{market}
路径参数:
market(string) - 必填 -
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
🔍 Get Order Type Required Fields
获取订单类型必填字段
请求方式: GET /api/v1/api-test/trade/order-type-fields/{order_type}
路径参数:
order_type(string) - 必填 -
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Submit Order
测试委托下单
请求方式: POST /api/v1/api-test/trade/submit-order
请求体:
// 参考模型: SubmitOrderRequest
- `symbol` (string) - **必填** - 股票代码
- `order_type` (string) - **必填** - 订单类型
- `side` (string) - **必填** - 买卖方向
- `submitted_quantity` (object) - **必填** - 委托数量
- `time_in_force` (string) - **必填** - 订单有效期
- `submitted_price` (object) - 可选 - 委托价格
- `trigger_price` (object) - 可选 - 触发价格
- `limit_offset` (object) - 可选 - 限价偏移
- `trailing_amount` (object) - 可选 - 追踪金额
- `trailing_percent` (object) - 可选 - 追踪百分比
- `expire_date` (object) - 可选 - 过期日期
- `outside_rth` (object) - 可选 - 盘前盘后交易
- `remark` (object) - 可选 - 备注
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Replace Order
测试改单
请求方式: POST /api/v1/api-test/trade/replace-order
请求体:
// 参考模型: ReplaceOrderRequest
- `order_id` (string) - **必填** - 订单ID
- `quantity` (object) - **必填** - 修改数量
- `price` (object) - 可选 - 修改价格
- `trigger_price` (object) - 可选 - 修改触发价格
- `remark` (object) - 可选 - 备注
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Cancel Order
测试撤单
请求方式: POST /api/v1/api-test/trade/cancel-order
请求体:
// 参考模型: CancelOrderRequest
- `order_id` (string) - **必填** - 订单ID
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Today Executions
测试获取当日成交明细
请求方式: POST /api/v1/api-test/trade/today-executions
请求体:
// 参考模型: GetExecutionsRequest
- `symbol` (object) - 可选 - 股票代码
- `order_id` (object) - 可选 - 订单ID
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test History Executions
测试获取历史成交明细
请求方式: POST /api/v1/api-test/trade/history-executions
请求体:
// 参考模型: GetHistoryExecutionsRequest
- `symbol` (object) - 可选 - 股票代码
- `start_at` (object) - 可选 - 开始时间
- `end_at` (object) - 可选 - 结束时间
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Order Detail
测试获取订单详情
请求方式: POST /api/v1/api-test/trade/order-detail
请求体:
// 参考模型: GetOrderDetailRequest
- `order_id` (string) - **必填** - 订单ID
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error
➕ Test Estimate Max Purchase Quantity
测试估算最大购买数量
请求方式: POST /api/v1/api-test/trade/estimate-max-purchase
请求体:
// 参考模型: EstimateMaxPurchaseQuantityRequest
- `symbol` (string) - **必填** - 股票代码
- `order_type` (string) - **必填** - 订单类型
- `side` (string) - **必填** - 买卖方向
- `price` (object) - 可选 - 估算价格
- `currency` (object) - 可选 - 货币
- `order_id` (object) - 可选 - 订单ID(修改订单时使用)
- `fractional_shares` (boolean) - 可选 - 是否支持碎股
响应:
// 参考模型: TradeTestResponse
- `success` (boolean) - **必填** - 是否成功
- `message` (string) - **必填** - 人类可读的结果描述
- `data` (object) - 可选 - 原始数据
- `error` (object) - 可选 - 错误信息
错误响应:
422: Validation Error