Skip to content

Commit b140f1f

Browse files
Darcy-Lindeclickingbuttons
authored and
clickingbuttons
committed
Rst update and quick fixes (#129)
1 parent b7e370c commit b140f1f

File tree

4 files changed

+29
-17
lines changed

4 files changed

+29
-17
lines changed

docs/source/Reference.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,27 @@ Reference
44
===============
55

66
====================
7-
List market holidays
7+
Get market holidays
88
====================
9-
.. automethod:: polygon.RESTClient.list_market_holidays
9+
.. automethod:: polygon.RESTClient.get_market_holidays
10+
11+
====================
12+
Get market status
13+
====================
14+
.. automethod:: polygon.RESTClient.get_market_status
1015

1116
====================
1217
List tickers
1318
====================
1419
.. automethod:: polygon.RESTClient.list_tickers
1520

1621
====================
17-
List ticker details
22+
Get ticker details
1823
====================
1924
.. automethod:: polygon.RESTClient.get_ticker_details
2025

2126
====================
22-
Get ticker news
27+
List ticker news
2328
====================
2429
.. automethod:: polygon.RESTClient.list_ticker_news
2530

@@ -38,3 +43,12 @@ List dividends
3843
====================
3944
.. automethod:: polygon.RESTClient.list_dividends
4045

46+
====================
47+
List conditions
48+
====================
49+
.. automethod:: polygon.RESTClient.list_conditions
50+
51+
====================
52+
Get exchanges
53+
====================
54+
.. automethod:: polygon.RESTClient.get_exchanges

polygon/rest/models/conditions.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,7 @@ class Condition:
4242
legacy: Optional[bool] = None
4343
name: Optional[str] = None
4444
sip_mapping: Optional[SipMapping] = None
45-
Type: Optional[
46-
str
47-
] = None # todo: 'type' is a keyword so here I capitalized. Should we capital case all dataclasses?
45+
type: Optional[str] = None
4846
update_rules: Optional[UpdateRules] = None
4947

5048
@staticmethod

polygon/rest/models/shared.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ class DividendType(Enum):
3737

3838

3939
class Frequency(Enum):
40-
OneTime = 0
41-
Anually = 1
42-
BiAnually = 2
43-
Quarterly = 4
44-
Monthly = 12
40+
ONE_TIME = 0
41+
ANUALLY = 1
42+
BIANUALLY = 2
43+
QUARTERLY = 4
44+
MONTHLY = 12
4545

4646

4747
class DataType(Enum):
48-
DataTrade = "trade"
49-
DataBBO = "bbo"
50-
DataNBBO = "nbbo"
48+
DATA_TRADE = "trade"
49+
DATA_BBO = "bbo"
50+
DATA_NBBO = "nbbo"
5151

5252

5353
class SIP(Enum):
@@ -57,6 +57,6 @@ class SIP(Enum):
5757

5858

5959
class ExchangeType(Enum):
60-
exchange = "exchange"
60+
EXCHANGE = "exchange"
6161
TRF = "TRF"
6262
SIP = "SIP"

polygon/rest/reference.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
# https://polygon.io/docs/stocks
2626
class MarketsClient(BaseClient):
27-
def list_market_holidays(
27+
def get_market_holidays(
2828
self, params: Optional[Dict[str, Any]] = None, raw: bool = False
2929
) -> Union[List[MarketHoliday], HTTPResponse]:
3030
"""

0 commit comments

Comments
 (0)