Skip to content

Commit

Permalink
Update quotes.py docstring (#532)
Browse files Browse the repository at this point in the history
* Update quotes.py docstring

* Terminology fix - timeframe should be time intervals for Bars, time period should be the start and end times for which Bars are accumulated
  • Loading branch information
kushalj1997 authored Dec 3, 2024
1 parent c564495 commit 5e21148
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions alpaca/data/models/quotes.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ class Quote(BaseModel):
timestamp (datetime): The time of submission of the quote.
bid_price (float): The bidding price of the quote.
bid_size (float): The size of the quote bid.
bid_exchange (Optional[str, Exchange]): The exchange the quote bid originates. Defaults to None.
bid_exchange (Optional[Union[str, Exchange]]): The exchange the quote bid originates. Defaults to None.
ask_price (float): The asking price of the quote.
ask_size (float): The size of the quote ask.
ask_exchange (Optional[str, Exchange]): The exchange the quote ask originates. Defaults to None.
ask_exchange (Optional[Union[str, Exchange]]): The exchange the quote ask originates. Defaults to None.
conditions (Optional[Union[List[str], str]]): The quote conditions. Defaults to None.
tape (Optional[str]): The quote tape. Defaults to None.
"""
Expand Down
6 changes: 3 additions & 3 deletions alpaca/data/requests.py
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ class OptionBarsRequest(BaseBarsRequest):
Attributes:
symbol_or_symbols (Union[str, List[str]]): The ticker identifier or list of ticker identifiers.
timeframe (TimeFrame): The period over which the bars should be aggregated. (i.e. 5 Min bars, 1 Day bars)
start (Optional[datetime]): The beginning of the time interval for desired data. Timezone naive inputs assumed to be in UTC.
end (Optional[datetime]): The end of the time interval for desired data. Defaults to now. Timezone naive inputs assumed to be in UTC.
timeframe (TimeFrame): The length of time (also known as time interval) for which each Bar represents (i.e. 5 Min bars, 1 Day bars).
start (Optional[datetime]): The beginning of the time period for desired data. Timezone naive inputs assumed to be in UTC.
end (Optional[datetime]): The end of the time period for desired data. Defaults to now. Timezone naive inputs assumed to be in UTC.
limit (Optional[int]): Upper limit of number of data points to return. Defaults to None.
sort (Optional[Sort]): The chronological order of response based on the timestamp. Defaults to ASC.
"""
Expand Down

0 comments on commit 5e21148

Please sign in to comment.