ScriptTrader - 脚本策略交易模块¶

单条查询¶

get_tick

• 入参：vt_symbol: str, use_df: bool = False

• 出参：TickData

查询单个标的最新tick，use_df为可选参数，用于把返回的类对象转化成DataFrame格式，便于数据分析。

tick = engine.get_tick(vt_symbol="rb2210.SHFE",use_df=False)

其中：

• vt_symbol：为本地合约代码，格式是合约品种+交易所，如rb2210.SHFE；

• use_df：为bool变量，默认False，返回TickData类对象，否则返回相应DataFrame，如下图所示：

get_order

• 入参：vt_orderid: str, use_df: bool = False

• 出参：OrderData

根据vt_orderid查询委托单的详细信息。

order = engine.get_order(vt_orderid="CTP.3_-1795780178_1",use_df=False)

其中，vt_orderid为本地委托号（在委托下单时，会自动返回该委托的vt_orderid）。

get_contract

• 入参：vt_symbol, use_df: bool = False

• 出参：ContractData

根据本地vt_symbol来查询对应合约对象的详细信息。

contract = engine.get_contract(vt_symbol="rb2210.SHFE",use_df=False)

get_account

• 入参：vt_accountid: str, use_df: bool = False

• 出参：AccountData

根据本地vt_accountid来查询对应资金信息。

account = engine.get_account(vt_accountid="CTP.189672",use_df=False)

get_position

• 入参：vt_positionid: str, use_df: bool = False

• 出参：PositionData

根据vt_positionid来查询持仓情况，返回对象包含接口名称、交易所、合约代码、数量、冻结数量等。

position = engine.get_position(vt_positionid='CTP.hc2305.SHFE.多')

注意，vt_positionid为vnpy内部对于一笔特定持仓的唯一持仓编号，格式为”gateway_name.vt_symbol.Direction.value”，其中持仓方向可选“多”、“空”和“净”，如下图所示：

多条查询¶

get_ticks

• 入参：vt_symbols: Sequence[str], use_df: bool = False

• 出参：Sequence[TickData]

查询多个合约最新tick。

ticks = engine.get_ticks(vt_symbols=['rb2209.SHFE','rb2210.SHFE'],use_df=True)

vt_symbols是列表格式，里面包含多个vt_symbol，如图。

get_orders

• 入参：vt_orderids: Sequence[str], use_df: bool = False

• 出参：Sequence[OrderData]

根据查询多个vt_orderid查询其详细信息。vt_orderids为列表，里面包含多个vt_orderid。

orders = engine.get_orders([orderid_one,orderid_two],use_df=True)

get_trades

• 入参：vt_orderid: str, use_df: bool = False

• 出参：Sequence[TradeData]

根据给定的一个vt_orderid返回这次报单过程中的所有TradeData对象。vt_orderid是本地委托号，每一个委托OrderData，由于部分成交关系，可以对应多笔成交TradeData。

trades = engine.get_trades(vt_orderid=your_vt_orderid,use_df=True)

get_bars

• 入参：vt_symbol: str, start_date: str, interval: Interval, use_df: bool = False

• 出参：Sequence[BarData]

通过配置的数据服务查询历史数据。

bars = engine.get_bars(vt_symbol="rb2210.SHFE",start_date="20211201",
                        interval=Interval.MINUTE,use_df=False)

其中：

• vt_symbol：本地合约代码，格式为合约代码 + 交易所名称；

• start_date：起始日期，格式为”%Y%m%d”；

• interval：K线周期，包括：分钟、小时、日、周；

• bars：包含了一系列BarData数据的列表对象，其BarData的定义如下：

@dataclass
class BarData(BaseData):

    symbol: str
    exchange: Exchange
    datetime: datetime

    interval: Interval = None
    volume: float = 0
    turnover: float = 0
    open_interest: float = 0
    open_price: float = 0
    high_price: float = 0
    low_price: float = 0
    close_price: float = 0

    def __post_init__(self):
        self.vt_symbol = f"{self.symbol}.{self.exchange.value}"

全量查询¶

在全量查询中，唯一参数是use_df，默认为False。返回的是一个包含相应数据的List对象，例如ContractData、AccountData和PositionData。

get_all_contracts

• 入参：use_df: bool = False

• 出参：Sequence[ContractData]

默认返回一个list，包含了全市场的ContractData，如果use_df=True则返回相应的DataFrame。

get_all_active_orders

• 入参：use_df: bool = False

• 出参：Sequence[OrderData]

活动委托指的是等待委托完全成交，故其状态包含“已提交、未成交、部分成交”；函数将返回包含一系列OrderData的列表对象。

get_all_accounts

• 入参：use_df: bool = False

• 出参：Sequence[AccountData]

默认返回包含AccountData的列表对象。

get_all_positions

• 入参：use_df: bool = False

• 出参：Sequence[PositionData]

默认返回包含PositionData的列表对象，如下图所示：