API Integration with IBKR TWS Color Grouping Windows

Articles From: Interactive Brokers
Website: Interactive Brokers

API Integration with IBKR TWS Color Grouping Windows

TWS Color Grouping Windows are identified by a color chain, as you can see in the Users’ Guide screenshot below. In the API, an integer number serves to map these specific colors and the function displayGroupList facilitates the integration.

Source: TWS Users’ Guide

Let’s take a look at this scenario from our GitHub Reference Guide using IBApi.EClient.queryDisplayGroups.

First, API users invoke the function IBApi.EWrapper.displayGroupList to query the Groups.

The function returns a list of groups, in a format of integers separated by an “I” character like this “4|1|2|5|3|6|7”. See Python example from the GitHub Guide below.

class TestWrapper(wrapper.EWrapper):

def displayGroupList(self, reqId: int, groups: str):
super().displayGroupList(reqId, groups)
print("DisplayGroupList. ReqId:", reqId, "Groups", groups)

Next, in order to integrate with a specific group, API users have to subscribe to the group, using the function IBApi.EClient.subscribeToGroupEvents.

Finally, the Group Window in TWS can display a certain contract by invoking the API function IBApi.EClient.updateDisplayGroup.

Visit GitHub for additional samples in Java, C++ or C#, and for instructions on how to unsubscribe from the Group Events.

Disclosure: Interactive Brokers

The analysis in this material is provided for information only and is not and should not be construed as an offer to sell or the solicitation of an offer to buy any security. To the extent that this material discusses general market activity, industry or sector trends or other broad-based economic or political conditions, it should not be construed as research or investment advice. To the extent that it includes references to specific securities, commodities, currencies, or other instruments, those references do not constitute a recommendation by IBKR to buy, sell or hold such investments. This material does not and is not intended to take into account the particular financial conditions, investment objectives or requirements of individual customers. Before acting on this material, you should consider whether it is suitable for your particular circumstances and, as necessary, seek professional advice.

The views and opinions expressed herein are those of the author and do not necessarily reflect the views of Interactive Brokers, its affiliates, or its employees.