Разработка робота на Python

Для того чтобы упростить разработку алгоритмов на Python предлагается вместо Python SDK использовать py_algo приложение. py_algo представляет собой Python runtime со встроеными методами и классами, используемыми для разработки торговых алгоритмов. Весь функционал написан на С и при этом доступен из Python кода алгоритма в виде Python классов и методов. При этом, задержка обработки котировки и выставления заявки (tick-to-trade) которую вносит py_algo приложение составляет в среднем 60 микросекунд. Приложение представляет собой консольную утилиту которая инициализирует Python runtime и запускает код алгоритма:

Для того, чтобы запустить алгоритм (например реализованный в файле algo.py) достаточно выполнить команду:

  bin/py_algo -s algo1 -p algo.py

при этом algo1 это название сконфигурированной ноды (см. Добавление ноды). Помимо ручного запуска алгоритма, есть возможность автоматического запуска алгоритма как сервис.

Справочное руководство Python Algo

Перечисления

class xroad.TimeInForce(IntEnum) - время жизни заявки

• day = 48 - заявка валидна в течении дня
• GTC = 49 - заявка валидна по ее не отмнят
• open = 50 - заявка валидна только в течении сессии открытия
• IOC = 51 - заявка исполняется немедленно (частично или полностью) или отклоняется.
• FOK = 52 - заявка исполняется немедленно полностью или снимается
• GTD = 54 - заявка валидна до определенной даты
• close = 55 - заявка валидна в течении сессии закрытия

class OrderFlag(IntEnum) - конфигруционные настройки заявки

• as_mmaker = 1 - заявка подается от лица официального маркер мейкера
• otc = 8192 - OTC заявка

class OrderEvent(IntEnum) - события времени жизни заявки

• activated = 1 - заявка активирована на бирже
• canceled = 2 - заявка снята
• trade = 3 - заявка исполнилась полностью или частично
• rejected = 4 - заявка была отклонена биржей
• cancel_rejected = 5 - операция отмены заявки была отклонена биржей
• replaced = 6 - операция изменения параметров завяки была успешно обработана биржей
• replace_rejected = 7 - операция изменения параметров заявки была отклонена биржей

class AssetEvent(IntEnum) - события возникающие у объекта типа Asset

• pos_changed = 1 - событие об изменении позиции (в случае купли или продажи)
• error = 2 - возникло ошибочние событие (например заявка была отклонена биржей)
• info = 3 - информационное событие (например, заявка исполнилась)

class EnvEvent(IntEnum) - события уровня приложения

• reconfig = 1 - конфигурация изменилась
• start = 2 - приложение получило start событие
• stop = 3 - приложение получило stop событие
• msg = 4 - приложение получило сообщение от другого приложения
• prop_changed = 5 - приложение получило сообщение об изменении свойства
• prop_row_added = 6 - приложение получило сообщение об добавлении новой строки в таблице
• prop_row_deleted = 7 - приложение получило сообщение об удалении строки из таблицы

class TradingStatus(IntEnum) - торговый интервал инструмента

• regular_trading = 1 - торгуется в основную торговую сессию
• opening_period = 2 - торгуется в пред-торгорвый период
• closing_period = 3 - торгуется в период закрытия
• opening_auction = 4 - торгуется в аукцион открытия
• closing_auction = 5 - торгуется в аукцион закрытия
• auction = 6 - торгуется в аукцион
• auction_price_trading = 7 - период определения цены аукциона
• halt = 8 - инструмент не торгуется
• stopped = 9 - торги остановлены
• auction_closing = 10 - торгуется в аукцион зактрытия
• unknown = 11 - неопределенный торговый интервал

class MdataFeedStatus(IntEnum) - статус фида данных

• offline = 0 - фид данных не работает
• online = 1 - фид данных работает
• unknown = 2 - неизвестный статус

class OrderState(IntEnum) - статус заявки

• initial = 0 - начальный статус заявки
• active = 1 - заявка активна
• destroyed = 2 - заявка удалена
• canceled = 3 - заявка отменена
• rejected = 4 - заявка отклонена
• filled = 5 - заявка полнстью исполнена
• expired = 6 - срок действия заявки истек
• awaiting_active = 7 - заявка ожидает актитвации
• awaiting_destroy = 9 - заявка ожидает удаления
• awaiting_cancel = 9 - заявка ожидает отменв
• awaiting_replace = 10 - заявка ожидает изменения

