Документация

Документация робота WhiteBox™

Содержание

Документация пока еще пишется.

 

  • Первый запуск — для тех кто впервые
  • Триал-версия — возможно бесплатно опробовать робота
  • Требования — минимальные системные требования к ПК
  • Безопасность — чтобы никто не смог Вас обокрасть
  • Настройки — про окно настроек робота
  • Интерфейс — про главное окно робота
  • Лот — как регулировать сумму и плечо
  • Режимы — какие есть и зачем нужны
  • Диверсификация — как увеличить прибыль и не слиться
  • Контроллер — чтобы зависания/сбои не стали проблемой
  • Отчёт — покажет результаты торговли
  • Telegram — настроить оповещения о сделках
  • Ошибки — какие бывают и что значат
  • Спам — почему биржи блокируют за спам

Первый запуск

Здесь очень краткая пошаговая инструкция для тех кто запускает робота WhiteBox в первый раз. Описано далеко не всё, здесь лишь необходимый минимум.

Портативный

Робот не требует установки, его можно переносить с компьютера на компьютер со всеми настройками. Так задумано для удобства в первую очередь.

Для биржи BitMEX.com

Другие биржи пока не поддерживает, но будут добавлены в будущем. Для запуска у Вас должен быть аккаунт на бирже BitMEX.com и хотя бы минимальное количество средств на счёте (даже 1 доллара может хватить для тестирования).

Создание API-ключа

Робот никак не сможет работать без API-ключей. Биржи API-ключи для того и сделали, чтобы различные программы (например, роботы) могли подключаться к биржевому аккаунту и управлять торговлей.

Пример приводится на русскоязычном интерфейсе сайта. Язык можно сменить нажав на флаг наверху страницы.

  • Шаг 1. Войдите в личный кабинет на BitMEX.com
  • Шаг 2. Нажмите «Аккаунт»
  • Шаг 3. Нажмите «Ключи API»

Далее не обязательные шаги, их можно пропустить.

  • Шаг 4. Введите название API-ключа на английском в поле «Имя»
  • Шаг 5. Введите IP-адрес Вашего ПК для безопасности в поле «CIDR»

Если Вы не знаете свой IP-адрес, то просто введите в любом поисковике «Узнать мой IP-адрес». Имейте ввиду, что Ваш IP-адрес должен быть статическим (постоянным), но не динамическим (значит меняется). Если Вы не знаете статический у Вас IP-адрес или динамический, то Вы можете это узнать на сайте Вашего интернет-провайдера или же позвонить им в службу поддержки. Поле не обязательное.

Роботу обязательно нужно право «Ордер» (право создавать и отменять ордеры). Но НЕ нужно право вывода средств (не ставьте эту галку в целях безопасности).

  • Шаг 6. Поставьте право ордера
  • Шаг 7. Нажмите кнопку «Создать ключ API»

Внизу должны появиться 2 длинных кода API-ключа как на снимке экрана ниже, именно их нужно передать роботу. Он их сразу зашифрует.

Далее нужно запустить робота (если еще не запущен) и установить ему API-ключ от биржевого аккаунта.

  • Шаг 8. Запустите робота
  • Шаг 9. Нажмите кнопку «Settings» («Настройки»)

Переключим язык на русский. Если вставить коды API-ключа (нужно оба) то пока Вы не закроете окно ключи будут видны Вам, но после закрытия окна настроек ключи навсегда зашифруются, и больше их посмотреть будет нельзя. То есть если посторонний человек получит Вашу копию робота WhiteBox, то он не сможет посмотреть или скопировать Ваш API-ключ (поэтому можно спокойно держать копию робота на чужом сервере, например).

  • Шаг 10. Меняем язык в выпадающем списке
  • Шаг 11. Вставляем коды ключа

В нижнем левом углу есть кнопка «Проверка», нажмите. Если проверка сообщает о проблемах значит что-то неверно сделано.

  • Шаг 12. Нажмите кнопку «Проверка»
  • Шаг 13. Закройте окно настроек

Теперь можно настроить торговые параметры. Для этого есть файлы готовых настроек (пресеты). Эти файлы можно открывать простым текстовым редактором Windows («Блокнотом»), если Вам это будет зачем то нужно. Большая кнопка с коробкой это кнопка «Открыть файл». При этом сразу откроется нужная папка, менять папку не нужно.

  • Шаг 14. Нажмите большую кнопку с коробкой
  • Шаг 15. Выберете файл (например, «BitMEX (any)-USD.ini»)
  • Шаг 16. Выберете нужную Вам пару (например, XBTUSD)
  • Шаг 17. В левом верхнем углу нажмите кнопку «Запуск»

