New major release! _Warning: BREAKING CHANGES!_ See below.
This is a large release with many changes, so please report any issues you run across!
What's Changed
* Add sync/async functionality for all requests by Graeme22 in https://github.com/tastyware/tastytrade/pull/168
Simply add the `a_` prefix to the sync method name and boom, async!
Here's how it looks:
python
acc = await Account.a_get_account(session, account_number)
* Move from price effect to +/- for numbers by Graeme22 in https://github.com/tastyware/tastytrade/pull/169
Previously, most number fields in the API were represented with two separate fields: one for the value, another for the sign (which in the SDK is called `PriceEffect`). This led to less readability and a lot of lines of code that looked like this:
python
value *= -1 if price_effect == PriceEffect.DEBIT else 1
However, as of this release, we can just use positive numbers for credits and negative ones for debits... Much easier! So this example from the old docs of building an order:
python
order = NewOrder(
time_in_force=OrderTimeInForce.DAY,
order_type=OrderType.LIMIT,
legs=[leg], you can have multiple legs in an order
price=Decimal('10'), limit price, $10/share for a total value of $50
price_effect=PriceEffect.DEBIT
)
Became this:
python
order = NewOrder(
time_in_force=OrderTimeInForce.DAY,
order_type=OrderType.LIMIT,
legs=[leg], you can have multiple legs in an order
price=Decimal('-10') limit price, $10/share debit for a total value of $50
)
Under the hood interactions with the API remain unchanged, but for SDK users this should make life much more pleasant.
* better typing for streamer, orders by Graeme22 in https://github.com/tastyware/tastytrade/pull/170
Certain functions for the streamer ended up not working very cleanly with type checkers. So, with a few typing tricks, the streamer functions have changed their parameters, but in exchange we get type hints and a smoother workflow. Here's how the streamer worked before:
python
from tastytrade.dxfeed import EventType
async with DXLinkStreamer(session) as streamer:
await streamer.subscribe(EventType.QUOTE, ['SPY'])
quote = await streamer.get_event(EventType.QUOTE)
And here's how it looks now:
python
from tastytrade.dxfeed import Quote
async with DXLinkStreamer(session) as streamer:
await streamer.subscribe(Quote, ['SPY'])
quote = await streamer.get_event(Quote)
This makes life a lot easier for anyone doing type checking or even using an IDE, so pretty much everyone! The type you pass in will not only control the type of event you receive, but also the inferred return type.
* add order chains, add is_market_open_on util by Graeme22 in https://github.com/tastyware/tastytrade/pull/171
This adds a new function to the `Account` class allowing for fetching order chains (groups of trades in the same symbol used to track open, rolls, and close). Previously these were only available through the `AlertStreamer` for existing postions, but now you can query over a time range for a given underlying:
python
chains = account.get_order_chains(session, 'SPX', start_time, end_time)
Also, adds a utility function to check if the market is open on a specific date (defaults to today).
* test coverage is now better and added for all async tests as well. Using `pytest-aio` to easily run all tests in the same event loop.
* update docs with new functionality
* switch to pyright over mypy for type checking
* switch to Python 3.8 for building
* replace several deprecated functions from pydantic v1
* use `typing_extensions.Self` for classmethods
* add `Customer` and `User` dataclasses for data returned by `Session`
* add tests for `dxfeed` module
* unclutter `tastytrade` package-level exports, which are now restricted to just `Account`, `AlertStreamer`, `DXLinkStreamer`, `Session`, and `Watchlist`
* no longer using `Optional` types for some common, important fields, such as `PlacedOrder.id` and `Option.streamer_symbol`.
* add `unsubscribe_all` function to streamer to unsubscribe from all events of a certain type
* return type of `Account.place_order` and `Account.place_complex_order` now return `tastytrade.order.PlacedOrderResponse` and `tastytrade.order.PlacedComplexOrderResponse` respectively, which are guaranteed to contain the `order` or `complex_order` properties.
**Full Changelog**: https://github.com/tastyware/tastytrade/compare/v8.5...v9.0