Added get_events and tests to client library.

RV1:
- added get_events function to client library
- added tests.

RV2:
- changed get_ticker_events to get_ticker_history

Author: antdjohns

polygon/rest/models/tickers.py

@@ -185,3 +185,23 @@ class TickerTypes:
     @staticmethod
     def from_dict(d):
         return TickerTypes(**d)
+
+
+@modelclass
+class TickerChangeEvent:
+    ticker: str
+
+    @staticmethod
+    def from_dict(d):
+        return TickerChangeEvent(**d)
+
+
+@modelclass
+class TickerChangeResults:
+    event_type: str = "ticker_change"
+    date: Optional[str] = None
+    ticker_change: Optional[TickerChangeEvent] = None
+
+    @staticmethod
+    def from_dict(d):
+        return TickerChangeResults(**d)

polygon/rest/reference.py

@@ -4,6 +4,7 @@
     MarketHoliday,
     MarketStatus,
     Ticker,
+    TickerChangeResults,
     TickerDetails,
     TickerNews,
     TickerTypes,
@@ -143,6 +144,30 @@ def get_ticker_details(
             result_key="results",
         )
 
+    def get_ticker_history(
+        self,
+        ticker: Optional[str] = None,
+        params: Optional[Dict[str, Any]] = None,
+        raw: bool = False,
+    ) -> Union[TickerChangeResults, HTTPResponse]:
+
+        """
+        Get event history of ticker given particular point in time.
+        :param ticker: The ticker symbol of the asset.
+        :param params: Additional query parameters
+        :param raw: Return raw object instead of results object.
+        :return: Ticker Event History V3
+        """
+        url = f"/v3/reference/tickers/{ticker}/history"
+
+        return self._get(
+            path=url,
+            params=params,
+            deserializer=TickerChangeResults.from_dict,
+            result_key="results",
+            raw=raw,
+        )
+
     def list_ticker_news(
         self,
         ticker: Optional[str] = None,

test_rest/mocks/v3/reference/tickers/META/history.json

@@ -0,0 +1,20 @@
+{
+  "results": [
+    {
+      "event_type": "ticker_change",
+      "date": "2022-06-11",
+      "ticker_change": {
+        "ticker": "META"
+      }
+    },
+    {
+      "event_type": "ticker_change",
+      "date": "2012-05-18",
+      "ticker_change": {
+        "ticker": "FB"
+      }
+    }
+  ],
+  "status": "OK",
+  "request_id": "8c911ff1-5ca8-41e8-9bbf-e625141caacc"
+}

test_rest/test_tickers.py

@@ -3,6 +3,7 @@
     TickerDetails,
     TickerNews,
     TickerTypes,
+    TickerChangeResults,
     Publisher,
     Branding,
     CompanyAddress,
@@ -230,3 +231,21 @@ def test_get_ticker_types(self):
         ]
 
         self.assertEqual(types, expected)
+
+    def test_get_ticker_history_ticker_change(self):
+        history = self.c.get_ticker_history("META")
+
+        expected = [
+            TickerChangeResults(
+                event_type="ticker_change",
+                date="2022-06-11",
+                ticker_change={"ticker": "META"},
+            ),
+            TickerChangeResults(
+                event_type="ticker_change",
+                date="2012-05-18",
+                ticker_change={"ticker": "FB"},
+            ),
+        ]
+
+        self.assertEqual(expected, history)