class OrderType(IntEnum) - тип заявки

• limit = 49 - лимитная
• market = 50 - рыночная

class PropType(IntEnum) - тип свойсва

• string = 1 - свойство имеет строковый тип
• boolean = 2 - свойство имеет булевый тип
• integer = 3 - свойство имеет integer тип
• double = 4 - свойство имеет double тип
• time = 5 - свойство имеет time тип
• table = 6 - свойство имеет table тип
• date = 7 - свойство имеет date тип

Глобальные функции

set_env_event(callback:fn) - устанавливает функцию, которая будет вызываться в случае возникновения события уровня приложения (см. EnvEvent)

• Параметры

  • callback - функция типа function(EnvEvent, dict)

  Пример:

  def env_events(event, data):
      if event == EnvEvent.reconfig:
          # reload config
          print(get_config())
     elif event == EnvEvent.start:
          # e.g. start algo
     elif event == EnvEvent.stop:
          # e.g. stop algo
     elif event == EnvEvent.msg:
          print(data)
     elif event == EnvEvent.prop:
          # property changed. data is dict {"name": "prop_name", "value": "prop_value"}
   
   
  set_env_event(env_events)

send_msg(name: str|int, data::dict) - посылает сообщение другой ноде системы

• Параметры:

  • name - имя ноды или ее id
  • data - отправляемые данные

  Пример:

  send_msg(node="algo2", data={"parameter1": 10, "parameter2": "some usefull info"})

md_hbt_start() - в случае, если алгоритм является источником данных он должден посылать хардбит

md_hbt_stop() - наоборот выключает хардбит

start() - переводит ноду в состояние active

stop() - переводит ноду в состояние inactive и снимает все активные заявки. Новые заявки посылаться не будут

Классы

class Asset(object) - определяет операции уровня инструмента

• Конструктор:

  • Asset(name::String[, event::fn(Asset, AssetEvent, dict)]) - создает объект типа Asset
    • Параметры:
      • name - имя инструмента
      • event - необязательная вызываемая функция для обработки событий типа AssetEvent
    • Возвращаемое значение:
      • объект типа Asset или генерируется исключение, в случае если инструмент с таким именем не найден

  Пример:

  import logging
  from xroad import *
   
  logger = logging.getLogger()
   
  a1 = Asset(name="LKOH.TQBR")
   
  def asset_event(event, data):
     if event == AssetEvent.pos_changed:
        print(data)
   
  a2 = Asset(name="SBER.TQBR", event=asset_event)

