Feature Request: Add Support for SMART + OVERNIGHT Order Type in ib_async

[osjayaprakash]

Feature Request: Add Support for SMART + OVERNIGHT Order Type in ib_async

Currently, ib_async requires users to manually switch the exchange parameter between "OVERNIGHT" for overnight sessions and "SMART" for regular/pre-market/after-market hours. This workflow is inconvenient. The TWS API now supports a simplified order type that eliminates the need to change exchanges when transitioning between overnight and regular trading sessions. According to IBKR technical support, this can be implemented as follows:

Thank you for contacting Interactive Brokers.

Assuming that you are speaking of the OVERNIGHT + DAY time in force, as displayed in TWS, you may implement this in the TWS API in the following way:

• Set the exchange of your Contract object to "SMART"
• Set the TIF of your order to "DAY"
• Set the includeOvernight boolean flag of the Order object to True

Using AAPL stock as an example:

# Define contract
contract = Contract()
contract.symbol = "AAPL"
contract.secType = "STK"
contract.currency = "USD"
contract.exchange = "SMART"

# Define order
order = Order()
order.action = "BUY"
order.totalQuantity = 1
order.orderType = "LMT"
order.lmtPrice = 267.32
order.tif = "DAY"
order.includeOvernight = True

[mattsta]

Oh, interesting, hadn't seen that option before. Thanks for finding it!

We're currently a few versions behind on gateway feature support (our last updated version check is at 180 and this is advertised as MIN_SERVER_VER_INCLUDE_OVERNIGHT = 189).

We may look into it after the current update cycle, or it may end up being a next-gen-protobufs-client-only feature depending on how far we are into maintain-only vs extend-into-new-system modes.

[osjayaprakash]

Thanks @mattsta . I agree that implementing this feature in the new protobuf-based system would be ideal. I've taken a brief look at how includeOvernight could be implemented. I'm happy to submit a PR for this as well if that would be helpful (after the new version is ready).

[gnzsnz]

This should be working on protobuf PR, i have not tested it. But the includeOvernight is now part of the Order object, and part of the protobuf translation.

[osjayaprakash]

Awesome. Thanks @gnzsnz. Please update us when the protobuf implementation is ready, i'm happy to test it.

[Andrewyan123]

@gnzsnz Thank you for your work on this project! I have a quick question — does the protobuf version of the TWS API require manual installation?
I tried using your protobuf branch, but I'm encountering this error: TypeError: Order.init() got an unexpected keyword argument 'includeOvernight'

[gnzsnz]

are you sure the code is installed?

https://github.com/gnzsnz/ib_async/blob/04795ce3321f6394314834df9268b3fd26dc0b3c/ib_async/order.py#L188C5-L188C21

includeOvernight is now an attribute of Order class, is it failing when you instantiate the order or with placeOrder?.

I haven't tried overnight yet, out of regular trading hours works fine. The only issue that i faced so far is that now TIF seems to be mandatory, while with ib_async it's defaulted by the TWS API itself(not by ib_async). This is not really an error but a change in the API.

Please paste the code and error. And make sure that you pass TIF, which should be "OVERNIGHT". I added an enum for TIF ib_async.order.OrderTIF

[Andrewyan123]

@gnzsnz Thanks for your reply! I found that the library I was referencing was indeed an old version of the async library. After switching to your version, it now properly supports placing overnight orders. Thank you so much for supporting this new feature！ 😄

[gnzsnz]

great news, if you find any problem please create an issue.

for reference the PR for protobuf is #185 and there is an issue #138 open.

@mattsta do you have an opinion on TIF? with API 178 TIF is defaulted, not by ib_async but by the "backend API". But on >216 (not sure from which version) TIF must be passed on the order. We can default Order.tif = "DAY" to keep existing functionality in ib_async<=2 otherwise existing code will fail.

ib_async/ib_async/order.py

Line 33 in ab629f3

tif: str = ""

[osjayaprakash]

@mattsta @gnzsnz Thanks for working on this. is the protobuf branch stable to use? do you have plans to merge the protobuf implementation to main branch?

[gnzsnz]

@osjayaprakash you can use protobuf, it's as stable as a beta release. market data L2 and event data is not implemented yet.

I'm using it as a daily driver with almost no issues.

There is a weird issue that i have not been able to reproduce. I start receiving ticker data for requests that i have not made. How do i know i have not made the request? Because I added a small check in the ticker handler, if we receive an unknown request ignore it(as ib_asynd does now) AND (new thing) unsubscribe from it, we know the request id so we can. Then i get an error upstream server claim an unknown request id. so it's a bug, but i'm not sure if it's a bug with ib_async, it could be a bug on IBKR API. Tickers works well, i haven't had problems.

Besides that it works, and you should be able to get your current code to work with it. I still have some refactoring and to implement L2 data, so pull frequently.

I would actually encourage you and other people to try it, i could use some feedback.