Если на бирже появились 2 ордера на выбранной Вами паре, то Вы всё сделали правильно. Для проверки Вы можете на бирже отменить один ордер или оба, и тогда робот их выставит снова. Если робот снова выставил отмененный Вами ордер, то значит всё работает правильно.

Триал-версия и лицензии

Робот WhiteBox — это платный коммерческий продукт, но имеется так же триал-версия робота, нужная только для оценки работоспособности и результативности робота. Триал-версия распространяется только бесплатно.

 

Отличия версий

Триал-версия в отличии от полной версии с лицензией имеет большие ограничения. Ограничения могут меняться по ситуации (с предупреждением).

 

Триал-версия:

  • не может торговать если баланс на счёте превышает 0.01 BTC, и это не зависит от курса
  • может торговать только до конца месяца

 

Полная версия с лицензией:

  • может торговать с любым балансом
  • пожизненная лицензия, любой срок

 

Робот WhiteBox никак не зависит от наших серверов или сайтов, и робот будет полностью работоспособным в случае если мы всё отключим по любым причинам. Так владелец лицензии, скачавший робота, является полностью независимым от нас, но может получать полезные обновления робота и/или консультации-поддержку если пожелает. Обновлять робота НЕ обязательно. Более того, старые версии робота всё равно можно сохранить себе на ПК если хочется.

 

Как получить лицензию

Процесс покупки и получения лицензии зависит от дистрибьютора. Цена так же зависит от него. Все дистрибьюторы перечислены на странице Купить. Если Вашего продавца нет в списке на этой странице, то возможно Вас пытаются обмануть — свяжитесь с нами для уточнения перед покупкой.

 

Как проверить лицензию

Самый простой способ узнать выделена ли для Вас лицензия — это поискать свой номер биржевого счёта на странице Список покупателей. Если Вы покупали лицензию, но не находите себя в этом списке — пожалуйста, свяжитесь с нами.

 

Как скачать

Чтобы получить робота с лицензией Вам нужно скачать тот же файл робота, что и все. При подключении к бирже робот определит имеется лицензия у Вашего биржевого счёта. Если нет — тогда запустится как триал-версия, с ограничениями. Если лицензия есть — то запустится как полная версия, без ограничений. Лицензия всегда привязывается именно к номеру биржевого счёта (аккаунта), а не к ключу API или железу ПК. Следовательно, использовать робота с лицензией можно на любом ПК c Windows. Так же можно удалять ключ API на сайте биржи если это Вам зачем то понадобится, и создавать новые ключи API.

Минимальные системные требования к ПК

Есть версия только для Windows, версий для других ОС нет и не планируется. Разумнее всего использовать робота на арендованном виртуальном сервере (VPS, не VDS — стоят от $2 в месяц), а не на домашнем ПК. При этом для эксперимента пробовать на домашнем ПК вполне рационально. Из-за того что робота желательно держать на сервере мы решили что версий для других ОС делать не имеет смысла.

 

  • Windows 7 и старше (либо Windows Server 2008 и старше)
  • Разрешение экрана от 1024×600 (адаптирован)
  • Надёжное соединение с Интернетом ЛЮБОЙ скорости
  • От 512 Mb оперативной памяти (желательно 1 Gb и более)
  • От 500 Mb дискового пространства
  • Любой процессор CPU, любая видеокарта GPU

 

Робот сможет нормально работать на самом дешевом нетбуке из магазина, если там Windows 7 или старше. На ОС Andriod робот работать не будет!

На ПК с работающим роботом можно комфортно запускать требовательные компьютерные игры, это не будет мешать.

Меры безопасности

