Snapshot rst (#144)

Author: Darcy-Linde

docs/source/Snapshot.rst

@@ -0,0 +1,29 @@
+.. _snapshot_header:
+
+Snapshot
+=================================
+
+=================================
+Get all snapshots
+=================================
+.. automethod:: polygon.RESTClient.get_snapshot_all
+
+=================================
+Get gainers/losers snapshot
+=================================
+.. automethod:: polygon.RESTClient.get_snapshot_direction
+
+=================================
+Get ticker snapshot
+=================================
+.. automethod:: polygon.RESTClient.get_snapshot_ticker
+
+=================================
+Get options snapshot
+=================================
+.. automethod:: polygon.RESTClient.get_snapshot_option
+
+=================================
+Get crypto L2 book snapshot
+=================================
+.. automethod:: polygon.RESTClient.get_snapshot_crypto_book

docs/source/index.rst

@@ -9,6 +9,7 @@ This documentation is for the Python client only. For details about the response
 
   Getting-Started
   Aggs
+  Snapshot
   Quotes
   Reference
   Trades

polygon/rest/reference.py

@@ -33,7 +33,7 @@ def get_market_holidays(
 
         :param params: Any additional query params
         :param raw: Return HTTPResponse object instead of results object
-        :return: List of quotes
+        :return: List of market holidays
         """
         url = "/v1/marketstatus/upcoming"
 
@@ -53,7 +53,7 @@ def get_market_status(
 
         :param params: Any additional query params
         :param raw: Return HTTPResponse object instead of results object
-        :return: List of quotes
+        :return: Market status
         """
         url = "/v1/marketstatus/now"
 
@@ -393,7 +393,7 @@ def get_exchanges(
         :param locale: Filter by locale.
         :param params: Any additional query params
         :param raw: Return HTTPResponse object instead of results object
-        :return: List of quotes
+        :return: List of exchanges
         """
         url = "/v3/reference/exchanges"