Skip to content

v5.0.0

Compare
Choose a tag to compare
@justinpolygon justinpolygon released this 02 Nov 14:39
· 12 commits to master since this release
895faee

Release Notes: WebSocket Syntax and Parsing Enhancements

This release has a breaking change to the WebSocket API's PolygonWebSocketClient connection syntax that significantly improves and paves the way for supporting a broader range of products in the future. Please update your WebSocket API implementations accordingly, and as always, we value your feedback and are here to support you through this transition.

We've provided fully fleshed-out example clients for all subscription types here: GitHub - polygon-io/client-jvm.

New Connection Requirements:

  • When initializing a connection using PolygonWebSocketClient, it is now mandatory to specify a Feed (e.g., Feed.RealTime) and a Market (e.g., Market.Stocks).
  • Subscription definitions have been updated as well. To subscribe to data, you must use the new PolygonWebSocketSubscription format, like so: PolygonWebSocketSubscription(PolygonWebSocketChannel.Stocks.AggPerMinute, "*").

Why This Change?
This update brings clarity to what you're subscribing to and we greatly improved the message parsing logic, ensuring a robust foundation for integrating upcoming products with ease.

What's Changed

Full Changelog: v4.6.0...v5.0.0