Если Вы предпримете все нижеперечисленные меры безопасности, то обокрасть Вас никто не сможет, и мы тоже (если бы пожелали).

  • Не давайте ключи. Никому не передавайте Ваши ключи API или пару логин/пароль от биржевого аккаунта, даже если попросим мы (злоумышленники умеют выдавать себя за других, в том числе благодаря взлому аккаунта нужного человека).
  • Не разрешайте вывод. Не давайте API ключу право вывода денежных средств с Вашего биржевого аккаунта. Роботу это право совершенно не нужно для работы.
  • Двух-факторная верификация. Используйте её если Ваша биржа имеет такую функцию.
  • Белый список IP-адресов. У многих криптовалютных бирж есть функция создания «белого списка» IP-адресов (например у BitMEX.com это называется CIDR). Это значит что подключиться по ключу API к Вашему аккаунту получится только с IP-адреса из Вашего списка (там обычно один адрес делают). Кроме того, злоумышленник даже если как-то смог получить Ваш API-ключ, то IP-адрес ему просто не известен.
  • Используйте антивирус. Каждый раз скачивая новую версию робота (обновление) используйте антивирусную программу. Если на Вашем ПК нет антивируса, то воспользуйтесь онлайн-антивирусами — это просто, быстро и бесплатно.
  • Используйте FireWall. Вы можете запретить роботу делать любые подключения, кроме подключения к бирже, через запрет в VPN или программами типа FireWall. Эта мера гарантирует Вам что робот не будет отправлять Ваши API-ключи куда не следует. То есть это защита скорее от нас. А что? Уверенность — приятное чувство, оно не лишнее.
  • Проконсультируйтесь. Если здесь Вам что-то не совсем понятно и Вы сомневаетесь в полной безопасности предложенной схемы работы, то Вы можете проконсультироваться со специалистами (системный администратор вполне подойдет). Покажите специалисту эту страницу, и разобравшись он подтвердит что при такой схеме работы, приняв все меры безопасности, украсть Ваши средства становится уже технически невозможно.

Настройки

Далее всё на примере русскоязычного интерфейса. В окне настроек имеется панель «Интерфейс».

  • Тип лота — в чём будет измеряться размер лота, в процентах от депозита, или в валюте пары.
  • Цены — как будут отображаться цены в интерфейсе, в биткойнах (типа 0,00004000) или в Сатоши (типа 4000).
  • Слайдер — какое количество делений будет у слайдера при торговле.
  • Автозапуск торговли — если галка стоит, то при запуске робота сразу же запускается торговля с последним выбранным файлом пресета, что полезно для автостарта вместе с Windows или при использовании рестартера (о нём позже).

Остальные настройки интуитивно-понятны и не нуждаются в объяснении.

Интерфейс

Верхние кнопки и галки

  • Запуск — запускает торговлю (заменяется на кнопку «Стоп»)
  • Стоп — останавливает торговлю
  • Стратегия / Пара — переключает интерфейс на выбор стратегии / пары
  • Таблицы — включает/отключает таблицы справа в интерфейсе
  • Поверх — интерфейс будет поверх всех окон
  • Звук — включает/отключает звуковые оповещения

Пресеты

Слева панели отображается полный путь к текущему выбранному файлу готовых настроек (пресету). Файл-пресет можно открывать текстовым редактором Windows («Блокнотом»).

  • Большая кнопка с коробкой — открыть файл-пресет
  • Запись — записать измененные настройки стратегии в выбранный файл
  • Копия — создать отдельную копию файла-пресета

Инструмент

Какую пару и на какой бирже будет торговать? Лучше выбирать по порядку сверху вниз. То есть сначала биржу, потом валюту, потом пару. Все валюты и пары автоматически сортируются в алфавитном порядке для удобства. Все пары и валюты автоматически подгружаются с биржи. То есть новые пары, которые биржа добавит в будущем робот сможет видеть и нормально с ними работать без специальных обновлений.

Параметр «Цены» устанавливается автоматически в момент выбора пары, и означает количество знаков после запятой. Вручную его менять не нужно. Это сделано на случай если биржа изменит количество знаков после запятой у пары (это вряд ли будет, но такое возможно). Если биржа изменит количество знаков после запятой, то придется устанавливать его вручную.

Стратегия

Панель стратегии появляется если нажать верхнюю кнопку «Стратегия». Запускать торговлю можно и без стратегии — для торговли вручную, что удобно для получения премии мейкера и борьбы с загруженностью биржи.

  • Галки лонг/шорт — разрешаем ли лонг и шорт.
  • Страт. — торговая стратегия по которой будет торговать.
  • Корр. — корректор для вмешательства в торговлю вручную. Как он будет выглядеть: как слайдер (ползунок), или как поле ввода. Корректор отображается в верхнем левом углу интерфейса после запуска торговли.
  • ТФ — таймфрейм.

Торговля

Лот измеряется либо в процентах от депозита, либо в количестве валюты, смотря что Вы выбрали в настройках робота (кнопка «Настройки» > панель «Интерфейс» > «Тип лота»). По умолчанию в процентах. Тогда 100 означает торговлю на 100% от депозита (плечо 1 к 1). Чтобы торговать с плечом 3 к 1 нужно соответственно выставить лот 300.

Пирамидинг не используется в стратегии ShiftMA.

«Откр.» и «Закр.» — это режимы выставления ордера. Пока работает только лимитный режим.

