Библиотека tcsinvest

tcsinvest - это неофициальная библиотека R для работы с API Тинькофф Инвестиции. Библиотека дает доступ к функциональности API привычными функциями. Библиотека использует в своей основе библиотеку data.table как один из наиболее производительных способов работы с большими объемами информации в R.

В случае, если вы уже имеете токен и знаете как с ним работать - можно пропустить следующую главу (Получение токена)

Получение токена

Токен — это специальный набор символов, представляющий собой зашифрованную информацию о владельце, уровне прав доступа и прочей необходимой для авторизации в Tinkoff OpenAPI информации (из официальной документации).

Если коротко: токен - это строчка, которая позволяет получить доступ к операциям со счета.

Существует 2 типа счетов:

• Торговый (живой) счет - это место где лежат ваши средства

• Песочница (sandbox, иногда paper trading) - это место где можно проверить функциональность API, запустить торговый алгоритм, без потерь реальных средств.

Мы настоятельно рекомендуем все проверки с программным кодом делать в песочнице. Все функции реализованные в библиотеке tcsinvest по умолчанию подключаются к песочнице (требуется специальное указание, что вы подключаетесь к торговому счету).

Получить токен можно из личного кабинета во вкладке Настройки. В разделе “Token для Open API” имеются 2 кнопки: для песочницы и для живой торговли.

При нажатии одной из кнопок мы попадаем на страницу где будет указан Ваш токен. Сохраните этот токен. Как гласит официальная документация “Токен отображается только один раз, просмотреть его позже не получится. Тем не менее вы можете выпускать неограниченное количество токенов”. Ранее выпущенные токены можно отзывать, токены живут 3 месяца с момента их последнего использования.

P.S. важное замечание для торговли на живом счете: функция “Подтверждение сделок кодом” должна быть отключена.

В случае, если вы уже установили библиотеку tcsinvest - можно пропустить следующую часть.

Установка библиотеки tcsinvest

Для использования библиотеки в R, ее нужно сперва установить. Можно это сделать 2 способами:

• Использовать версию загруженную в репозиторий CRAN

• Использовать версию с Github

В репозиторий CRAN обычно загружены наиболее стабильные версии библиотек, их легко установить, но достаточно часто они не учитывают последние изменения в коде, исправления возникающих ошибок и изменения в самом API. Хотя для большинства пользователей достаточно и рекомендуется использование библиотеки загруженной на CRAN. Для установки с CRAN достаточно найти библиотеку в списке общих пакетов или установить с использованием команды:

install.packages("tcsinvest")

В случае загрузки библиотеки с github необходима установленная библиотека devtools (в случае если ее нет - нужно установить).

devtools::install_github("arbuzovv/tcsinvest",build_vignettes = TRUE)

