Текущая версия API - Примечания к выпуску

10.15 - Поля MOC и MOCT, новые атрибуты для ордеров IBKRATS, фильтры событий WSH, стандартные тики цен IPO

Поддержка полей MOT (время ручного ордера) и MOCT (время отмены ручного ордера) в запросах placeOrder/cancelOrder
Поддержка новых атрибутов смещения для ордеров IBKRATS типа "Привязка к лучшей цене" и "Привязка к средней точке" (PEGBEST, PEGMID).
Поддержка фильтров данных о событиях Wall Street Horizon (WSH)
Новые цены IPO, стандартные тики

10.14 - Расширенное отклонение ордеров, информация пользователя

Поддержка расширенного отклонения ордеров
Поддержка информации пользователя

10.12 - Исторические графики

Добавлена поддержка historicalSchedule

10.11 - Правила размера

Добавлены правила размера для contractDetails и bondContractDetails

10.10 - Поддержка крипто, календарь WSH, рыночные данные акций, новые атрибуты

Добавлена поддержка торговли криптовалютами
Поддержка мета и календарных событий WSH в API.
Добавлены рыночные данные по биду, аску и последнему размеру акций.
Добавлен атрибут PostToAts, поддерживающий перенаправление на SMART для ордеров IBKR ATS. См.: https://www.interactivebrokers.co.uk/ru/index.php?f=17386
К функции placeOrder/openOrder добавлен параметр AutoCancelParent.
Поддержка атрибута длительности ордерами типа "годен до даты" (GTD).
Больше не поддерживаются атрибуты ETradeOnly, FirmQuoteOnly и NbboPriceCap для ордеров.

981 - Объединение групп и профилей распределения

Интерфейсы API, взаимодействующие с платформой TWS версии 983+, где активна функция "Использовать группы счетов с методами распределения", претерпят следующие изменения:

Запросы replaceFA и requestFA оба приведут к отправке и получению объединенного списка групп/профилей, если аргумент – Group.
- Запросы replaceFA и requestFA оба приведут к ошибке, если аргумент – profile.
placeOrder станет поддерживать название профиля в качестве названия faGroup, а faMethod можно не указывать.
- Если вы указываете название группы и оставляете faMethod пустым, то используется метод, действующий по умолчанию для группы. В ином случае для ордера будет задан метод из запроса.
При вызове openOrder будет сообщаться Profile вместо Group, если ордер создается для профиля.
Следующие вызовы API, использующие название группы, также будут принимать название профиля вместо него:

reqAccountSummary / cancelAccountSummary
reqPositionsMulti / cancelPositionsMulti
reqAccountUpdatesMulti / cancelAccountUpdatesMulti

980 - Мелкие поправки для полного функционала

Если не указано иначе, данный выпуск требует TWS версии 980 или новее.

Благодаря мелким поправкам версия 980 рекомендуется для доступа к полному функционалу.

979 - .Net Standard 2.0, семейства кодов, волатильность на основе цены, поправки

Если не указано иначе, нижеописанные функции требуют TWS версии 979 или новее.

.Net Standard 2.0: Клиентская библиотека .Net ориентирована на версию Net Standard 2.0
Более полная информация о семействах кодов (изменения со стороны сервера).
В Python API добавлен параметр setConnectionOptions(). Теперь вы можете использовать настройку "+PACEAPI", как и в других инструментах API.
Котировке волатильности на базе цены: Список новых доступных типов тиков 92-99 - http://interactivebrokers.github.io/tws-api/tick_types.html
- Требует TWS версии 980 или новее.
Устраненные ошибки: Мелкие поправки в клиентских библиотеках to Python и C++

976 - Алгоритм управления ценой, завершенные ордера

Если не указано иначе, нижеописанные функции требуют TWS версии 976 или новее.

Алгоритм управления ценой: Мы добавили поддержку значения по умолчанию в атрибутах алгоритма управления ценой. Дополнительная информация о новом алгоритме IBKR по управлению ценой доступна на странице https://www.interactivebrokers.com/ru/index.php?f=57276.
Завершенные ордера: Функция "function reqCompletedOrders()" позволяет вернуть все завершенные ордера (независимо от того, были ли они исполнены или отменены).