Лот

Лот — это сумма, на которую робот будет создавать ордеры. Существует 3 варианта как может рассчитываться размер лота (суммы ордеров):

  • В процентах от текущего баланса
  • В биткойнах
  • В валюте выбранной пары

 

В процентах

Если в настройках робота выбран процентный тип лота, то тогда размер лота будет рассчитываться в зависимости от остатка баланса в биткойнах. Если у Вас счёт на 0,5 BTC, и процентный лот выбран 100%, значит Ваши ордеры будут по 0,5 BTC. Если лот 300%, то Ваши лоты уже по 1,5 BTC.

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

  • При запуске робота (включая запуск рестартером)
  • При изменении баланса на 5% или более в большую или меньшую сторону

 

Почему размер процентного лота не пересчитывается в режиме реального времени? Дело в том что на биржах в книге заявок (стаканах) существует очередь ордеров. И чем раньше Ваш ордер в очереди, тем более вероятно что Ваш ордер сработает при касании ценой. Место Вашего ордера в очереди ордеров определяется по времени: кто раньше создал ордер — тот и раньше в очереди. Таким образом, чем чаще пересчитывать размер лота, тем чаще роботу придется перевыставлять ордеры (потому что сумма ордера ведь меняется из-за изменения размера лота), и тем хуже будет Ваше место в очереди ордеров. А значит при касаниях ценой будут редкие срабатывания. Проще говоря: чем реже пересчитывается размер лота, тем лучше. Но слишком редкий пересчёт лота тоже был бы плохим вариантом. В данной схеме получается что если пользователь выбрал размер процентного лота 100%, то его реальный лот будет от 95% до 105%, а не ровно 100%. Если пользователь выбрал лот 200%, то реально будет от 190% до 210% (а не до 205%). Такая погрешность не значительна, но позволяет получить место в очереди ордеров получше, и более высокие шансы срабатывания Вашего ордера при касании ценой. Методом проб и ошибок остановились на варианте в 5% (пробовали 1% и 3% — так хуже). Если минимальное изменение размера лота для перерасчёта в 5%, то происходит этот перерасчёт не так уж часто, и место в очереди ордеров почти не теряется.

 

В количестве

Если выбран количественный тип лота, то тогда перерасчёта размера лота не происходит совсем. В параметр «Лот» записывается конкретное количество монет, которые робот должен покупать или продавать одним ордером. Количественный лот более прост для понимания. Так как перерасчёта размера лота не бывает у количественного лота, то потеря места в очереди ордеров никогда не происходит.

Режимы

У торговых систем ShiftMA и MultiMA имеется выбор режима торговли. Одна сторона или две стороны. При этом при запуске, казалось бы, разницы нет. Разница появляется когда открывается позиция. Если пользователь выбрал торговлю и длинными позициями (лонг) и короткими позициями (шорт), то при запуске появляются ордеры и на открытие длинной позиции (ордеры на покупку) и на открытие короткой позиции (ордеры на продажу).

В двухстороннем режиме после открытия любой позиции не отменяются противоположные ордеры, и создается ордер на закрытие позиции. Например: Вы купили монеты по 100 долларов, и появляется ордер на закрытие позиции (на продажу) по цене 105 долларов. При этом не отменяется ордер на открытие короткой позиции (тоже на продажу) по цене 110 долларов.

В одностороннем режиме после открытия любой позиции отменяются противоположные ордеры, и создаётся ордер на закрытие позиции. Например: купив монеты по 100 долларов отменяется ордер на открытие шорта по 110 долларов. До тех пор, пока не будет закрыт лонг.

Или проще говоря: в одностороннем режиме робот не пытается открыть лонг до тех пор пока не закрыл шорт, а в двухстороннем он пытается открыть и лонг и шорт одновременно, что повышает шансы открыть позицию (не упустить сделку). При этом, архитектуры самих бирж в принципе не позволяют одновременно открыть и лонг и шорт на одной паре, поэтому это не может привести к проблемам.

Зачем это надо? Каждый ордер на бирже занимает маржу. Цена ликвидации позиции расчитывается с учётом свободной маржи. Таким образом, чем меньше маржи занято ордерами, тем больше запаса маржи, тем дальше будет автоматически устанавливаться цена ликвидации позиции. То есть проще говоря, риск получить ликвидацию позиции («слив») в одностороннем режиме меньше, чем в двухстороннем. Однако, двухсторонний режим имеет свой плюс: если цена будет двигаться очень быстро, то в двухстороннем режиме робот успеет сразу после закрытия лонга открыть шорт, а в одностороннем режиме может и не успеть. Упущенная сделка так не станет убытком, но станет недополученной прибылью.

