- PORT - Порт для доступа к web api
- WEB_AUTH_KEY - ваш ключ авторизации
Описание всех параметров смотрите в README_RU у бота.
Все параметры в методах перечислены в camelCase.
Важно:
- Если PORT не указан WEB API не будет запущен.
- Для каждого экземпляра бота используйте свой собственный порт.
- К каждому запросу необходимо в headers добавить параметр auth_key с указанием ключа авторизации WEB_AUTH_KEY.
- REST JSON формат
- Почти все методы GET возвращают в ответе JSON формат. Кроме методов /start и /stop.
- Все методы PUT, а так же /start и /stop возвращают только статус операции: 200 - ОК или 400 - Bad Request
| Type | Method | Description |
|---|---|---|
| GET | /handbook | Список каталогов |
| GET | /config | Список торговых параметров В этом методе перечислены параметры которые можно менять на ходу, без остановки бота |
| PUT | /config | Метод для установки параметров из get /config Можно отправлять как весь список, так и только измененные значения |
| GET | /settings | Список параметров для настройки бота В этом методе перечислены параметры которые необходимо задать до старта торгового бота |
| PUT | /settings | Метод для установки параметров из get /settings |
| GET | /pair | Список доступных торговых пар |
| GET | /balance | Информация о балансе full - Полный доступный баланс аккунта available - Баланс доступный боту для торгов после установки всех лимитов currency - торговая пара |
| GET | /orders | Список открытых ордеров |
| PUT | /close_orders | Закрыть ордера В body свойство type принимает значения "all", "reopen" или "grid" all - закрыть все ордера (бот встанет на паузу) grid - закрыть только сетку ордеров (бот встанет на паузу) reopen - переоткрыть ордера |
| POST | /closeOrders | Закрыть ордера В body свойство type принимает значения "all", "buy", "sell" all - закрыть все ордера buy - закрыть buy ордера sell - закрыть sell ордера Свойство reset - сбросить сетку ордеров (true/false) |
| POST | /closeOrder | Закрыть ордер по id В body свойство id принимает id закрываемого ордера |
| POST | /setOrder | Установить ордер. В body свойства type - тип ордера buy/sell, rate - цена, amount - количество |
| GET | /ticker | Информация о котировке торгуемой пары |
| GET | /history | История торгов |
| GET | /summary | Сборная информация о состоянии внутренних переменных (Баланс, котировки, ордера, история и т.д) |
| POST | /candles | Информация о свечах В body свойство periods указывается период свечи, after - с какой даты (timestamp) делать загрузку свечей. |
| GET | /status | Статус бота ( pause: true / false ) |
| PUT | /status | Изменить статус В body свойство pause принимает значение true или false |
| GET | /start | Старт торгового бота |
| GET | /stop | Стоп торгового бота |
| GET | /license | Информация о лицензии |
| GET | /logs | Лог бота |
Важно:
- Методы /balance, /orders, /ticker, /license возвращают кешированное значения внутренних переменных бота. Т.е. эти методы не дергают непосредственно api биржи.
- Если необходимо сначала запустить бота без начала торговли, запускайте с параметром переменного окружения BOT_TRADE=false Затем этот параметр можете изменить в /settings
- Если не указан параметр EXCHANGE, запустится только WEB API, без старта торгового бота.