975 - DDESocketBridge, новые поля в запросах рыночной глубины, поправки в Python и ActiveX

Если не указано иначе, нижеописанные функции требуют TWS версии 975 или новее.

DDE API на основе сокета: Мы открыли доступ к новому DDE API, который может быть запущен независимо от TWS и имеет те же функции, что и сокетные API.
Запросы рыночной глубины: Добавлено поле основной биржи, чтобы избежать неясности в запросах рыночной глубины со smart-маршрутизацией.
Поправки в Python: Устранена проблема, которая вызывала автоматический разрыв связи через 20 секунд, при использовании Python.
Поправки в ActiveX: Исправлены функции размещения ордеров и подписки на сканеры в образце таблицы ActiveX.

974 - Шортинг акций, глубина, скорость обработки и прочее

Если не указано иначе, нижеописанные функции требуют TWS версии 974 или новее.

Новый тик ShortableShares отражает точное число акций, доступных для шортинга: Теперь при запросе данных посредством стандартного тика 236 в reqMktData отображается точное кол-во акций, доступных для шортинга; помимо этого уже имеющийся тик 'Shortable' показывает больше или меньше ли их число чем 1000 (загружается отдельно в ответ на стандартный тик 236 в версиях TWS, которые старее бета 974.1).
Smart Depth: Теперь API предоставляет потоки агрегированных углубленных (Depth of Market или DOM) котировок 1-го и 2-го уровня, на которые подписан пользователь, не требуя индивидуальных запросов reqMktDepth для каждой биржи. Запрос производится посредством установки нового параметра isSmartDepth в reqMktDepth как "True".
Новый параметр для консультантов: Чтобы избежать возможной путаницы, функции reqPositionsMulti и reqAccountUpdatesMulti больше не будут поддерживать установку пустого параметра 'account' (счет) для счетов консультантов. Для запроса данных со всех субсчетов, следует установить параметр "All".
Скорость обработки: Сообщения API, отправляемые с частотой больше 50 штук в секунду, теперь могут обрабатываться TWS со скоростью 50/сек., не вызывая разрыв связи. Теперь это происходит автоматически через сервер RTD, а также поддерживается другими технологиями API посредством вызова функции SetConnectOptions("+PACEAPI") перед eConnect.
reqHistoricalTicks in ActiveX: Теперь функция reqHistoricalTicks доступна в ActiveX API
Размещение тикетов через API (для OMS): Размещение тикетов теперь возможно через API при использовании TWS в кач-ве системы управления ордерами (OMS).
Стандартные фильтры в сканерах: Стандартные фильтры (не являющиеся полями в классе ScannerSubscription) можно использовать в сканере API. Новые фильтры находятся через функцию API reqScannerParameters и добавляются посредством дополнительного параметра в reqScannerSubscription. Требует версии TWS 973 иои новее.
Таблица-образец в кач-ве файла классов: Для образцов таблиц Excel ActiveX скоро будут введены файлы классов (.cls), чтобы улучшить контроль версий и внедрение в Github. Для пополнения таблицы-образца ActiveX последними данными следует использовать предоставленный скрипт decompile.vbs, чтобы обновить декомпилированные файлы vbproject, а затем загрузить эти файлы вдобавок к TwsActiveX.xls.

973.07 - Мастер установки API для сервера RTD, исправлена проблема ActiveX, стандартные названия ContractDetails

Мастер установки API для сервера RTD: Теперь API совместим 64-битным Excel.
Исправлена проблема ActiveX с передачей исторических данных и чтением поля "lastLiquidity" в объекте исполнения.
Класс ContractDetails: Поле 'summary' (сводка) было переименовано в 'contract' (контракт) для API на базе Python, C#/.NET, C++ и ActiveX, чтобы оно было одинаково для всех языков API (название 'contract' уже использовалось в Java API).
В API введена возможность передаче значений греков вне диапазона от -1 до 1.
Параметр "DeltaNeutralContract" переименован в "UnderComp".
Обновление C++ для использования shared_ptr из стандартной библиотеки C++.
Исправлена проблема с переполнением ID ордеров в таблице-образце DDE.