Какой режим выбрать? Зависит от размера лота (кредитного плеча). Если Ваш лот для ShiftMA 100% от баланса и менее (или лот для MultiMA 33% от баланса и менее) то рекомендуется двухсторонний режим. Если Ваш лот больше этих значений, то для снижения риска ликвидации рекомендуется односторонний режим.

Диверсификация

Имея всего одну лицензию Single на одном аккаунте биржи можно запускать до пяти роботов одновременно. Это может и снизить риски за счёт диверсификации рисков, и повысить прибыль за счет увеличения количества сделок. Условно-говоря, если запустить 3 робота на 1 аккаунт, то прибыль будет больше даже не в 3 раза, а в большее количество раз, из-за так называемой «магии сложного процента». Разумеется, при условии если Вы выбрали прибыльные настройки.

 

Ограничения

  • Запускайте не более 5 роботов на 1 биржевой аккаунт одновременно
  • У каждого робота должна быть своя пара (контракт) для торговли
  • У каждого робота должна быть своя папка, откуда он запускается
  • У каждого робота должен быть свой пресет-файл
  • Не меняйте название файла whitebox.exe

 

Можно и безопасно

  • Использовать один и тот же ключ API для всех роботов
  • Использовать один и тот ПК и IP-адрес для всех роботов

Биржа ведёт учёт лимита запросов по API в разрезе счёта (аккаунта), а не в разрезе ключей API или в разрезе IP-адресов. Поэтому создавать для каждого робота свой ключ API бессмысленно и ничего не даёт. Так же бессмысленно использовать несколько компьютеров (серверов) или несколько IP-адресов.

 

Как запустить несколько роботов

Инструкция по шагам:

  • Шаг 1: полностью настройте одного робота
  • Шаг 2: сохраните все настройки робота нажав кнопку «Запись»
  • Шаг 3: запустите торговлю, проверьте правильно ли он работает
  • Шаг 4: скопируйте всю папку с роботом в другое место (закрывать робота или останавливать торговлю — не обязательно)
  • Шаг 5: запустите робота из папки-копии, выберете другой пресет-файл (или создайте новый)
  • Шаг 6: выберете у копии другую торговую пару (контракт)
  • Шаг 7: измените настройки торговли, если считаете нужным
  • Шаг 8: запустите торговлю у второго робота, убедитесь что всё работает верно
  • Шаг 9: так же создайте еще копии, по той же схеме, если Вам нужно

 

Несколько счетов

Некоторые пользователи создают несколько биржевых счетов (аккаунтов), и в случае использования большого риска (большое кредитное плечо, например) это имеет смысл. Смысл в том, что если один из счетов будет полностью ликвидирован (в народе — «слив»), то большая часть средств остаётся на остальных счетах. Что во-первых, не так больно психологически, а во-вторых, еще не «конец игры». Ведь раз уж большая часть средств сохранена, то остаются большие шансы снова выйти в плюс уже в ближайшее время. Минус в том что каждый отдельный счёт требует отдельную лицензию. Выдавать покупателю по несколько лицензий по цене одной не получится, потому как нет возможности определить будет ли покупатель использовать все лицензии только для себя, или же поделится с другим человеком. Вот поэтому для каждого биржевого счёта (аккаунта) нужно покупать отдельную лицензию. Для торговли с умеренными рисками, где риск полной ликвидации счёта минимален вполне допустимо использовать только один биржевой счёт (и соответственно только одну лицензию Single).

Пассивность

В русскоязычном варианте интерфейса сайта биржи Bitmex.com эта пометка ордера называется «Пассивный», а в англоязычном «Post-Only». Находится это в левом верхнем углу интерфейса торгового терминала биржи. Чтобы не создавать лишнюю путаницу функция в роботе была названа так же — «Пассивное».

 

Пассивный ордер

Чем пассивный лимитный ордер отличается от обычного лимитного ордера? Всё просто — пассивному лимитному ордеру запрещено платить комиссию. Так пассивный лимитный ордер либо сработает без комиссии (а тогда обязательно получится премия мейкера ордера, см. «Комиссии»), либо не сработает вовсе. Из-за того что ордер может не сработать получается дополнительный риск, ведь если позиция будет убыточной, а робот всё никак не может закрыть её из-за того что пока нет возможности закрыть без комиссии, то убыток по этой позиции будет всё расти и расти. Есть и обратная сторона медали — если никогда не платить комиссию, и всегда получать премию мейкера ордера, то это вполне может перекрыть убыток, когда роботу долго не удавалось закрыть позицию.

 

