Skip to content

Commit 143af1b

Browse files
ADD: Adding public docs for live snapshot
1 parent 5b83032 commit 143af1b

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

databento/live/client.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,9 @@ def subscribe(
415415
start : str or int, optional
416416
UNIX nanosecond epoch timestamp to start streaming from (inclusive), based on `ts_event`. Must be within 24 hours except when requesting the mbo or definition schemas.
417417
snapshot: bool, default to 'False'
418-
Reserved for future use.
418+
Request subscription with snapshot. The `start` parameter must be `None`.
419+
420+
419421
420422
Raises
421423
------

databento/live/protocol.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ def subscribe(
278278
UNIX nanosecond epoch timestamp to start streaming from. Must be
279279
within 24 hours.
280280
snapshot: bool, default to 'False'
281-
Reserved for future use.
281+
Request subscription with snapshot. The `start` parameter must be `None`.
282282
283283
"""
284284
logger.info(

databento/live/session.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ def subscribe(
452452
UNIX nanosecond epoch timestamp to start streaming from. Must be
453453
within 24 hours.
454454
snapshot: bool, default to 'False'
455-
Reserved for future use.
455+
Request subscription with snapshot. The `start` parameter must be `None`.
456456
457457
"""
458458
with self._lock:

0 commit comments

Comments
 (0)