• Методы:

  • md_quote(event::fn(quote::Quote)[, snapshot::Boolean]) -> MdQuote|None - создает подписку на квоту
    • Параметры:
      • event - вызываемая функция типа fn(Quote)
      • snapshot - необязательный параметр, который определяет нужно ли получить снепшот данных в начале
    • Возвращаемое значение:
      • объект типа Quote

  Пример:

  import logging
  from xroad import *
   
  logger = logging.getLogger()
   
  a = Asset("LKOH.TQBR")
   
  def on_quote(quote):
     logging.info("asset = {}, quote = {}".format(quote.asset.name, quote.data))
   
  a.md_quote(event=on_quote)

  • md_trade(event::fn(trade::Trade)[, snapshot::Boolean]) -> MdTrade|None - создает подписку на сделку
    • Параметры:
      • event - вызываемая функция типа fn(Trade)
      • snapshot - необязательный параметр, который определяет нужно ли получить снепшот данных в начале
    • Возвращаемое значение:
      • объект типа Quote

  Пример:

  import logging
  from xroad import *
   
  logger = logging.getLogger()
   
  a = Asset("LKOH.TQBR")
   
  def on_trade(trade):
     logging.info("asset = {}, trade = {}".format(trade.asset.name, trade.data))
   
  t = a.md_trade(event=on_trade)

  • md_info(event::fn(Info)[, snapshot::Boolean]) -> MdInfo|None - подписывается на различную статистику по инструменту (например: OI, цена последней сделки, и т.д.)
    • Параметры:
      • event - вызываемая функция типа fn(Info)
      • snapshot - необязательный параметр, который определяет нужно ли получить снепшот данных в начале
  • md_book(event::fn(Book), snapshot::Boolean) -> MdBook|None - subscribe to asset book
    • Параметры:
      • event - вызываемая функция типа fn(Info)
      • snapshot - необязательный параметр, который определяет нужно ли получить снепшот данных в начале

  Пример:

  import logging
  from xroad import *
   
  logger = logging.getLogger()
   
  a = Asset("LKOH.TQBR")
   
  def on_book(book):
     logging.info("asset = {}, book = {}".format(book.asset.name, book.data))
   
  b = a.md_book(event=on_book)

  • md_indicator(event::fn(Indicator), snapshot::Boolean) -> MdIndicator|None - подписывается на индикатор
    • Параметры:
      • event - вызываемая функция типа fn(Indicator)
      • snapshot - необязательный параметр, который определяет нужно ли получить снепшот данных в начале
  • md_feed_status(event::fn(FeedStatus), snapshot::Boolean) -> MdFeedStatus|None - подписывается на статус фида
    • Параметры:
      • event - вызываемая функция типа fn(FeedStatus)
      • snapshot - необязательный параметр, который определяет нужно ли получить снепшот данных в начале
  • md_stop() -> True - удалает все подписки
  • cancel() -> True - отменяет все активные заявки
  • buy([account:str, client_code:str, qty:float, price:float, tif::TimeInForce, trader_book::str, flags::int, event::fn(OrderEvent, dict), till_date:datetime, send::bool], till_date:datetime.date, send:bool, type:OrderType, comment:str, collect_trades:bool) -> Order - создает заявку на покупку
    • Параметры:
      • account - счет клиента
      • client_code - код клиента
      • qty - необязательная кол-во заявки в штуках или лотах
      • price - необязательная цена завяки
      • tif - см. TimeInForce
      • trader_book - книга трейдера
      • flags - необязательные настройки заявки
      • event - необязательная вызываемая функция для полного контроля поведения завяки
      • till_data - дата жизни заявки (используется в том случае, если tif = TimeInForce.GTD)
      • send - необязательный параметр. По умолчанию заявка посылается на биржу в момент создания. Этот параметр позволяет выключить данное поведение
      • comment - комментарий в заявке
      • collect_trades - позволяет сохранять сделки в объекте Order, чтобы впоследствии их просмативать итератором
    • Возвращаемое значение:
      • объект типа Order
      • исключение

  Пример:

  import logging
  from xroad import *
   
  cfg = {"account": "acc1", "client_code": "ccode1", "tif": TimeInForce.day}
   
  logger = logging.getLogger()
   
  a = Asset("LKOH.TQBR")
   
  b = a.buy(qty=1, price=256.12, **cfg);

  • sell([account:str, client_code:str, qty:float, price:float, tif::TimeInForce, trader_book::str, flags::int, event::fn(OrderEvent, dict), till_date:datetime, send::bool], till_date:datetime.date, send:bool, type:OrderType, comment:str, collect_trades:bool) -> Order - создает заявку на покупку
    • Параметры:
      • см. Asset.buy
  • orders() ->OrderIter - создает итератор для получения списка ордеров
    • Параметры:
      • event - вызываемая функция типа fn(Trade)
      • snapshot - необязательный параметр, который определяет нужно ли получить снепшот данных в начале
    • Возвращаемое значение:
      • объект типа Quote
• Свойства:
  • name->String - имя инструмента
  • total_buy->Float - сколько всего куплено
  • avg_buy->Float - средневзвешенная цена покупки
  • total_sell->Float - сколько всего продано
  • avg_sell->Float - средневзвешенная цена продажи
  • md_stat->MdStat - возвращает статистику по инcтрументу(см. MdStat)
  • trading_status->TradingStatus - статус инструмента
  • ref->dict - возвращает спецификацию инструмента (lot_size, price precision, expiration date, etc)

class MdBook(object) - возвращаемое значение подписки на книги (см. Asset.md_book)

• Свойства:
  • asset::Asset - ссылка на py_algo_Asset
  • data::dict - последние биржевые данные

class MdInfo(object) - возвращаемое значение подписки на информацию по инструменту(см. Asset.md_info)

• Свойства:
  • asset::Asset - ссылка на py_algo_Asset
  • data::dict - последние биржевые данные

class MdQuote(object) - возвращаемое значение подписки на квоты (см. Asset.md_quote)

• Свойства:
  • asset::Asset - ссылка на py_algo_Asset
  • data::dict - последние биржевые данные

class MdTrade(object) - возвращаемое значение подписки на сделки (см. Asset.md_trade)

• Свойства:
  • asset::Asset - ссылка на py_algo_Asset
  • data::dict - последние биржевые данные