Открытие и закрытие

Биржи не разделяют для чего создан ордер, для открытия позиция (или увеличения позиции) или для закрытия позиции (или уменьшения позиции). Но робот отличать может. Поэтому сделаны 2 разные галки: «Пассивное открытие» и «Пассивное закрытие». То есть можно запретить роботу платить комиссию за ордеры только при открытии позиции, или только при закрытии, или запретить в обоих случаях.

 

Рекомендуется

Рекомендуется ставить галку «Пассивное открытие», и не ставить галку «Пассивное закрытие». Исходя из следующих соображений:

  • Если из-за галки открыть позицию не удастся, то это значит что сделки просто не будет (а это не убыток)
  • Если из-за галки закрыть убыточную позицию не удастся и убыток продолжит расти, то это значит убыток станет больше

 

Проще говоря, в целях снижения риска «Пассивное закрытие» лучше не ставить. Однако, для очень маленьких «шифтов» (расстояние ордеров от SMA) «Пассивное закрытие» ставится более полезно. Можно сказать, чем меньше «шифты» тем больше пользы от «Пассивного закрытия».

Контроллер

Любая программа может содержать ошибки, «зависнуть», «вылететь с ошибкой» и так далее. Для торгового робота это особенно критично, ведь в случае если будет открыта убыточная позиция и не будет закрыта из-за сбоя, то можно получить большой убыток или потерять все деньги на счёте (ликвидация). Чтобы этой беды избежать сделана дополнительная программа «Контроллер». Она следит за правильностью работы торговых ботов (может отслеживать любое количество ботов одновременно), и в случае возникновения проблем с одним из ботов перезапускает его процесс.

 

Принцип действия

Программа контроллер автоматически находит все запущенные на ПК процессы поддерживаемых торговых роботов (eVe поддерживается), и раз в секунду проверяет их на наличие проблем и/или ошибок. Если какие-то проблемы у робота обнаружены, то его процесс закрывается и запускается заново. Это гарантированно решает проблему зависаний. Если торговый робот остановлен (торговля остановлена по кнопке «Стоп»), то контроллер не будет прерывать его процесс. Если проблем не обнаружено, то процессы роботов прерываться не будут.

Контроллер делает запрос к каждому обнаруженному на ПК процессу робота (они представлены в таблице главного окна). И если робот не отвечает на запрос, то считается «сбойным» и его процесс будет сразу перезапущен. Если ответ от робота поступил к контроллеру то замеряется время, за которое пришел ответ. Это значение называется «Лаг» и измеряется в секундах. Если лаг слишком большой, то такой робот тоже считается сбойным и тоже будет сразу перезапущен контроллером. Максимально допустимое значение лага определяется в настройках контроллера.

 

Автозапуск

Для правильной работы контроллера у всех запущенных на ПК роботов должна стоять галка «Автозапуск торговли». При этом галка «Запускать свёрнутым» не обязательна, но желательна (снижает нагрузку на ПК, актуально для арендованных бюджетных VPS-серверов).

 

Язык

Поддерживает английский и русский. Если в ОС включена поддержка русского языка, то при первом запуске автоматически установится русский язык интерфейса. В противном случае — английский. Язык можно сменить в настройках. Далее все примеры на русском варианте интерфейса.

 

Главное окно

Включен — зажимаемая кнопка. Если она подсвечена цветом, то контроллер включен и работает. Повторное нажатие отключает кнопку. По умолчанию сразу при запуске кнопка всегда включена, что позволяет добавлять контроллер в автозагрузку ОС. Нажата кнопка или нет не сохраняется при закрытии программы. Это значит при следующем запуске будет зажата всегда.

Настройки — открывает окно настроек (см.ниже).

Свернуть — стандартные кнопки ОС заменены, для того чтобы пользователь случайно не закрыл контроллер рефлекторно. Сворачивает окно программы.

Закрыть — закрывает программу. Контроль при этом прекращается!

 

Список роботов

Робот — колонка таблицы показывает название и версию робота.

Путь — колонка таблицы показывает полный путь к роботу.

Лаг — колонка таблицы показывает количество секунд, прошедших со времени последнего ответа от робота.

 

Настройки

Язык — английский или русский.

Пауза — пауза между перезапусками процессов роботов, в случае если нужно перезапустить более одного робота. Измеряется в секундах. Рекомендуемое значение 30 секунд — этого достаточно для самых бюджетных VPS-серверов.

Макс. лаг — максимальный разрешенный лаг для ответов от роботов. Измеряется в секундах. Минимальное значение 60 секунд, рекомендуемое 180 секунд (это 3 минуты, то есть «висеть» можно не более трёх минут).

Лог файл — вести или не вести отдельный лог-файл контроллера? (см.ниже)

Автозагрузка с ОС — запускать ли контроллер вместе с загрузкой операционной системы? (ярлык к программе добавляется в папку автозагрузки Windows)

 

Автозагрузка с ОС

Если Вы переместите папку контроллера или файл, или просто переименуете папку, то автозагрузка с ОС уже не сработает. Если Вам нужно переместить/переименовать папку контроллера, но хотелось бы сделать автозагрузку с ОС, то после перемещения нужно отменить автозагрузку, нажать кнопку «Оk», далее снова зайти в настройки и снова установить флажок «Автозагрузка с ОС». После этого очень рекомендуем один раз перезагрузить ПК, чтобы убедиться что автозагрузка работает.

 

Лог файл

Не обязателен для нормальной работы контроллера, и поэтому его можно отключить. Это обычный текстовой файл, который хранится в папке «log», внутри папки контроллера, и называется «controller.txt». Его можно открыть обычным текстовым редактором («блокнотом»). Файл содержит только время запуска контроллера и случаи рестарта робота, если они потребовались. При этом причины сбоя робота лог файл отображать не может, так как контроллер не сможет их установить. Поэтому лог файл лишь позволяет понять пригодился ли контроллер вообще или нет, были ли сбои у роботов. Пример содержания лог файла:

2020-02-28 12:25:26 Launch
2020-02-29 00:50:51 Restart C:\Bots\Bot3\WhiteBox.exe
2020-02-29 07:20:20 Restart C:\Bots\Bot2\WhiteBox.exe

Отчёт

Начиная с версии робота 0,917 в главном интерфейсе можно формировать отчёты о результатах торговли. В разрезах по дням и по парам. Отчёты могут выводиться в биткойнах или в сатоши, выбирается это в основных настройках робота. Данные в отчёте автоматически не обновляются (в целях экономии лимита запросов API и для снижения нагрузки на ПК). Чтобы обновить данные в отчёте нужно нажать на кнопку «Обновить». Без этого отчёты не обновляются.

Отчёт по дням, в отличии от данных в личном кабинете на сайте биржи, свёрнут по дате. То есть на каждую дату только одна строка, даже если в эту дату были сделки на нескольких парах. То есть отчёт суммирует результаты по всем парам за день. Остаток (или баланс) должен всегда совпадать с тем что Вы видите в личном кабинете на сайте биржи. Изменение счёта за день может быть положительным или отрицательным. Если за дату сделок не было, то эта дата не будет отображаться в отчёте.

Отчёт по парам выводит сумму всех результатов торговли за всё время существования счёта в разрезе пар. Таким образом, учитываются вообще все сделки на счёте за всё время, а не только сделки сделанные роботом. Например, можно узнать торговля по каким парам приносит прибыль, а по каким убыток — и исключить в будущем пары, на которых обычно получается убыток.

Так как отчёт обновляется только по нажатию кнопки, то он не расходует лимит запросов API. Отчёты можно обновлять и во время включенной торговли, и без включенной торговли. В отчёт не входят еще не закрытые позиции.

Telegram

Робот может отправлять сообщение в Telegram, если эта функция включена. Для начала её надо настроить. Находится это в окне настроек робота.

Чтобы Telegram-бот имел право отправлять Вам сообщения, его нужно сначала добавить — кнопка «Добавить бот». У каждого пользователя Telegram есть уникальный ID, чтобы его узнать нужен другой бот — кнопка «Узнать ID». Введите свой ID в настройки, поставьте галку «Включен» и нажмите кнопку «Тест». Тогда должно прийти сообщение. Если сообщение не пришло, то неверно сделано.

 

Блокировки

Сообщения отправляются через промежуточный сервер, и поэтому никакие блокировки здесь не мешают. То есть не нужно задумываться заблокирован ли Telegram в данном регионе, где запущен робот. Так же это не зависит совсем от ПК и операционной системы. То есть если робот вообще запустился, значит оповещения Telegram точно будут работать.

 

Формат

Формат сообщений в Telegram может меняться от версии к версии, учитываются пожелания пользователей.

Ошибки

 

Робот отображает ошибки в двух местах:

  • В главном окне на панели «API-ключ»
  • На вкладке «Лог», если переключить на «Ошибки»

