Skip to content

Commit ac05a37

Browse files
committed
DOC: Add timeseries.stream_async to Python client
1 parent 33c3712 commit ac05a37

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

databento/historical/api/timeseries.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ def stream(
3636
3737
Makes a `GET /timeseries.stream` HTTP request.
3838
39+
Primary method for getting historical intraday market data, daily data,
40+
instrument definitions and market status data directly into your application.
41+
42+
This method only returns after all of the data has been downloaded,
43+
which can take a long time. For large requests, consider using a batch download.
44+
3945
Parameters
4046
----------
4147
dataset : Dataset or str
@@ -128,6 +134,12 @@ async def stream_async(
128134
129135
Makes a `GET /timeseries.stream` HTTP request.
130136
137+
Primary method for getting historical intraday market data, daily data,
138+
instrument definitions and market status data directly into your application.
139+
140+
This coroutine will complete once all of the data has been downloaded,
141+
which can take a long time. For large requests, consider using a batch download.
142+
131143
Parameters
132144
----------
133145
dataset : Dataset or str

0 commit comments

Comments
 (0)