Skip to content

Snapshot rst #144

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
merged 7 commits into from
Apr 29, 2022
Merged

Snapshot rst #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
69dc2aa
snapshot rst file
Apr 29, 2022
b41bef2
fixed type
Apr 29, 2022
0c74e98
add Snapshot
Apr 29, 2022
b709c21
fix typo
Apr 29, 2022
d2aabea
fix market return types
Apr 29, 2022
31a5a3c
changed phrasing
Apr 29, 2022
9c09118
loooonnnngggerrrr
Apr 29, 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
29 changes: 29 additions & 0 deletions docs/source/Snapshot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This documentation is for the Python client only. For details about the response

Getting-Started
Aggs
Snapshot
Quotes
Reference
Trades
Expand Down
6 changes: 3 additions & 3 deletions polygon/rest/reference.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand All @@ -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"

Expand Down Expand Up @@ -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"

Expand Down