make examples simpler (#172)

* make examples simpler

* remove api key

Author: clickingbuttons

examples/rest/raw-get.py

@@ -2,16 +2,16 @@
 from typing import cast
 from urllib3 import HTTPResponse
 
-client = RESTClient(verbose=True)
+client = RESTClient()
 
 aggs = cast(
     HTTPResponse,
     client.get_aggs(
-        ticker="AAPL",
-        multiplier=1,
-        timespan="day",
-        from_="2022-04-01",
-        to="2022-04-04",
+        "AAPL",
+        1,
+        "day",
+        "2022-04-01",
+        "2022-04-04",
         raw=True,
     ),
 )

examples/rest/raw-list.py

@@ -2,11 +2,11 @@
 from typing import cast
 from urllib3 import HTTPResponse
 
-client = RESTClient(verbose=True)
+client = RESTClient()
 
 trades = cast(
     HTTPResponse,
-    client.list_trades(ticker="AAA", timestamp="2022-04-20", limit=5, raw=True),
+    client.list_trades("AAA", "2022-04-20", 5, raw=True),
 )
 print(trades.data)
 # b'{

examples/rest/simple-get.py

@@ -1,21 +1,6 @@
 from polygon import RESTClient
-from datetime import date, datetime
 
-client = RESTClient(verbose=True)
+client = RESTClient()
 
-aggs1 = client.get_aggs(
-    ticker="AAPL", multiplier=1, timespan="day", from_="2005-04-04", to="2005-04-04"
-)
-aggs2 = client.get_aggs(
-    ticker="AAPL",
-    multiplier=1,
-    timespan="day",
-    from_=date(2005, 4, 4),
-    to=datetime(2005, 4, 4),
-)
-
-if aggs1 != aggs2:
-    print(aggs1, aggs2)
-    assert False
-else:
-    print(aggs1)
+aggs = client.get_aggs("AAPL", 1, "day", "2004-04-04", "2004-04-04")
+print(aggs)

examples/rest/simple-list.py

@@ -1,8 +1,8 @@
 from polygon import RESTClient
 
-client = RESTClient(verbose=True)
+client = RESTClient()
 
 trades = []
-for t in client.list_trades(ticker="AAA", timestamp="2022-04-20", limit=5):
+for t in client.list_trades("AAA", "2022-04-04", limit=5):
     trades.append(t)
 print(trades)

polygon/__init__.py

@@ -1,2 +1,3 @@
 from .rest import RESTClient
+from .rest.base import NoResults
 from .websocket import WebSocketClient, AuthError

polygon/rest/base.py

@@ -14,6 +14,10 @@
     pass
 
 
+class NoResults(Exception):
+    pass
+
+
 class BaseClient:
     def __init__(
         self,
@@ -79,6 +83,12 @@ def _get(
         obj = self._decode(resp)
 
         if result_key:
+            if result_key not in obj:
+                raise NoResults(
+                    f'Expected key "{result_key}" in response {obj}.'
+                    + "Make sure you have sufficient permissions and your request parameters are valid."
+                    + f"This is the url that returned no results: {resp.geturl()}"
+                )
             obj = obj[result_key]
 
         if deserializer: