forked from massive-com/client-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindicators.py
More file actions
239 lines (221 loc) · 12.3 KB
/
indicators.py
File metadata and controls
239 lines (221 loc) · 12.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
from polygon.rest.models.common import SeriesType
from polygon.rest.models.indicators import (
SMAIndicatorResults,
EMAIndicatorResults,
RSIIndicatorResults,
MACDIndicatorResults,
)
from .base import BaseClient
from typing import Optional, Any, Dict, List, Union
from .models import Order
from urllib3 import HTTPResponse
from datetime import datetime, date
from .models.request import RequestOptionBuilder
class IndicatorsClient(BaseClient):
def get_sma(
self,
ticker: str,
timestamp: Optional[Union[str, int, datetime, date]] = None,
timestamp_lt: Optional[Union[str, int, datetime, date]] = None,
timestamp_lte: Optional[Union[str, int, datetime, date]] = None,
timestamp_gt: Optional[Union[str, int, datetime, date]] = None,
timestamp_gte: Optional[Union[str, int, datetime, date]] = None,
timespan: Optional[str] = None,
window: Optional[int] = None,
adjusted: Optional[bool] = None,
expand_underlying: Optional[bool] = None,
order: Optional[Union[str, Order]] = None,
limit: Optional[int] = None,
params: Optional[Dict[str, Any]] = None,
series_type: Optional[Union[str, SeriesType]] = None,
raw: bool = False,
options: Optional[RequestOptionBuilder] = None,
) -> Union[SMAIndicatorResults, HTTPResponse]:
"""
Get SMA values for a given ticker over a given range with the specified parameters
:param ticker: The ticker symbol
:param timespan: The size of the underlying aggregate time window
:param window: The window size used to calculate the simple moving average. i.e. a window size of 10 with daily
aggregates would result in a 10-day moving average
:param timestamp: Either a date with the format YYYY-MM-DD or a millisecond timestamp.
:param timestamp_lt: Timestamp less than
:param timestamp_lte: Timestamp less than or equal to
:param timestamp_gt: Timestamp greater than
:param timestamp_gte: Timestamp greater than or equal to
:param adjusted: Whether the underlying aggregates are adjusted for splits. By default, the aggregates used to
calculate this indicator are adjusted. Set this as false to get results that are NOT adjusted for splits
:param expand_underlying: Whether to include the aggregates used to calculate this indicator in the response
:param order: Sort the results by timestamp. asc will return results in ascending order (oldest at the top),
desc will return results in descending order (newest at the top).The end of the aggregate time window
:param limit: Limit the number of results returned, default is 10 and max is 5000
:param params: Any additional query params
:param series_type: The price in the aggregate which will be used to calculate the simple moving average
i.e. 'close' will result in using close prices to calculate the simple moving average
:param raw: Return raw object instead of results object
:return: SingleIndicatorResults
"""
url = f"/v1/indicators/sma/{ticker}"
return self._get(
path=url,
params=self._get_params(self.get_sma, locals()),
result_key="results",
deserializer=SMAIndicatorResults.from_dict,
raw=raw,
options=options,
)
def get_ema(
self,
ticker: str,
timestamp: Optional[Union[str, int, datetime, date]] = None,
timestamp_lt: Optional[Union[str, int, datetime, date]] = None,
timestamp_lte: Optional[Union[str, int, datetime, date]] = None,
timestamp_gt: Optional[Union[str, int, datetime, date]] = None,
timestamp_gte: Optional[Union[str, int, datetime, date]] = None,
timespan: Optional[str] = None,
window: Optional[int] = None,
adjusted: Optional[bool] = None,
expand_underlying: Optional[bool] = None,
order: Optional[Union[str, Order]] = None,
limit: Optional[int] = None,
params: Optional[Dict[str, Any]] = None,
series_type: Optional[Union[str, SeriesType]] = None,
raw: bool = False,
options: Optional[RequestOptionBuilder] = None,
) -> Union[EMAIndicatorResults, HTTPResponse]:
"""
Get EMA values for a given ticker over a given range with the specified parameters
:param ticker: The ticker symbol
:param timespan: The size of the underlying aggregate time window
:param window: The window size used to calculate the exponential moving average. i.e. a window size of 10 with daily
aggregates would result in a 10-day moving average
:param timestamp: Either a date with the format YYYY-MM-DD or a millisecond timestamp.
:param timestamp_lt: Timestamp less than
:param timestamp_lte: Timestamp less than or equal to
:param timestamp_gt: Timestamp greater than
:param timestamp_gte: Timestamp greater than or equal to
:param adjusted: Whether the underlying aggregates are adjusted for splits. By default, the aggregates used to
calculate this indicator are adjusted. Set this as false to get results that are NOT adjusted for splits
:param expand_underlying: Whether to include the aggregates used to calculate this indicator in the response
:param order: Sort the results by timestamp. asc will return results in ascending order (oldest at the top),
desc will return results in descending order (newest at the top).The end of the aggregate time window
:param limit: Limit the number of results returned, default is 10 and max is 5000
:param params: Any additional query params
:param series_type: The price in the aggregate which will be used to calculate the simple moving average
i.e. 'close' will result in using close prices to calculate the simple moving average
:param raw: Return raw object instead of results object
:return: SingleIndicatorResults
"""
url = f"/v1/indicators/ema/{ticker}"
return self._get(
path=url,
params=self._get_params(self.get_ema, locals()),
result_key="results",
deserializer=EMAIndicatorResults.from_dict,
raw=raw,
options=options,
)
def get_rsi(
self,
ticker: str,
timestamp: Optional[Union[str, int, datetime, date]] = None,
timestamp_lt: Optional[Union[str, int, datetime, date]] = None,
timestamp_lte: Optional[Union[str, int, datetime, date]] = None,
timestamp_gt: Optional[Union[str, int, datetime, date]] = None,
timestamp_gte: Optional[Union[str, int, datetime, date]] = None,
timespan: Optional[str] = None,
window: Optional[int] = None,
adjusted: Optional[bool] = None,
expand_underlying: Optional[bool] = None,
order: Optional[Union[str, Order]] = None,
limit: Optional[int] = None,
params: Optional[Dict[str, Any]] = None,
series_type: Optional[Union[str, SeriesType]] = None,
raw: bool = False,
options: Optional[RequestOptionBuilder] = None,
) -> Union[RSIIndicatorResults, HTTPResponse]:
"""
Get RSI values for a given ticker over a given range with the specified parameters
:param ticker: The ticker symbol
:param timespan: The size of the underlying aggregate time window
:param window: The window size used to calculate the simple moving average. i.e. a window size of 10 with daily
aggregates would result in a 10-day moving average
:param timestamp: Either a date with the format YYYY-MM-DD or a millisecond timestamp.
:param timestamp_lt: Timestamp less than
:param timestamp_lte: Timestamp less than or equal to
:param timestamp_gt: Timestamp greater than
:param timestamp_gte: Timestamp greater than or equal to
:param adjusted: Whether the underlying aggregates are adjusted for splits. By default, the aggregates used to
calculate this indicator are adjusted. Set this as false to get results that are NOT adjusted for splits
:param expand_underlying: Whether to include the aggregates used to calculate this indicator in the response
:param order: Sort the results by timestamp. asc will return results in ascending order (oldest at the top),
desc will return results in descending order (newest at the top).The end of the aggregate time window
:param limit: Limit the number of results returned, default is 10 and max is 5000
:param params: Any additional query params
:param series_type: The price in the aggregate which will be used to calculate the simple moving average
i.e. 'close' will result in using close prices to calculate the simple moving average
:param raw: Return raw object instead of results object
:return: SingleIndicatorResults
"""
url = f"/v1/indicators/rsi/{ticker}"
return self._get(
path=url,
params=self._get_params(self.get_rsi, locals()),
result_key="results",
deserializer=RSIIndicatorResults.from_dict,
raw=raw,
options=options,
)
def get_macd(
self,
ticker: str,
timestamp: Optional[Union[str, int, datetime, date]] = None,
timestamp_lt: Optional[Union[str, int, datetime, date]] = None,
timestamp_lte: Optional[Union[str, int, datetime, date]] = None,
timestamp_gt: Optional[Union[str, int, datetime, date]] = None,
timestamp_gte: Optional[Union[str, int, datetime, date]] = None,
timespan: Optional[str] = None,
short_window: Optional[int] = None,
long_window: Optional[int] = None,
signal_window: Optional[int] = None,
adjusted: Optional[bool] = None,
expand_underlying: Optional[bool] = None,
order: Optional[Union[str, Order]] = None,
limit: Optional[int] = None,
params: Optional[Dict[str, Any]] = None,
series_type: Optional[Union[str, SeriesType]] = None,
raw: bool = False,
options: Optional[RequestOptionBuilder] = None,
) -> Union[MACDIndicatorResults, HTTPResponse]:
"""
Get MACD values for a given ticker over a given range with the specified parameters
:param ticker: The ticker symbol
:param timespan: The size of the underlying aggregate time window
:param short_window: The short window size used to calculate the MACD data
:param long_window: The long window size used to calculate the MACD data
:param signal_window: The window size used to calculate the MACD signal line
:param timestamp: Either a date with the format YYYY-MM-DD or a millisecond timestamp.
:param timestamp_lt: Timestamp less than
:param timestamp_lte: Timestamp less than or equal to
:param timestamp_gt: Timestamp greater than
:param timestamp_gte: Timestamp greater than or equal to
:param adjusted: Whether the underlying aggregates are adjusted for splits. By default, the aggregates used to
calculate this indicator are adjusted. Set this as false to get results that are NOT adjusted for splits
:param expand_underlying: Whether to include the aggregates used to calculate this indicator in the response
:param order: Sort the results by timestamp. asc will return results in ascending order (oldest at the top),
desc will return results in descending order (newest at the top).The end of the aggregate time window
:param limit: Limit the number of results returned, default is 10 and max is 5000
:param params: Any additional query params
:param series_type: The price in the aggregate which will be used to calculate the simple moving average
i.e. 'close' will result in using close prices to calculate the simple moving average
:param raw: Return raw object instead of results object
:return: MACDIndicatorResults
"""
url = f"/v1/indicators/macd/{ticker}"
return self._get(
path=url,
params=self._get_params(self.get_macd, locals()),
result_key="results",
deserializer=MACDIndicatorResults.from_dict,
raw=raw,
options=options,
)