class MdStat - возвращаемое значение вызова Asset.md_stat

• Свойства:
  • asset::Asset - ссылка на py_algo_Asset
  • settle_date->datetime:date - дата поставки
  • last->dict - последняя сделка
  • quote->dict - последняя квота
  • open_price->dict - цена открытия
  • close_price->dict - цена закрытия
  • oi->dict - open interest
  • volume->dict - торговый объем
  • vwap->dict - VWAP price
  • min_price->dict - минимально допустимая цена
  • max_price->dict - максимально допустимая цена
  • low->dict - минимальная цена сделки
  • high->dict - максимальная цена сделки
  • wa_price->dict - средняя цена

class Order - возвращаемое значение вызова Asset.buy или Asset.sell)

• Методы:
  • cancel() - снять завяку
    • Возвращаемое значение:
      • True
  • replace(qty::float, price:float) - изменить заявку
    • Параметры:
      • qty - новое кол-во заяки
      • price - новая цена заявки
  • reset() - сбрасывает накопленную статистику
  • **trades()->TradeIter - возвращает итератор на сделки завяки
• Свойства:
  • asset->Asset - ссылка на py_algo_Asset
  • name->str -** возвращает имя заявки, генерируемое при ее создании
  • active->bool - проверяет активна завяка или нет
  • side->str - сторона заявки: "B" - заявка на покупку, "S" - заявка на продажу
  • price->float - цена заявки, если она есть
  • avg_price->float - средневзвешенная цена исполнения
  • qty->float - кол-во заявки в штуках или лотах
  • filled_qty->float - исполненное кол-во заявки в штуках или лотах
  • state->OrderState - статус заявки py_algo_OrderState
  • type->OrderType - тип ордера py_algo_OrderType
  • exch_id->str - ID ордера на бирже
  • exch_ts->datetime.datetime -> время активации на биржк

class Timer - имплементация системного таймера

• Конструктор:
  • Timer(name::str, event::fn()) - создает объект типа Timer
    • Параметры:
      • name - имя таймера
      • event - вызываемая по таймеру функция