Иногда при таком методе возникает ошибка “Error in utils::download.file(url, path….” которая лечится следующей строчкой кода:

options(download.file.method = "libcurl")

Если в процессе установки возникает ошибка “Error in strptime(xx, f, tz = tz) : (converted from warning) unable to identify current timezone”, то ее можно устранить указанием временной зоны

Sys.timezone()
Sys.setenv(TZ='GMT')
Sys.timezone()

В случае успешной загрузки и компиляции библиотеки, вам станет доступна библиотека tcsinvest в списке доступных библиотек. Теперь подключим данную библиотеку к пространству имен:

library(tcsinvest)

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

Котировки

Наиболее простой тип команды, который позволяет получить базовую информацию о текущем состоянии инструмента является команда getQuotes. С помощью этой информации мы получаем основную информацию о котировках инструмента:

getQuotes(token,live,figi = 'BBG005HLTYH9')

Данные функции возвращают объект data.table со следующим списком полей:

• figi - FIGI код, именно с его использованием идентифицируются все инструменты и последующие команды в данном руководстве

• tradeStatus - статус торговли инструментом:

  • break_in_trading - торги приостановлены;
  • normal_trading - торги идут;
  • not_available_for_trading - торги не идут;
  • closing_auction - торги в аукционе закрытия;
  • closing_period - торги в периоде закрытия;
  • discrete_auction - торги в дискретном аукционе;
  • opening_period - торги в аукционе открытия;
  • trading_at_closing_auction_price - торги по цене аукциона закрытия

• minPriceIncrement - минимальный шаг цены

• lastPrice - последняя доступная цена сделки

• closePrice - цена закрытия предыдущего дня

• limitUp - верхнее ограничение по уровню цены заявки

• limitDown - нижнее ограничение по уровню цены заявки

• best_bid_price - лучшая цена покупки на рынке

• best_bid_quantity - объем лучшей цены покупки на рынке

• best_ask_price - лучшая цена продажи на рынке

• best_ask_quantity - объем лучшей цены продажи на рынке

Исторические данные

Исторические данные - это наиболее используемый тип информации в любой алгоритмической системе. Для загрузки исторических данных по инструменту используется команда getHistoricalData, которая содержит в себе ряд важных параметров:

• from - с какой даты загружаем историю по инструменту (если дата будет слишком ранняя, это может вызывать отказ API выгружать слишком много инфомации)

• to - до какой даты загружаем историю по инструменту

• interval - какие бары выгружаем? минутные ('1min','2min',3min','15min','30min'), часовые ('hour','hour','2hour','4hour',), дневные ('day'), недельные('week'), месячные ('month')

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

getHistoricalData(token,live,figi = 'BBG005HLTYH9',from = Sys.Date() - 2,to = Sys.Date(),interval = "hour")

Книга заявок

Наиболее полная информация о спросе и предложении на рынке содержится в книге заявок. Операция getOrderBook позволяет загружать такого рода информацию. Параметр depth отвечает за то, какое количество уровней в книге заявок загружать. В качестве результата данной функции выдается информации: цена,объем (заявки на продажу кодируются отрицательным объемом). Хотя в документации и описано, что глубина должна быть от 1 до 20, но на данный момент Тинькофф не отслеживает информацию по данному параметру и позволяет выгружать гораздо больше количество доступных уровней книги заявок.

getOrderBook(token,live,figi = 'BBG005HLTYH9',depth = 10)

Информация о счете

Как заявлено в официальной документации - на данный момент идет процесс разработки поддержки мультисчетов. Сейчас можно получить информацию о доступных на данный момент аккаунтах:

getAccounts(token,live)

Получить информацию о балансе аккаунта можно с помощью команды getBalance, которая выдает информацию о доступных средствах в 3 валютах (рубли, доллары и евро)

getBalance(token,live)

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

getOperations(token,live)

В случае необходимости более длительной истории - используйте параметры from и to.

Для того, чтобы получить информацию о текущем портфеле используется команда getPortfolio:

getPortfolio(token,live)

Заявки на покупку или продажу инструментов могут иметь 3 статуса: отменена, исполнена, активна. По умолчанию API (и функция getOrders) возвращает только активные заявки. В случае, если нам необходима история заявок необходимо указать only_live_orders = FALSE - вернется история за последние 5 дней. В случае необходимости более длительной истории - используйте параметры from и to.

getOrders(token,live,only_live_orders = F)

Для получения информации о сделках, используйте функцию getTrades. Контролировать глубину истории можно параметрами from и to. Параметр symbol_info = TRUE позволяет дополнительно подгрузить информацию об инструменте по которому была совершена сделка. По умолчанию выгружается информация за последние 5 дней. Получить информацию о сделках:

getTrades(token,live)

Работа с заявками

Работа с заявками является важнейшей частью любого алгоритма. Глобально можно выделить 2 типа заявок: рыночные и лимитные. В заявках указывается инструмент, объем (в лотах, а не в штуках!), направление и цена (только для лимитных заявок). Поставить рыночную заявку

marketOrder(token,live,figi='BBG005HLTYH9',direction='Buy',lots=1)

Поставить лимитную заявку

limitOrder(token,live,figi='BBG005HLTYH9',direction='Buy',lots=1,price=1)

Результатом выполнения каждой команды является ответ системы о том, была ли поставлена заявка. Рекомендуется в своих алгоритмах использовать проверку на успешность выставленной заявки. Иногда требуется отмена выставленной заявки. Для этого используется функция cancelOrder. Для того, чтобы понять какую заявку нужно отменить, необходимо указать ее orderId, который можно найти с помощью функции getOrders.

cancelOrder(token,live,'orderId')

Обработка событий

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

bid_ask_spread = function(x)
{
  spread = min(x$asks[,1])-max(x$bids[,1])
  print(spread)
}

Теперь, когда у нас имеется пользовательская функция, можно приступить к обработке с ее помощью событий. Для этого в качестве агрумента FUN передадим название нашей новой функции bid_ask_spread:

streamStatus(client)
streamSubscribe(client,subscribe = TRUE,type='orderbook',FUN = 'bid_ask_spread',figi='BBG004730N88',depth=5)

Для отмены подписки на данный поток, используйте команду с указанием той функции, с помощью которой подписывались на поток:

streamSubscribe(client,subscribe = FALSE,type='orderbook',FUN = 'bid_ask_spread',figi='BBG004730N88',depth=5)
streamClose(client)

В качестве функции обрабатывающей события может выступать любая логика, в том числе и торговая. Для обращения к показателям в потоковых данных внутри функции function(x), можно использовать следующую таблицу в качестве подсказки:

Мой первый торговый робот

Здесь представлен тестовый робот, который имеет простейшую логику:

• если прирост в предыдущую минуту был положительный - то нужно находиться в позиции

• если прирост в предыдущую минуту был отрицательный - то нужно находиться не в позиции

Простейшая логика этой трендовой стратегии:

# задаем баланс в песочнице на который будем торговать
token = 'your_sandbox_token_from_tcs_account'
live = FALSE
sandboxBalance(token,balance = 100000,currency = 'RUB')
getBalance(token,live)

# информация об инструменте
capital = 100000
ticker_info = getTickerInfo(token,live,ticker = 'SBER' )
lots = ticker_info$lot
figi_code = ticker_info$figi

# бесконечный цикл торговли
while(2==2)
{
# инфомация о сигнале и необходимой позиции (теоретической)
history = getHistoricalData(token,live,figi_code,from = Sys.Date()-1,interval = '1min')
last_ret = tail(history$c/history$o-1,1)
size = floor(capital/getQuotes(token,live,figi_code)$lastPrice/lots)
theor_position = ifelse(last_ret>0,size,0)
  
# фактическое состояние портфеля
my_portfolio = getPortfolio(token,live)
if(length(my_portfolio)>0)
  current_position = my_portfolio[figi==figi_code]$lots
current_position = ifelse(length(current_position)==0,0,current_position)  

# приводим теоретическое состояние к фактическому
if(theor_position!=current_position)
{
  direction = ifelse(theor_position-current_position>0,'Buy','Sell')
  marketOrder(token,live,figi_code,direction=direction,lots=abs(theor_position-current_position))
}

# печать совершенных сделок и ожидание следующей минуты  
print(getTrades(token,live))
Sys.sleep(60)
}