Skip to content

Rst update and quick fixes #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Darcy-Linde merged 6 commits into from
Apr 28, 2022
Merged

Rst update and quick fixes #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1cd158f
change list to get
Apr 28, 2022
9731eef
fix list/get and added conditions and exchanges
Apr 28, 2022
d15931f
made enums caps case
Apr 28, 2022
e03021c
changed Type to type
Apr 28, 2022
9c70a36
lint
Apr 28, 2022
4a83ea4
list market holiday to get market holiday
Apr 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions docs/source/Reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,29 @@ Reference
===============

====================
List market holidays
Get market holidays
====================
.. automethod:: polygon.RESTClient.list_market_holidays
.. automethod:: polygon.RESTClient.get_market_holidays

====================
Get market status
====================
.. automethod:: polygon.RESTClient.get_market_status

====================
List tickers
====================
.. automethod:: polygon.RESTClient.list_tickers

====================
List ticker details
Get ticker details
====================
.. automethod:: polygon.RESTClient.get_ticker_details

====================
Get ticker news
List ticker news
====================
.. automethod:: polygon.RESTClient.get_ticker_news
.. automethod:: polygon.RESTClient.list_ticker_news

====================
Get ticker types
Expand All @@ -38,3 +43,12 @@ List dividends
====================
.. automethod:: polygon.RESTClient.list_dividends

====================
List conditions
====================
.. automethod:: polygon.RESTClient.list_conditions

====================
Get exchanges
====================
.. automethod:: polygon.RESTClient.get_exchanges
4 changes: 1 addition & 3 deletions polygon/rest/models/conditions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@ class Condition:
legacy: Optional[bool] = None
name: Optional[str] = None
sip_mapping: Optional[SipMapping] = None
Type: Optional[
str
] = None # todo: 'type' is a keyword so here I capitalized. Should we capital case all dataclasses?
type: Optional[str] = None
update_rules: Optional[UpdateRules] = None

@staticmethod
Expand Down
18 changes: 9 additions & 9 deletions polygon/rest/models/shared.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,17 @@ class DividendType(Enum):


class Frequency(Enum):
OneTime = 0
Anually = 1
BiAnually = 2
Quarterly = 4
Monthly = 12
ONE_TIME = 0
ANUALLY = 1
BIANUALLY = 2
QUARTERLY = 4
MONTHLY = 12


class DataType(Enum):
DataTrade = "trade"
DataBBO = "bbo"
DataNBBO = "nbbo"
DATA_TRADE = "trade"
DATA_BBO = "bbo"
DATA_NBBO = "nbbo"


class SIP(Enum):
Expand All @@ -57,6 +57,6 @@ class SIP(Enum):


class ExchangeType(Enum):
exchange = "exchange"
EXCHANGE = "exchange"
TRF = "TRF"
SIP = "SIP"
2 changes: 1 addition & 1 deletion polygon/rest/reference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

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