Skip to content

Commit 9489fe9

Browse files
committed
DOC: Correct use of end for reference API
1 parent 4615319 commit 9489fe9

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

databento/reference/api/adjustment.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ def get_range(
5050
Parameters
5151
----------
5252
start : pd.Timestamp, datetime, date, str, or int
53-
The start datetime of the request time range (inclusive) based on `ex_date`.
53+
The inclusive start of the request time range based on `ex_date`.
5454
Assumes UTC as timezone unless passed a tz-aware object.
5555
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
5656
end : pd.Timestamp, datetime, date, str, or int, optional
57-
The end datetime of the request time range (exclusive) based on `ex_date`.
57+
The exclusive end of the request time range based on `ex_date`.
5858
Assumes UTC as timezone unless passed a tz-aware object.
5959
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
60-
Defaults to the forward filled value of `start` based on the resolution provided.
60+
If `None`, then will return **all** data available after `start`.
6161
symbols : Iterable[str] or str, optional
6262
The symbols to filter for. Takes up to 2,000 symbols per request.
6363
If more than 1 symbol is specified, the data is merged and sorted by time.

databento/reference/api/corporate.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,14 @@ def get_range(
5555
Parameters
5656
----------
5757
start : pd.Timestamp, datetime, date, str, or int
58-
The start datetime of the request time range (inclusive) based on `index`.
58+
The inclusive start of the request range based on `index`.
5959
Assumes UTC as timezone unless passed a tz-aware object.
6060
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
6161
end : pd.Timestamp, datetime, date, str, or int, optional
62-
The end datetime of the request time range (exclusive) based on `index`.
62+
The exclusive end of the request range based on `index`.
6363
Assumes UTC as timezone unless passed a tz-aware object.
6464
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
65-
Defaults to the forward filled value of `start` based on the resolution provided.
65+
If `None`, then will return **all** data available after `start`.
6666
index : str, default 'event_date'
6767
The index column used for filtering the `start` and `end` time range
6868
and for record ordering.

databento/reference/api/security.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ def get_range(
5151
Parameters
5252
----------
5353
start : pd.Timestamp, datetime, date, str, or int
54-
The start datetime of the request time range (inclusive) based on `index`.
54+
The inclusive start datetime of the request range based on `index`.
5555
Assumes UTC as timezone unless passed a tz-aware object.
5656
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
5757
end : pd.Timestamp, datetime, date, str, or int, optional
58-
The end datetime of the request time range (exclusive) based on `index`.
58+
The exclusive end of the request range based on `index`.
5959
Assumes UTC as timezone unless passed a tz-aware object.
6060
If an integer is passed, then this represents nanoseconds since the UNIX epoch.
61-
Defaults to the forward filled value of `start` based on the resolution provided.
61+
If `None`, then will return **all** data available after `start`.
6262
index : str, default 'ts_effective'
6363
The index column used for filtering the `start` and `end` time range
6464
and for record ordering.

0 commit comments

Comments
 (0)