thetadata 1.0.2__tar.gz → 1.0.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: thetadata
3
- Version: 1.0.2
3
+ Version: 1.0.4
4
4
  Summary: Python client library for ThetaData market data APIs
5
5
  Project-URL: Homepage, https://www.thetadata.net
6
6
  Project-URL: Repository, https://github.com/AXIOMXLLC/python_library
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "thetadata"
3
- version = "1.0.2"
3
+ version = "1.0.4"
4
4
  description = "Python client library for ThetaData market data APIs"
5
5
  readme = "README.md"
6
6
  license = "Apache-2.0"
@@ -26,6 +26,11 @@ def _fmt_time(time:Union[datetime.time|str]) -> str:
26
26
  ms = time.microsecond // 1000
27
27
  return time.strftime("%H:%M:%S") + f".{ms:03d}"
28
28
 
29
+ def _fmt_if_date(date:Union[datetime.date, str]) -> str:
30
+ if isinstance(date, str):
31
+ return date
32
+ return date.strftime('%Y-%m-%d')
33
+
29
34
  PRICE_TYPE_FACTORS = [
30
35
  0.0,
31
36
  0.000000001,
@@ -114,10 +119,8 @@ class ThetaClient:
114
119
  channel = grpc.secure_channel(grpc_target, grpc.ssl_channel_credentials())
115
120
  self.stub = endpoints_pb2_grpc.BetaThetaTerminalStub(channel)
116
121
 
117
- # create a reusable decompressor; not thread-safe!
118
- self.decompressor = zstandard.ZstdDecompressor()
119
-
120
122
  def _convert_response_stream(self, response_stream: List[endpoints_pb2.ResponseData]) -> Dict[str, List[Any]]:
123
+ decompressor = zstandard.ZstdDecompressor()
121
124
  ret = defaultdict(list)
122
125
  timestamp_columns = set()
123
126
 
@@ -125,7 +128,7 @@ class ThetaClient:
125
128
  response: endpoints_pb2.ResponseData = response
126
129
 
127
130
  if response.compression_description.algo == CompressionAlgo.ZSTD:
128
- decompressed_data = self.decompressor.decompress(response.compressed_data)
131
+ decompressed_data = decompressor.decompress(response.compressed_data)
129
132
  data_table = DataTable()
130
133
  data_table.ParseFromString(decompressed_data)
131
134
  elif response.compression_description.algo == CompressionAlgo.NONE:
@@ -625,9 +628,9 @@ This endpoint is updated real-time.
625
628
  - You might need to change the default expiration date to a different date if it is past the current date.
626
629
 
627
630
  """
628
- def option_snapshot_ohlc(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
631
+ def option_snapshot_ohlc(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
629
632
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
630
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
633
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
631
634
  query = endpoints_pb2.OptionSnapshotOhlcRequestQuery(contract_spec=contract_spec)
632
635
  if max_dte:
633
636
  query.max_dte = max_dte
@@ -676,9 +679,9 @@ This endpoint is updated real-time.
676
679
  - This endpoint will return no data if the market was closed for the day. Theta Data resets the snapshot cache at midnight ET every night.
677
680
 
678
681
  """
679
- def option_snapshot_quote(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
682
+ def option_snapshot_quote(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
680
683
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
681
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
684
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
682
685
  query = endpoints_pb2.OptionSnapshotQuoteRequestQuery(contract_spec=contract_spec)
683
686
  if max_dte:
684
687
  query.max_dte = max_dte
@@ -703,9 +706,9 @@ This endpoint is updated real-time.
703
706
  - This endpoint will return no data if the market was closed for the day. Theta Data resets the snapshot cache at midnight ET every night.
704
707
 
705
708
  """
706
- def option_snapshot_open_interest(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
709
+ def option_snapshot_open_interest(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
707
710
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
708
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
711
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
709
712
  query = endpoints_pb2.OptionSnapshotOpenInterestRequestQuery(contract_spec=contract_spec)
710
713
  if max_dte:
711
714
  query.max_dte = max_dte
@@ -727,9 +730,9 @@ This endpoint is updated real-time.
727
730
  """* Returns a real-time market value derived from the last NBBO quote of an option contract.
728
731
 
729
732
  """
730
- def option_snapshot_market_value(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
733
+ def option_snapshot_market_value(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None):
731
734
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
732
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
735
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
733
736
  query = endpoints_pb2.OptionSnapshotMarketValueRequestQuery(contract_spec=contract_spec)
734
737
  if max_dte:
735
738
  query.max_dte = max_dte
@@ -754,9 +757,9 @@ of the option respectively. The underlying price represents whatever the last un
754
757
  [here](/Articles/Data-And-Requests/Option-Greeks.html).
755
758
 
756
759
  """
757
- def option_snapshot_greeks_implied_volatility(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
760
+ def option_snapshot_greeks_implied_volatility(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
758
761
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
759
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
762
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
760
763
  query = endpoints_pb2.OptionSnapshotGreeksImpliedVolatilityRequestQuery(contract_spec=contract_spec)
761
764
  if annual_dividend:
762
765
  query.annual_dividend = annual_dividend
@@ -793,9 +796,9 @@ of the option respectively. The underlying price represents whatever the last un
793
796
  > This endpoint will return no data if the market was closed for the day. Theta Data resets the snapshot cache at midnight ET every night.
794
797
 
795
798
  """
796
- def option_snapshot_greeks_all(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
799
+ def option_snapshot_greeks_all(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
797
800
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
798
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
801
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
799
802
  query = endpoints_pb2.OptionSnapshotGreeksAllRequestQuery(contract_spec=contract_spec)
800
803
  if annual_dividend:
801
804
  query.annual_dividend = annual_dividend
@@ -832,9 +835,9 @@ of the option respectively. The underlying price represents whatever the last un
832
835
  > This endpoint will return no data if the market was closed for the day. Theta Data resets the snapshot cache at midnight ET every night.
833
836
 
834
837
  """
835
- def option_snapshot_greeks_first_order(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
838
+ def option_snapshot_greeks_first_order(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
836
839
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
837
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
840
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
838
841
  query = endpoints_pb2.OptionSnapshotGreeksFirstOrderRequestQuery(contract_spec=contract_spec)
839
842
  if annual_dividend:
840
843
  query.annual_dividend = annual_dividend
@@ -871,9 +874,9 @@ of the option respectively. The underlying price represents whatever the last un
871
874
  > This endpoint will return no data if the market was closed for the day. Theta Data resets the snapshot cache at midnight ET every night.
872
875
 
873
876
  """
874
- def option_snapshot_greeks_second_order(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
877
+ def option_snapshot_greeks_second_order(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
875
878
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
876
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
879
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
877
880
  query = endpoints_pb2.OptionSnapshotGreeksSecondOrderRequestQuery(contract_spec=contract_spec)
878
881
  if annual_dividend:
879
882
  query.annual_dividend = annual_dividend
@@ -910,9 +913,9 @@ of the option respectively. The underlying price represents whatever the last un
910
913
  > This endpoint will return no data if the market was closed for the day. Theta Data resets the snapshot cache at midnight ET every night.
911
914
 
912
915
  """
913
- def option_snapshot_greeks_third_order(self, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
916
+ def option_snapshot_greeks_third_order(self, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, stock_price:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, min_time:Optional[datetime.time]=None, use_market_value:Optional[bool]=False):
914
917
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
915
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
918
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
916
919
  query = endpoints_pb2.OptionSnapshotGreeksThirdOrderRequestQuery(contract_spec=contract_spec)
917
920
  if annual_dividend:
918
921
  query.annual_dividend = annual_dividend
@@ -949,9 +952,9 @@ of the option respectively. The underlying price represents whatever the last un
949
952
  - You can read more about EOD & OHLC data [here](/Articles/Data-And-Requests/OHLC-EOD.html).
950
953
 
951
954
  """
952
- def option_history_eod(self, start_date:datetime.date, end_date:datetime.date, symbol:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None):
955
+ def option_history_eod(self, start_date:datetime.date, end_date:datetime.date, symbol:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None):
953
956
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
954
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
957
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
955
958
  query = endpoints_pb2.OptionHistoryEodRequestQuery(contract_spec=contract_spec)
956
959
  query.start_date = start_date.strftime('%Y-%m-%d')
957
960
  query.end_date = end_date.strftime('%Y-%m-%d')
@@ -1009,9 +1012,9 @@ of the option respectively. The underlying price represents whatever the last un
1009
1012
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1010
1013
 
1011
1014
  """
1012
- def option_history_trade(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1015
+ def option_history_trade(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1013
1016
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1014
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1017
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1015
1018
  query = endpoints_pb2.OptionHistoryTradeRequestQuery(contract_spec=contract_spec)
1016
1019
  if date:
1017
1020
  query.date = date.strftime('%Y-%m-%d')
@@ -1043,9 +1046,9 @@ of the option respectively. The underlying price represents whatever the last un
1043
1046
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1044
1047
 
1045
1048
  """
1046
- def option_history_quote(self, symbol:str, expiration:datetime.date, interval:str='1s', date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1049
+ def option_history_quote(self, symbol:str, expiration:Union[datetime.date, str], interval:str='1s', date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1047
1050
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1048
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1051
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1049
1052
  query = endpoints_pb2.OptionHistoryQuoteRequestQuery(contract_spec=contract_spec)
1050
1053
  query.interval = interval
1051
1054
  if date:
@@ -1079,9 +1082,9 @@ of the option respectively. The underlying price represents whatever the last un
1079
1082
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1080
1083
 
1081
1084
  """
1082
- def option_history_trade_quote(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), exclusive:Optional[bool]=False, max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1085
+ def option_history_trade_quote(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), exclusive:Optional[bool]=False, max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1083
1086
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1084
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1087
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1085
1088
  query = endpoints_pb2.OptionHistoryTradeQuoteRequestQuery(contract_spec=contract_spec)
1086
1089
  if date:
1087
1090
  query.date = date.strftime('%Y-%m-%d')
@@ -1115,9 +1118,9 @@ of the option respectively. The underlying price represents whatever the last un
1115
1118
  - The reported open interest represents the open interest at the end of the previous trading day.
1116
1119
 
1117
1120
  """
1118
- def option_history_open_interest(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1121
+ def option_history_open_interest(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1119
1122
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1120
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1123
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1121
1124
  query = endpoints_pb2.OptionHistoryOpenInterestRequestQuery(contract_spec=contract_spec)
1122
1125
  if date:
1123
1126
  query.date = date.strftime('%Y-%m-%d')
@@ -1145,9 +1148,9 @@ of the option respectively. The underlying price represents whatever the last un
1145
1148
  - **Set `expiration` to ``*`` if you want to retrieve data for every option that shares the same ``symbol``. (note: Any ``expiration=*`` must be requested day by day)**
1146
1149
 
1147
1150
  """
1148
- def option_history_greeks_eod(self, symbol:str, expiration:datetime.date, start_date:datetime.date, end_date:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', underlyer_use_nbbo:Optional[bool]=False, max_dte:Optional[int]=None, strike_range:Optional[int]=None):
1151
+ def option_history_greeks_eod(self, symbol:str, expiration:Union[datetime.date, str], start_date:datetime.date, end_date:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', underlyer_use_nbbo:Optional[bool]=False, max_dte:Optional[int]=None, strike_range:Optional[int]=None):
1149
1152
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1150
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1153
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1151
1154
  query = endpoints_pb2.OptionHistoryGreeksEodRequestQuery(contract_spec=contract_spec)
1152
1155
  query.start_date = start_date.strftime('%Y-%m-%d')
1153
1156
  query.end_date = end_date.strftime('%Y-%m-%d')
@@ -1224,9 +1227,9 @@ of the option respectively. The underlying price represents whatever the last un
1224
1227
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1225
1228
 
1226
1229
  """
1227
- def option_history_trade_greeks_all(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1230
+ def option_history_trade_greeks_all(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1228
1231
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1229
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1232
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1230
1233
  query = endpoints_pb2.OptionHistoryTradeGreeksAllRequestQuery(contract_spec=contract_spec)
1231
1234
  if date:
1232
1235
  query.date = date.strftime('%Y-%m-%d')
@@ -1309,9 +1312,9 @@ of the option respectively. The underlying price represents whatever the last un
1309
1312
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1310
1313
 
1311
1314
  """
1312
- def option_history_trade_greeks_first_order(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1315
+ def option_history_trade_greeks_first_order(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1313
1316
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1314
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1317
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1315
1318
  query = endpoints_pb2.OptionHistoryTradeGreeksFirstOrderRequestQuery(contract_spec=contract_spec)
1316
1319
  if date:
1317
1320
  query.date = date.strftime('%Y-%m-%d')
@@ -1394,9 +1397,9 @@ of the option respectively. The underlying price represents whatever the last un
1394
1397
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1395
1398
 
1396
1399
  """
1397
- def option_history_trade_greeks_second_order(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1400
+ def option_history_trade_greeks_second_order(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1398
1401
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1399
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1402
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1400
1403
  query = endpoints_pb2.OptionHistoryTradeGreeksSecondOrderRequestQuery(contract_spec=contract_spec)
1401
1404
  if date:
1402
1405
  query.date = date.strftime('%Y-%m-%d')
@@ -1479,9 +1482,9 @@ of the option respectively. The underlying price represents whatever the last un
1479
1482
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1480
1483
 
1481
1484
  """
1482
- def option_history_trade_greeks_third_order(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1485
+ def option_history_trade_greeks_third_order(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1483
1486
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1484
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1487
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1485
1488
  query = endpoints_pb2.OptionHistoryTradeGreeksThirdOrderRequestQuery(contract_spec=contract_spec)
1486
1489
  if date:
1487
1490
  query.date = date.strftime('%Y-%m-%d')
@@ -1562,9 +1565,9 @@ of the option respectively. The underlying price represents whatever the last un
1562
1565
  - Multi-day requests are limited to 1 month of data, and must specify an expiration.
1563
1566
 
1564
1567
  """
1565
- def option_history_trade_greeks_implied_volatility(self, symbol:str, expiration:datetime.date, date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1568
+ def option_history_trade_greeks_implied_volatility(self, symbol:str, expiration:Union[datetime.date, str], date:Optional[datetime.date]=None, strike:Optional[str]='*', right:Optional[str]='both', start_time:Optional[datetime.time]=_fmt_time('09:30:00'), end_time:Optional[datetime.time]=_fmt_time('16:00:00'), annual_dividend:Optional[float]=None, rate_type:Optional[str]='sofr', rate_value:Optional[float]=None, version:Optional[str]='latest', max_dte:Optional[int]=None, strike_range:Optional[int]=None, start_date:Optional[datetime.date]=None, end_date:Optional[datetime.date]=None):
1566
1569
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1567
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1570
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1568
1571
  query = endpoints_pb2.OptionHistoryTradeGreeksImpliedVolatilityRequestQuery(contract_spec=contract_spec)
1569
1572
  if date:
1570
1573
  query.date = date.strftime('%Y-%m-%d')
@@ -1605,9 +1608,9 @@ of the option respectively. The underlying price represents whatever the last un
1605
1608
  - The ``time_of_day``parameter represents the 00:00:00.000 ET that the trade should be provided for.
1606
1609
 
1607
1610
  """
1608
- def option_at_time_trade(self, symbol:str, start_date:datetime.date, end_date:datetime.date, time_of_day:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None):
1611
+ def option_at_time_trade(self, symbol:str, start_date:datetime.date, end_date:datetime.date, time_of_day:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None):
1609
1612
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1610
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1613
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1611
1614
  query = endpoints_pb2.OptionAtTimeTradeRequestQuery(contract_spec=contract_spec)
1612
1615
  query.start_date = start_date.strftime('%Y-%m-%d')
1613
1616
  query.end_date = end_date.strftime('%Y-%m-%d')
@@ -1631,9 +1634,9 @@ of the option respectively. The underlying price represents whatever the last un
1631
1634
  - The ``time_of_day``parameter represents the 00:00:00.000 ET that the quote should be provided for.
1632
1635
 
1633
1636
  """
1634
- def option_at_time_quote(self, symbol:str, start_date:datetime.date, end_date:datetime.date, time_of_day:str, expiration:datetime.date, strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None):
1637
+ def option_at_time_quote(self, symbol:str, start_date:datetime.date, end_date:datetime.date, time_of_day:str, expiration:Union[datetime.date, str], strike:Optional[str]='*', right:Optional[str]='both', max_dte:Optional[int]=None, strike_range:Optional[int]=None):
1635
1638
  query_info = endpoints_pb2.QueryInfo(auth_token=self.auth_token)
1636
- contract_spec = ContractSpec(symbol=symbol, expiration=expiration.strftime('%Y-%m-%d'), strike=strike, right=right)
1639
+ contract_spec = ContractSpec(symbol=symbol, expiration=_fmt_if_date(expiration), strike=strike, right=right)
1637
1640
  query = endpoints_pb2.OptionAtTimeQuoteRequestQuery(contract_spec=contract_spec)
1638
1641
  query.start_date = start_date.strftime('%Y-%m-%d')
1639
1642
  query.end_date = end_date.strftime('%Y-%m-%d')
File without changes
File without changes
File without changes