|
1 | 1 | # PTrade API 完整接口总结 |
2 | 2 |
|
| 3 | +## 相比当前总结文档,新增的回测可用 API(9个): |
| 4 | + - `get_trading_day_by_date` |
| 5 | + - `get_trend_data` |
| 6 | + - `get_reits_list` |
| 7 | + - `get_dominant_contract` |
| 8 | + - `log` |
| 9 | + - `get_frequency` |
| 10 | + - `get_business_type` |
| 11 | + - `get_current_kline_count` |
| 12 | + - `filter_stock_by_status` |
| 13 | +- 说明:`option_*` 与 `get_opt_*` 相关接口目前在你当前官方页面可见内容中不可检索,已从“当前基线清单”移至“待确认接口”。 |
| 14 | + |
3 | 15 | ## 策略生命周期函数使用限制说明 📋 |
4 | 16 |
|
5 | 17 | 本文档为每个API函数标注了它们只能在特定的策略生命周期函数中使用,标注格式为 `{函数名}`: |
|
45 | 57 | - **set_volume_ratio(ratio)** - 设置成交比例 *[仅回测]* `{initialize}` |
46 | 58 | - **set_limit_mode(mode)** - 设置回测成交数量限制模式 *[仅回测]* `{initialize}` |
47 | 59 | - **set_yesterday_position(positions)** - 设置底仓 *[仅回测]* `{initialize}` |
48 | | -- **set_parameters(params)** - 设置策略配置参数 *[回测/交易]* `{initialize}` |
| 60 | +- **set_parameters(params)** - 设置策略配置参数 *[仅交易]* `{initialize}` |
49 | 61 |
|
50 | 62 | ### 定时函数 |
51 | 63 | - **run_daily(func, time)** - 按日周期处理 *[回测/交易]* `{initialize}` |
52 | 64 | - **run_interval(func, interval)** - 按设定周期处理 *[仅交易]* `{initialize}` |
53 | 65 |
|
54 | 66 | ### 期货设置 |
55 | 67 | - **set_future_commission(commission)** - 设置期货手续费 *[仅回测]* `{initialize}` |
56 | | -- **set_margin_rate(security, rate)** - 设置期货保证金比例 *[回测/交易]* `{initialize}` |
| 68 | +- **set_margin_rate(security, rate)** - 设置期货保证金比例 *[仅回测]* `{initialize}` |
57 | 69 |
|
58 | 70 | ## 获取信息函数 (50+个) |
59 | 71 |
|
|
68 | 80 | - **get_cb_list()** - 获取可转债市场代码表 *[仅交易]* `{all}` |
69 | 81 |
|
70 | 82 | ### 行情信息 (10个) |
71 | | -- **get_history(count, frequency, field, security_list, fq, include, fill, is_dict, start_date, end_date)** - 获取历史行情 *[回测/交易]* `{all}` |
| 83 | +- **get_history(count, frequency, field, security_list, fq, include, fill, is_dict, start_date, end_date)** - 获取历史行情 *[研究/回测/交易]* `{all}` |
72 | 84 | - **get_price(security, start_date, end_date, frequency, fields, count)** - 获取历史数据 *[研究/回测/交易]* `{all}` |
73 | 85 | - **get_individual_entrust(security_list)** - 获取逐笔委托行情 *[仅交易]* `{tick_data}` |
74 | 86 | - **get_individual_transaction(security_list)** - 获取逐笔成交行情 *[仅交易]* `{tick_data}` |
|
78 | 90 | - **get_etf_stock_info(etf_code)** - 获取ETF成分券信息 *[仅交易]* `{all}` |
79 | 91 | - **get_gear_price(security_list)** - 获取指定代码的档位行情价格 *[仅交易]* `{handle_data|tick_data}` |
80 | 92 | - **get_snapshot(security_list)** - 获取行情快照 *[仅交易]* `{handle_data|tick_data}` |
81 | | -- **get_cb_info(cb_code)** - 获取可转债基础信息 *[研究/交易]* `{all}` |
| 93 | +- **get_cb_info(cb_code)** - 获取可转债基础信息 *[仅交易]* `{all}` |
82 | 94 |
|
83 | 95 | ### 股票信息 (12个) |
84 | 96 | - **get_stock_name(security_list)** - 获取股票名称 *[研究/回测/交易]* `{all}` |
|
134 | 146 |
|
135 | 147 | ### 融资融券交易类函数 (7个) |
136 | 148 | - **margin_trade(security, amount, limit_price=None)** - 担保品买卖 *[两融回测/两融交易]* `{handle_data|tick_data}` |
137 | | -- **margincash_open(security, amount, limit_price=None)** - 融资买入 *[仅两融交易]* `{handle_data|tick_data}` |
138 | | -- **margincash_close(security, amount, limit_price=None)** - 卖券还款 *[仅两融交易]* `{handle_data|tick_data}` |
139 | | -- **margincash_direct_refund(amount)** - 直接还款 *[仅两融交易]* `{handle_data|after_trading_end}` |
140 | | -- **marginsec_open(security, amount, limit_price=None)** - 融券卖出 *[仅两融交易]* `{handle_data|tick_data}` |
141 | | -- **marginsec_close(security, amount, limit_price=None)** - 买券还券 *[仅两融交易]* `{handle_data|tick_data}` |
142 | | -- **marginsec_direct_refund(security, amount)** - 直接还券 *[仅两融交易]* `{handle_data|after_trading_end}` |
| 149 | +- **margincash_open(security, amount, limit_price=None)** - 融资买入 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 150 | +- **margincash_close(security, amount, limit_price=None)** - 卖券还款 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 151 | +- **margincash_direct_refund(amount)** - 直接还款 *[仅交易(两融账户)]* `{handle_data|after_trading_end}` |
| 152 | +- **marginsec_open(security, amount, limit_price=None)** - 融券卖出 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 153 | +- **marginsec_close(security, amount, limit_price=None)** - 买券还券 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 154 | +- **marginsec_direct_refund(security, amount)** - 直接还券 *[仅交易(两融账户)]* `{handle_data|after_trading_end}` |
143 | 155 |
|
144 | 156 | ### 融资融券查询类函数 (12个) |
145 | | -- **get_margincash_stocks()** - 获取融资标的列表 *[仅两融交易]* `{all}` |
146 | | -- **get_marginsec_stocks()** - 获取融券标的列表 *[仅两融交易]* `{all}` |
147 | | -- **get_margin_contract()** - 合约查询 *[仅两融交易]* `{all}` |
148 | | -- **get_margin_contractreal()** - 实时合约查询 *[仅两融交易]* `{handle_data|tick_data}` |
149 | | -- **get_margin_assert()** - 信用资产查询 *[仅两融交易]* `{all}` |
150 | | -- **get_assure_security_list()** - 担保券查询 *[仅两融交易]* `{all}` |
151 | | -- **get_margincash_open_amount(security)** - 融资标的最大可买数量查询 *[仅两融交易]* `{handle_data|tick_data}` |
152 | | -- **get_margincash_close_amount(security)** - 卖券还款标的最大可卖数量查询 *[仅两融交易]* `{handle_data|tick_data}` |
153 | | -- **get_marginsec_open_amount(security)** - 融券标的最大可卖数量查询 *[仅两融交易]* `{handle_data|tick_data}` |
154 | | -- **get_marginsec_close_amount(security)** - 买券还券标的最大可买数量查询 *[仅两融交易]* `{handle_data|tick_data}` |
155 | | -- **get_margin_entrans_amount(security)** - 现券还券数量查询 *[仅两融交易]* `{handle_data|tick_data}` |
156 | | -- **get_enslo_security_info(security)** - 融券头寸信息查询 *[仅两融交易]* `{all}` |
| 157 | +- **get_margincash_stocks()** - 获取融资标的列表 *[仅交易(两融账户)]* `{all}` |
| 158 | +- **get_marginsec_stocks()** - 获取融券标的列表 *[仅交易(两融账户)]* `{all}` |
| 159 | +- **get_margin_contract()** - 合约查询 *[仅交易(两融账户)]* `{all}` |
| 160 | +- **get_margin_contractreal()** - 实时合约查询 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 161 | +- **get_margin_assert()** - 信用资产查询 *[仅交易(两融账户)]* `{all}` |
| 162 | +- **get_assure_security_list()** - 担保券查询 *[仅交易(两融账户)]* `{all}` |
| 163 | +- **get_margincash_open_amount(security)** - 融资标的最大可买数量查询 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 164 | +- **get_margincash_close_amount(security)** - 卖券还款标的最大可卖数量查询 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 165 | +- **get_marginsec_open_amount(security)** - 融券标的最大可卖数量查询 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 166 | +- **get_marginsec_close_amount(security)** - 买券还券标的最大可买数量查询 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 167 | +- **get_margin_entrans_amount(security)** - 现券还券数量查询 *[仅交易(两融账户)]* `{handle_data|tick_data}` |
| 168 | +- **get_enslo_security_info(security)** - 融券头寸信息查询 *[仅交易(两融账户)]* `{all}` |
157 | 169 |
|
158 | 170 | ## 期货专用函数 (7个) |
159 | 171 |
|
|
170 | 182 | ### 期货设置类函数 (1个) |
171 | 183 | - **set_future_commission(commission)** - 设置期货手续费 *[仅回测]* `{initialize}` |
172 | 184 |
|
173 | | -## 期权专用函数 (15个) |
| 185 | +## 期权专用函数(待确认,当前页面不可见) (15个) |
174 | 186 |
|
175 | 187 | ### 期权查询类函数 (6个) |
176 | 188 | - **get_opt_objects()** - 获取期权标的列表 *[研究/回测/交易]* `{all}` |
|
181 | 193 | - **get_covered_unlock_amount(underlying)** - 获取期权标的允许备兑解锁数量 *[仅交易]* `{handle_data|tick_data}` |
182 | 194 |
|
183 | 195 | ### 期权交易类函数 (7个) |
184 | | -- **buy_open(security, amount, limit_price=None)** - 权利仓开仓 *[仅交易]* `{handle_data|tick_data}` |
185 | | -- **sell_close(security, amount, limit_price=None)** - 权利仓平仓 *[仅交易]* `{handle_data|tick_data}` |
186 | | -- **sell_open(security, amount, limit_price=None)** - 义务仓开仓 *[仅交易]* `{handle_data|tick_data}` |
187 | | -- **buy_close(security, amount, limit_price=None)** - 义务仓平仓 *[仅交易]* `{handle_data|tick_data}` |
| 196 | +- **option_buy_open(security, amount, limit_price=None)** - 权利仓开仓 *[仅交易]* `{handle_data|tick_data}` |
| 197 | +- **option_sell_close(security, amount, limit_price=None)** - 权利仓平仓 *[仅交易]* `{handle_data|tick_data}` |
| 198 | +- **option_sell_open(security, amount, limit_price=None)** - 义务仓开仓 *[仅交易]* `{handle_data|tick_data}` |
| 199 | +- **option_buy_close(security, amount, limit_price=None)** - 义务仓平仓 *[仅交易]* `{handle_data|tick_data}` |
188 | 200 | - **open_prepared(security, amount, limit_price=None)** - 备兑开仓 *[仅交易]* `{handle_data|tick_data}` |
189 | 201 | - **close_prepared(security, amount, limit_price=None)** - 备兑平仓 *[仅交易]* `{handle_data|tick_data}` |
190 | 202 | - **option_exercise(security, amount)** - 行权 *[仅交易]* `{handle_data|after_trading_end}` |
|
210 | 222 | - **send_email(send_email_info, get_email_info, smtp_code, info, path, subject)** - 发送邮箱信息 *[仅交易]* `{after_trading_end|on_order_response|on_trade_response}` |
211 | 223 | - **send_qywx(corp_id, secret, agent_id, info, path, toparty, touser, totag)** - 发送企业微信信息 *[仅交易]* `{after_trading_end|on_order_response|on_trade_response}` |
212 | 224 | - **permission_test(account=None, end_date=None)** - 权限校验 *[仅交易]* `{initialize}` |
213 | | -- **create_dir(user_path=None)** - 创建文件路径 *[仅交易]* `{initialize}` |
| 225 | +- **create_dir(user_path=None)** - 创建文件路径 *[研究/回测/交易]* `{initialize}` |
214 | 226 |
|
215 | 227 | ## 对象定义 (11个核心对象) |
216 | 228 |
|
|
0 commit comments