Эти функции требуют TWS версии 971 или новее:

Новые поля "что, если" в API для предторговых начальных и минимальных маржинальных требований
К классу ордера добавлен параметр "DontUseAutoPriceForHedge". Это дает возможность установки конкретной лимитной цены для прикрепленной пары/FX/бета-хедж.
Добавлен тик 105 для поля "Средний объем сделок с опционом".
Добавлена временная метка для последней цены с задержкой.

973.06 - Поля отчетности MiFIR по транзакциям

Начиная с версии 973.06 и TWS 969. Для инвестиционных фирм Европейской экономической зоны (ЕЭЗ, англ. EEA), обязанных предоставлять отчетность MiFIR и выбравших Расширенную и делегированную отчетность, мы добавили четыре новых атрибута ордеров, а также несколько новых предустановок для глобальной конфигурации TWS и IB Gateway.

Новые атрибуты ордеров включают в себя:

mifid2DecisionMaker – используется для отправки значения "инвестиционное решение в фирме" (если не применяется mifid2DecisionAlgo).
mifid2DecisionAlgo – используется для отправки значения "инвестиционные решение в фирме" (если не применяется mifid2DecisionMaker).

mifid2ExecutionTrader – используется для отправки значения "исполнение в фирме" (если не применяется mifid2ExecutionAlgo).
midid2ExecutionAlgo – используется для отправки значения "исполнение в фирме" (если не применяется mifid2ExecutionTrader).

Новые предустановки ордеров TWS и IB Gateway можно найти в разделе Ордера > MiFIR в глобальной конфигурации; в их число входят "Принимающий решение по умолчанию TWS", "Принимающий решение по умолчанию API" и "Исполняющий трейдер/алгоритм".

Для атрибутов "инвестиционного решения в фирме" mifid2DecisionMaker и mifid2DecisionAlgo доступны следующие варианты:

Данное поле не требуется, если вы:

Используете TWS API для передачи ордеров И
Инвестиционное решение всегда принимается клиентом И
Никто из клиентов не является инвестиционной фирмой ЕЭЗ, выбравшей делегированную отчетность ("фирма с делегированной отчетностью").

Вы можете настроить предустановку, чтобы она отражала это, в глобальной конфигурации TWS: раздел Ордер > MiFIR. В таком случае ордера проприетарного счета потребуется размещать через TWS.

Если вы используете TWS API для передачи ордеров, и инвестиционное решение принимается человеком или группой людей (в которой один из них главный) в фирме с делегированной отчетностью:

Посредством поля mifid2DecisionMaker ваша программа TWS API может с каждым ордером отправлять краткий код, который компания IB присвоила лицу, принимающему инвестиционные решения. Вы можете указать лиц, которые имеют право принимать решения, в "Управлении счетом" IB. Для получения кратких кодов, которые IB назначили данным лицам, свяжитесь с клиентской службой IB.

Если ваша программа TWS API не может передать вышеуказанное поле, а инвестиционное решение принимается или одобряется единственным лицом, которое можно назвать основным инвестиционным распорядителем, вы можете заранее установить алгоритм по умолчанию, чтобы он использовался теми ордерами, где это поле не отправляется. Вы должны указать ответственного(-ых) за инвестиционное решение через "Управление счетом" IB, после чего сможете задать настройки по умолчанию в глобальной конфигурации TWS: раздел Ордера > MiFIR.

Если вы используете TWS API для передачи ордеров, и инвестиционное решение принимается алгоритмом:

Посредством поля mifid2DecisionAlgo ваша программа TWS API может с каждым ордером отправлять краткий код, который компания IB присвоила лицу, принимающему инвестиционные решения. Вы можете выбрать алгоритмы, которые имеют право принимать решения, в "Управлении счетом" IB. Для получения кратких кодов, которые IB назначили данным лицам, свяжитесь с клиентской службой IB.