На панели «API-ключи» отображается только количество ошибок API за всё время работы робота с последнего его запуска. При этом остановка торговли не обнуляет этот счётчик ошибок. Подробное описание ошибок можно посмотреть на вкладке «Лог» в логе ошибок. Текст ошибок составлен биржей, и он всегда на английском языке. Вариантов ошибок очень много, поэтому их можно сгруппировать по смыслу.

Ошибки временной потери связи:

  • 502 Bad Gateway
  • «Пустые ошибки» (без текста)

Они не опасны, при условии что таких ошибок не более 100 штук в час. Возникают они потому что Интернет-соединение не 100% стабильно у всех, и это нормально.

Ошибки перегруженности биржи:

  • System currently overloaded

Биржа «завалена» запросами от пользователей и временно (обычно несколько секунд) не может обслужить Ваш запрос от робота. Через несколько секунд запросы станут проходить.

SPAM-ошибки. Если размер Вашего ордера по сумме меньше чем 0,0025 BTC или эквивалент, то при большом количестве созданных таких ордеров биржа автоматически присваивает аккаунту (не API-ключу, а аккаунту, что значит удаление и создание новых ключей не решит проблему) пометку SPAM-аккаунт. То есть подозрение что Вы специально вредите работе биржи. При этом может быть выдан бан сроком на 1 час. Проблема возникает обычно со счетами менее $100.

Все тексты ошибок пишутся самой биржей, поэтому на английском языке, и сделать ошибки в логе ошибок на русском языке не получится.

Account has insufficient Available Balance

Означает что не хватает свободного баланса для создания ордера с такой суммой. Либо деньги заняты на другой паре (если Вы одновременно торгуете на другой паре), либо у Вас слишком большой размер лота для данной пары, и размер лота надо уменьшить.

Missing Signature

Потеряна подпись в запросе. Ошибка бывает в двух разных случаях.

Либо весьма редкий сбой, и никакой угрозы не представляет. Просто будет повторный запрос, который уже пройдет.

Либо, если таких ошибок много и их десятки каждую минуту — тогда Вы неправильно ввели ключ API.

Спам

Некоторые биржи, и bitmex.com в частности, имеют ряд ограничений и из-за нарушения их можно получить пометку «Спам» или даже временный бан для доступа по API (в этом случае зайти на сайт биржи получится, торговать вручную тоже, но робот не сможет работать с баном по API). Обращаю внимание: в случае любого бана биржи всё равно позволяют вывести все монеты.

Зачем это биржам? Злоумышленники могут (или пытаются) помешать работе биржи. Конкуренты или хакеры ради вымогательства денег. Помешать работе биржи можно если отправлять слишком много запросов, и тогда серверы биржи не справятся с нагрузкой и работа биржи будет приостановлена. Чтобы этого избежать биржи вводят различные ограничения. И к сожалению они не всегда достаточно хорошо описаны на сайте биржи.

К примеру, на bitmex.com запрещается создавать много ордеров на сумму менее 0,0025 BTC или эквивалент (по курсу $10.000 за 1 BTC это ограничение равняется $25). Однако, на практике при создании одного-двух таких ордеров ничего плохого не происходит, биржа не банит, пометку «Спам» Вашему аккаунту не включают. Проблема возникает когда таких ордеров становится слишком много. А сколько это ордеров — не описано.

Решение в том чтобы Ваш размер лота превышал 0,0025 BTC или эквивалент. Причем чем больше размер лота — тем менее вероятно получить пометку «Спам» или бан. Пометка «Спам» может быть установлена временно или навсегда (тоже не уточняется на сайте). Бан по API изначально выдаётся на 1 час, но при повторных нарушениях может быть дольше, в том числе на день, неделю и навсегда. Поэтому не надо воспринимать это как «не проблема», на второй раз будет хуже и опаснее. Ставьте достаточный размер лота, чтобы не получать пометку «Спам» никогда. Пометку «Спам» нужно воспринимать как первое предупреждение от биржи, и при повторных нарушениях их меры ужесточаются.

В русскоязычном варианте сайта bitmex.com написано следующее, цитата:

Счета, на которых открыто слишком много ордеров на сумму менее 0,0025 XBT каждый, будут помечены как спамовые.

Источник: https://www.bitmex.com/app/restAPI

К сожалению, документация (мануал) пока еще не готова и постепенно пишется. Ответ на Ваш вопрос может уже есть в FAQ, а если нет то можете задать в нашем Telegram-чате, где дружелюбное к новичкам комьюнити обычно подсказывают.