• Методы:

  • start(start::Integer|datetime.time, repeat=0) - запускает таймер
    • Параметры:
      • start - или абсолютное время запуска таймера (задается datetime.time) или относительное, задаваемое в микросекундах
      • repeat - необязательное время периодического срабатывания таймера в микросекундах
    • Возвращаемое значение:
      • None
  • stop() - останавливает таймер

  Пример:

  import logging
  import datetime
  from xroad import *
   
  logger = logging.getLogger()
   
  def call_me():
     print("timer fired")
   
  t = Timer(call_me)
   
  t.start(start=1000000, repeat=1000000) # таймер запускается через однy секунду и будет вызываться каждую
                                           # следующую секунду
  t.stop() # останавливаем таймер
  t.start(start=datetime.time(hour=13, minute=20, second=0) # таймер запустится в 13:20:00

Примеры алгоритмов

Этот алгоритм использует котирует один инструмент (order_assset) при изменении цены на другой (quite_asset):

Конфигурация:

<?xml version="1.0"?>
<config>
   <node
      log_level="debug"
   />
   <mdata_engine>
      <server address="shm://${NODE_NAME}_md:15000000" />
   </mdata_engine>
   <ui>
      <form>
         <textbox name="fo_account"   type="string" />
         <textbox name="spread"       type="integer" value="10" />
         <textbox name="book_size"    type="integer" value="100" />
         <textbox name="max_fill_qty" type="integer" value="10000" />
         <textbox name="fut_instr"    type="string"  value="Si-9.22" />
         <textbox name="spot_instr"   type="string"  value="SBER.TQBR" />
         <textbox name="offset"       type="integer" value="0" />
         <textbox name="bid_price"    type="double"  />
         <textbox name="ask_price"    type="double"  />
      </form>
   </ui>
</config>

Реализация в процедурном стиле:

from xroad import Props, Asset, OrderEvent, EnvEvent, set_env_event, stop
 
props = Props()
 
spread = props["spread"].value
book_size = props["book_size"].value
max_fill_qty = props["max_fill_qty"].value
config = {"account": props["fo_account"].value, "collect_trades": True}
fut_instr = props["fut_instr"].value
spot_instr = props["spot_instr"].value
offset = props["offset"].value
 
def on_env_event(event, data):
    if event == EnvEvent.prop:
        if data["name"] == "spread":
            global spread
            spread = data["value"]
            print("spread changed  to {}".format(spread))
 
set_env_event(event=on_env_event)
 
fut = Asset(fut_instr)
spot = xroad.Asset(spot_instr)
 
def on_order_event(order, event, data):
    print("order_name = {} state = {} event = {} data = {}".format(order.name, str(order.state), str(event), data))
    if event == OrderEvent.replaced:
        print("order {} replaced. qty = {} price = {}".format(order.name, order.qty, order.price))
    elif event == OrderEvent.trade:
        print("order {} trade. qty = {} price = {}".format(order.name, order.qty, order.price))
        qty = book_size/2
        order.replace(qty = qty)
        for i, t in enumerate(order.trades(), start=1):
            print("{} {}".format(i, t))
    elif event == OrderEvent.rejected:
        stop()
    print("{} total_buy = {}, total_sell = {}".format(order.asset.name, order.asset.total_buy, order.asset.total_sell))
 
buy_order = fut.buy(**config, event = on_order_event)
sell_order = fut.sell(**config, event = on_order_event)
 
def on_quote(q):
    mid_price = (q.data["bid"]["price"] + q.data["ask"]["price"]) / 2 + offset
    print("---------------------------------------")
    print("mid_price = {}".format(mid_price))
    bid_price = int(mid_price * (1 - spread / 20000))
    ask_price = int(mid_price * (1 + spread / 20000))
    print("bid_price = {}".format(bid_price))
    print("ask_price = {}".format(ask_price))
    props["bid_price"].value = bid_price
    props["ask_price"].value = ask_price
    buy_order.replace(qty = book_size/2, price = bid_price)
    sell_order.replace(qty = book_size/2, price = ask_price)
 
spot.md_quote(event = on_quote)

тот же самый алгоритм, только написаный с использованием классов:

from xroad import Props, Asset, OrderEvent, EnvEvent, set_env_event, stop
 
class Robot(object):
 
    def __init__(self):
        self._props  = Props()
        self._spread = self._props["spread"].value
        self._book_size = self._props["book_size"].value
        self._max_fill_qty = self._props["max_fill_qty"].value
        self._config = {"account": self._props["fo_account"].value, "collect_trades": True}
        self._offset = self._props["offset"].value
        set_env_event(event=lambda event, data: self.on_env_event(event, data))
        self._fut = Asset(self._props["fut_instr"].value)
        self._spot = Asset(self._props["spot_instr"].value)
        self._buy_order = self._fut.buy(**self._config, event = lambda order, event, data: self.on_order_event(order, event, data))
        self._sell_order = self._fut.sell(**self._config, event = lambda order, event, data: self.on_order_event(order, event, data))
        self._spot.md_quote(event = lambda q: self.on_quote(q))
 
    def on_env_event(self, event, data):
        if event == EnvEvent.prop:
            if data["name"] == "spread":
                self._spread = data["value"]
                print("spread changed  to {}".format(self._spread))
 
 
    def on_order_event(self, order, event, data):
        print("order_name = {} state = {} event = {} data = {}".format(order.name, str(order.state), str(event), data))
        if event == OrderEvent.replaced:
            print("order {} replaced. qty = {} price = {}".format(order.name, order.qty, order.price))
        elif event == OrderEvent.trade:
            print("order {} trade. qty = {} price = {}".format(order.name, order.qty, order.price))
            qty = self._book_size/2
            order.replace(qty = qty)
            for i, t in enumerate(order.trades(), start=1):
                print("{} {}".format(i, t))
        elif event == OrderEvent.rejected:
            stop()
        print("{} total_buy = {}, total_sell = {}".format(order.asset.name, order.asset.total_buy, order.asset.total_sell))
 
    def on_quote(self, q):
        mid_price = (q.data["bid"]["price"] + q.data["ask"]["price"]) / 2 + self._offset
        print("---------------------------------------")
        print("mid_price = {}".format(mid_price))
        bid_price = int(mid_price * (1 - self._spread / 20000))
        ask_price = int(mid_price * (1 + self._spread / 20000))
        print("bid_price = {}".format(bid_price))
        print("ask_price = {}".format(ask_price))
        self._props["bid_price"].value = bid_price
        self._props["ask_price"].value = ask_price
        self._buy_order.replace(qty = self._book_size/2, price = bid_price)
        self._sell_order.replace(qty = self._book_size/2, price = ask_price)
 
 
robot = Robot()