Если ваша программа TWS API не может передать вышеуказанное поле и/или инвестиционное решение принимается единственным или главным алгоритмом, вы можете заранее установить алгоритм по умолчанию, чтобы он использовался ордерами, для которых это поле не отправляется. Вы должны указать ответственного(-ых) за инвестиционное решение через "Управление счетом" IB, после чего сможете задать настройки по умолчанию в глобальной конфигурации TWS: раздел Ордера > MiFIR.

ПРИМЕЧАНИЕ: Только ОДИН ответственный за инвестиционное решение (либо главное лицо, либо основной алгоритм) должен быть указан в ордере или установлен по умолчанию.

Для атрибутов "исполнения в фирме" mifid2ExecutionTrader и mifid2ExecutionAlgo доступны следующие варианты:

Дополнительная информация не требуется, если вы используете TWS API для передачи ордеров, введенных через сторонний торговый интерфейс, и являетесь трейдером, ответственным в фирме за исполнение.

Если ваша программа TWS API отправляет ордера в IB автоматически без человеческого участия, свяжитесь с клиентской службой IB, чтобы зарегистрировать эту(-и) программу(-ы) в IB в качестве алгоритма. Только основная программа или алгоритм требуют регистрации и идентификации. Затем вы можете задать настройки по умолчанию в глобальной конфигурации TWS: раздел Ордера > MiFIR.

Посредством поля mifid2ExecutionAlgo (для алгоритма) или mifid2ExecutionTrader (для человека) ваша программа TWS API может с каждым ордером отправлять краткий код, который компания IB присвоила алгоритму или лицу, принимающему инвестиционные решения.

Для получения дополнительных сведений или кратких кодов лиц/алгоритмов, указанных в "Управлении счетом" IB, свяжитесь с клиентской службой IB.

Чтобы больше узнать об обязательствах по отчетности MiFIR, ознакомьтесь со статьей Расширенная и делегированная отчетность MiFIR для инвестиционных фирм ЕЭЗ в "Базе знаний".

Потиковые данные в реальном времени для акций США через API

Начиная с версии 973.06 и TWS 969.ФункцияreqTickByTickData загружает данные тиков в реальном времени максимум по пяти ценным бумагам США.

Также включено в версию 973.06

Следующие функции и устранения ошибок также доступны в API версии 973.06:

Потиковая средняя точка;
Возможность использования экземплярного метода обработчика оболочки;
Python: Добавлена потиковая поддержка; другие обновления и назначительные изменения; обработка сообщений Latin-1 об ошибке;
Публикация DefaultEWrapper;
Согласование типа поля Make Order.permid;
Источник /cppclient/client/EClient.h; std::auto_ptr<> был признан устаревшим;
Устраненные ошибки: Исправлена строка форматирования параметра BarData; EDecoder.cpp : initialize mktCapPrice (решение проблемы #573); Исправлен сбой, из-за которого сетевой пакет содержал только 1 - 3 байта следующего сообщения.

973.05 Обновления деталей контракта; реализованная ПиУ; греки опционов в RTD; поддержка 64-битных приложений ActiveX; индикатор последней ликвидности

Поле реального срока истечения добавлено в ContractDetails
В поле последней даты торгов добавлен часовой пояс
Поле реализованной ПиУ добавлено к функции ПиУ
Теперь можно получать греки опционов через сервер RTD API
Мы ввели совместимость с 64-битными приложениями ActiveX в предоставленный файл установки API
В отчеты по исполнениям добавлен индикатор последней ликвидности

Обращаем внимание, что Python API еще может не содержать некоторых из перечисленных функций. Подробности доступны в "Руководстве пользователя API" по адресу http://interactivebrokers.github.io/tws-api/

Потиковые исторические рыночные данные в API

Начиная от API версии 973.04, вы можете запрашивать исторические рыночные данные по тикам из базы IB, используя функцию IBApi::EClient::reqHistoricalTicks. Результаты отображаются через IBApi.EWrapper.historicalTicks, IBApi.EWrapper.historicalTicksBidAsk и IBApi.EWrapper.historicalTicksLast в зависимости от типа запрошенной информации.

Образцы и дополнительные сведения можно найти на странице http://interactivebrokers.github.io/tws-api/historical_time_and_sales.html.

Обновления сервера TWS RTD для Excel

Начиная от API версии 973.04, сервер RTD API поддерживает запросы символов, которые содержат пробел (например, "BRK B"). Также была улучшена обработка сообщений RTD об ошибках.

Дополнительная информация доступна на странице http://interactivebrokers.github.io/tws-api/tws_rtd_server.html.

Улучшенный образец Excel ActiveX

Начиная от API версии 973.04, код образца таблица ActiveX был перепроектирован, что упростило его чтение и расширение.

Чтобы воспользоваться образцом таблицы ActiveX, перейдите на страницу http://interactivebrokers.github.io/tws-api/activex.html#activex_sample.

Предельная рыночная цена в статусе ордера

Начиная от API версии 973.04, сообщение о статусе ордера включает его предельную цену, если дело касается ограниченного рыночного ордера.

"Скорректированная последняя" в образцах API

Начиная от API версии 973.04, образцы API включают тип исторических данных "ADJUSTED_LAST", что символизирует получение исторической информации, скорректированной с учетом дивидендов.

Атрибуты бида и аска перед открытием

Начиная от API версии 973.04, функция "tickPrice" поддерживает атрибуты "preOpenBid" и "preOpenAsk", которые отражают котировки за период перед открытием биржи.

Новое поле keepUpToDate для запросов исторических данных

Начиная от API версии A973.03 и TWS версии 965, функция "reqHistoricalData" для запроса исторических данных требует значения "keepUpToDate", которое может быть "true" (верно) или "false" (ложно), на основе чего определяется дальнейшее поведение:

True: Создается подписка для загрузки незавершенных столбиков в реальном времени по мере их доступности, или

False: Все данные загружаются на разовой основе.

ПРИМЕЧАНИЕ: Если верно (True), то endDateTime невозможно указать.

Образцы и дополнительные сведения можно найти на странице http://interactivebrokers.github.io/tws-api/historical_bars.html#hd_request.

Новостные заголовки и статьи API

Начиная от API версии 973.02, новостные статьи из API предлагаются четырьмя поставщиками. Новости из API требуют отдельных подписок, за каждую из которых взимается плата точно так же, как и за новостные сервисы в TWS. Функции API по обработке новостей позволяют просматривать доступных поставщиков, активировать подписки для отображения заголовков при выходе статей в реальном времени, запрашивать конкретные статьи и загружать список прошлых новостей, хранящихся в системе.

Доступные на данные момент новостные подписки API включают Briefing Trader, Benzinga Pro, Fly on the Wall и Midnight Trader.

Активируйте новости API через "Управление счетом", где доступен список всех ваших текущих подписок. Подписки также можно увидеть в API, используя функцию IBApi::EClient::reqNewsProviders:

Запрос заголовков прошлых новостей: Имея необходимую подписку на новости API, вы можете запросить заголовки прошлых новостей в API, используя функцию IBApi::EClient::reqHistoricalNews. Результаты загружаются в IBApi::EWrapper::historicalNews.

Запрос новостных статей: После запроса заголовков посредством одной из вышеуказанных функций вы можете запросить текст статьи при помощи ее ID, используя функцию IBApi::EClient::reqNewsArticle. Текст новостной статьи загружается в функции IBApi::EWrapper::newsArticle.

Образцы и дополнительную информацию можно найти на странице http://interactivebrokers.github.io/tws-api/news.html.

Поиск тикеров с запросом совпадающих символов

Начиная от версии 9.73.02, поиск контрактов посредством функции IBApi::EClient::reqMatchingSymbols может основываться на начальных буквах тикер-символа. Например, если вы укажете "I" или "IB" при поиске тикер-символа IB, то в список совпадающих результатов будет входить "IBKR".

Результаты загружаются в IBApi::EWrapper::symbolSamples.

Образцы и дополнительные сведения доступны на странице http://interactivebrokers.github.io/tws-api/ matching_symbols.html

Регуляторная сводка для акций

Когда дело касается акций, то получение потоковых котировок требует подписки на отдельные рыночные данные конкретных бирж, начиная от версии 9.73.02. Например, для акций NYSE существует подписка "Network A", для акций ARCA/AMEX есть "Network B", а для акций NASDAQ - "Network C". Каждая подписка добавляется по выбору и имеет свою цену.

В качестве альтернативы предлагается пакет "US Securities Snapshot Bundle", который не поддерживает потоковые данные, но отражает сводки цен NBBO на рынках США, рассчитанные в реальном времени. Задав пятый параметр в IBApi::EClient::reqMktData как "True" ("Верно"), вы сможете запрашивать регуляторную сводку через API. Отображаемое значение - это расчет текущего состояния рынка, основывающийся на данных со всех доступных бирж.

Дополнительная информация об услуге регуляторных сводок США, доступна в статье "Базы знаний" IB.

Важно! За каждый запрос регуляторной сводки со счета будет взиматься 0.01 USD. Это касается как реальных, так и тренировочных счетов. Если месячная стоимость регуляторных сводок достигнет цены определенной подписки типа "Network", то эта подписка будет автоматически активирована для пользователя, после чего он станет получать потоковые котировки за действующую плату. В конце месяца подписка будет аннулирована. Для каждой биржи будет действовать индивидуальные пределы, которые не складываются и не усредняются.

Образцы и дополнительные сведения доступны на странице http://interactivebrokers.github.io/tws-api/md_request.html#regulatory_snapshot

Используйте вместе с TWS версии 966 или новее.

Загрузка открытого интереса фьючерсов в API

Начиная от API версии 9.73.01 и TWS версии 965.1b, вы можете получать данные об открытом интересе фьючерсов через API, отправляя reqMktData() и включая “588” в параметр genericTickList. После вызова tickSize() открытий интерес фьючерсов будет загружен в тик типа 86.

Подробности доступны в документации API:

https://interactivebrokers.github.io/tws-api/tick_types.html

Запрос деталей контракта загружает информацию андерлаинга

Начиная от версии 9.73.01, функция IBApi::EClient::reqContractDetails теперь может использоваться для определения следующих деталей базового контракта (для деривативов):

underConid = ID базового контракта.

Начиная от версии 9.73.03, функция IBApi::EClient::reqContractDetails может использоваться для определения дополнительных деталей базового контракта:

underSymbol = символ базового контракта (андерлаинга).
underSecType = тип ценной бумаги базового контракта.

Они загружаются в IBAPI::EWrapper::contractDetails

Сервер RTD

Начиная от версии 9.73.03, используйте библиотеку динамических ссылок сервера RTD, чтобы запрашивать рыночные данные TWS через API посредством таблицы Excel. Введите следующую формулу в ячейку таблицы Excel:

=RTD (ProgID, Сервер, Параметр1, Параметр2, ...)

где:

"ProgID" - это Tws.TwsRtdServerCtrl
"Сервер" пуст.
"Параметр1", "Параметр2" и т.д. обозначают тикер, хост/порт и темы.

Например, если первый параметр ("Параметр1") является тикером в простом синтаксисе, а "Параметр2" - это размер бида:

=RTD ("Tws.TwsRtdServerCtrl", , "IBM@ISLAND", "РазмерБида")

Новый Python API

Примечание: Требуется Python 3.1 или новее.

Доступен новый клиент Python API, начиная от версии 9.73.01. Установив бета-выпуск на свой компьютер, вы сможете найти компоненты Python API в следующих местах:

Образец кода Python API – папка samples/Python в директории, куда вы установили API (обычно IB_973)
Исходный код Python – папка source/pythonclient в директории, куда вы установили API

Устраненные ошибки

Исправлен образец Linux/Mac C++.