Skip to content

Commit d4eb12e

Browse files
author
Shlomi Kushchi
authored
Merge pull request #261 from alpacahq/readme-update-streamconn-data-stream
Explain how to use the StreamConn with polygon ws
2 parents 87ec075 + 8ac9d1e commit d4eb12e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,10 @@ is raised. This module itself does not provide any threading
200200
capability, so if you need to consume the messages pushed from the
201201
server, you need to run it in a background thread.
202202

203+
We provide 2 price data websockets. The polygon data, and the alpaca data.
204+
We default to Alpaca data, and one must explicitly specify the polygon data stream in order to use that.
205+
It is done by passing the `data_stream` keyword to the `__init__()` function of `StreamConn` (options: `'alpacadatav1', 'polygon'`)
206+
203207
This class provides a unique interface to the two interfaces, both
204208
Alpaca's account/trade updates events and Polygon's price updates.
205209
One connection is established when the `subscribe()` is called with

0 commit comments

Comments
 (0)