diff options
Diffstat (limited to 'openbb_platform/openbb/package/equity_price.py')
| -rw-r--r-- | openbb_platform/openbb/package/equity_price.py | 45 |
1 files changed, 9 insertions, 36 deletions
diff --git a/openbb_platform/openbb/package/equity_price.py b/openbb_platform/openbb/package/equity_price.py index 5e83ca0c9cd..52e106d9081 100644 --- a/openbb_platform/openbb/package/equity_price.py +++ b/openbb_platform/openbb/package/equity_price.py @@ -231,27 +231,13 @@ class ROUTER_equity_price(Container): date : Optional[datetime.date] A specific date to get data for. Use bracketed the timestamp parameters to specify exact time ranges. (provider: polygon) timestamp_lt : Optional[Union[datetime.datetime, str]] - - Query by datetime, less than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, - YYYY-MM-DDTH:M:S.000000000-04:00". Include all nanoseconds and the 'T' between the day and hour. - (provider: polygon) + Query by datetime, less than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon) timestamp_gt : Optional[Union[datetime.datetime, str]] - - Query by datetime, greater than. Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, - YYYY-MM-DDTH:M:S.000000000-04:00". Include all nanoseconds and the 'T' between the day and hour. - (provider: polygon) + Query by datetime, greater than. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon) timestamp_lte : Optional[Union[datetime.datetime, str]] - - Query by datetime, less than or equal to. - Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, - YYYY-MM-DDTH:M:S.000000000-04:00". Include all nanoseconds and the 'T' between the day and hour. - (provider: polygon) + Query by datetime, less than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon) timestamp_gte : Optional[Union[datetime.datetime, str]] - - Query by datetime, greater than or equal to. - Either a date with the format YYYY-MM-DD or a TZ-aware timestamp string, - YYYY-MM-DDTH:M:S.000000000-04:00". Include all nanoseconds and the 'T' between the day and hour. - (provider: polygon) + Query by datetime, greater than or equal to. Either a date with the format 'YYYY-MM-DD' or a TZ-aware timestamp string, 'YYYY-MM-DDTH:M:S.000000000-04:00'. Include all nanoseconds and the 'T' between the day and hour. (provider: polygon) Returns ------- @@ -292,26 +278,13 @@ class ROUTER_equity_price(Container): indicators : Optional[List[int]] A list of indicator codes. (provider: polygon) sequence_num : Optional[int] - - The sequence number represents the sequence in which message events happened. - These are increasing and unique per ticker symbol, but will not always be sequential - (e.g., 1, 2, 6, 9, 10, 11) - (provider: polygon) + The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11) (provider: polygon) participant_timestamp : Optional[datetime] - - The nanosecond accuracy Participant/Exchange Unix Timestamp. - This is the timestamp of when the quote was actually generated at the exchange. - (provider: polygon) + The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange. (provider: polygon) sip_timestamp : Optional[datetime] - - The nanosecond accuracy SIP Unix Timestamp. - This is the timestamp of when the SIP received this quote from the exchange which produced it. - (provider: polygon) + The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it. (provider: polygon) trf_timestamp : Optional[datetime] - - The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. - This is the timestamp of when the trade reporting facility received this quote. - (provider: polygon) + The nanosecond accuracy TRF (Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this quote. (provider: polygon) Examples -------- @@ -571,7 +544,7 @@ class ROUTER_equity_price(Container): Source of the Intrinio data. (provider: intrinio) updated_on : Optional[datetime] Date and Time when the data was last updated. (provider: intrinio) - security : Optional[openbb_intrinio.utils.references.IntrinioSecurity] + security : Optional[IntrinioSecurity] Security details related to the quote. (provider: intrinio) ma_50d : Optional[float] 50-day moving average price. (provider: yfinance) |