Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 28 additions & 2 deletions docs/source/Aggs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Aggs
Get aggs
===========

- `Stock aggs`_
- `Stocks aggs`_
- `Options aggs`_
- `Forex aggs`_
- `Crypto aggs`_
Expand All @@ -17,19 +17,45 @@ Get aggs
============================
Get grouped daily aggs
============================

- `Stocks grouped daily aggs`_
- `Forex grouped daily aggs`_
- `Crypto grouped daily aggs`_

.. automethod:: polygon.RESTClient.get_grouped_daily_aggs

============================
Get daily open close agg
============================

- `Stocks daily open/close agg`_
- `Options daily open/close agg`_
- `Crypto daily open/close agg`_

.. automethod:: polygon.RESTClient.get_daily_open_close_agg

============================
Get previous close agg
============================

- `Stocks previous close agg`_
- `Options previous close agg`_
- `Forex previous close agg`_
- `Crypto previous close agg`_

.. automethod:: polygon.RESTClient.get_previous_close_agg

.. _Stock aggs: https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to
.. _Stocks aggs: https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to
.. _Options aggs: https://polygon.io/docs/options/get_v2_aggs_ticker__optionsticker__range__multiplier___timespan___from___to
.. _Forex aggs: https://polygon.io/docs/forex/get_v2_aggs_ticker__forexticker__range__multiplier___timespan___from___to
.. _Crypto aggs: https://polygon.io/docs/crypto/get_v2_aggs_ticker__cryptoticker__range__multiplier___timespan___from___to
.. _Stocks grouped daily aggs: https://polygon.io/docs/stocks/get_v2_aggs_grouped_locale_us_market_stocks__date
.. _Forex grouped daily aggs: https://polygon.io/docs/forex/get_v2_aggs_grouped_locale_global_market_fx__date
.. _Crypto grouped daily aggs: https://polygon.io/docs/crypto/get_v2_aggs_grouped_locale_global_market_crypto__date
.. _Stocks daily open/close agg: https://polygon.io/docs/stocks/get_v1_open-close__stocksticker___date
.. _Options daily open/close agg: https://polygon.io/docs/options/get_v1_open-close__optionsticker___date
.. _Crypto daily open/close agg: https://polygon.io/docs/crypto/get_v1_open-close_crypto__from___to___date
.. _Stocks previous close agg: https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__prev
.. _Options previous close agg: https://polygon.io/docs/options/get_v2_aggs_ticker__optionsticker__prev
.. _Forex previous close agg: https://polygon.io/docs/forex/get_v2_aggs_ticker__forexticker__prev
.. _Crypto previous close agg: https://polygon.io/docs/crypto/get_v2_aggs_ticker__cryptoticker__prev
6 changes: 6 additions & 0 deletions docs/source/Enums.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,9 @@ Timeframe
:members:
:undoc-members:

==============================================================
Precision
==============================================================
.. autoclass:: polygon.rest.models.Precision
:members:
:undoc-members:
41 changes: 36 additions & 5 deletions docs/source/Quotes.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,45 @@
.. _quotes_header:

Quotes
==========
=================================

===========
=================================
List quotes
===========
=================================

- `Stocks quotes`_
- `Options quotes`_
- `Forex quotes`_

.. automethod:: polygon.RESTClient.list_quotes

==============
=================================
Get last quote
==============
=================================

- `Stocks last quote`_

.. automethod:: polygon.RESTClient.get_last_quote

=================================
Get last forex quote
=================================

- `Forex last quote for a currency pair`_

.. automethod:: polygon.RESTClient.get_last_forex_quote

=================================
Get real-time currency conversion
=================================

- `Forex real-time currency conversion`_

.. automethod:: polygon.RESTClient.get_real_time_currency_conversion

.. _Stocks quotes: https://polygon.io/docs/stocks/get_v3_quotes__stockticker
.. _Options quotes: https://polygon.io/docs/options/get_v3_quotes__optionsticker
.. _Forex quotes: https://polygon.io/docs/forex/get_v3_quotes__fxticker
.. _Stocks last quote: https://polygon.io/docs/stocks/get_v2_last_nbbo__stocksticker
.. _Forex last quote for a currency pair: https://polygon.io/docs/forex/get_v1_last_quote_currencies__from___to
.. _Forex real-time currency conversion: https://polygon.io/docs/forex/get_v1_conversion__from___to
77 changes: 77 additions & 0 deletions docs/source/Reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,49 +6,126 @@ Reference
====================
Get market holidays
====================

- `Stocks market holidays`_
- `Options market holidays`_
- `Forex market holidays`_
- `Crypto market holidays`_

.. automethod:: polygon.RESTClient.get_market_holidays

====================
Get market status
====================

- `Stocks market status`_
- `Options market status`_
- `Forex market status`_
- `Crypto market status`_

.. automethod:: polygon.RESTClient.get_market_status

====================
List tickers
====================

- `Stocks tickers`_
- `Options tickers`_
- `Forex tickers`_
- `Crypto tickers`_

.. automethod:: polygon.RESTClient.list_tickers

====================
Get ticker details
====================

- `Stocks ticker details`_
- `Options ticker details`_

.. automethod:: polygon.RESTClient.get_ticker_details

====================
List ticker news
====================

- `Stocks ticker news`_
- `Options ticker news`_

.. automethod:: polygon.RESTClient.list_ticker_news

====================
Get ticker types
====================

- `Stocks ticker types`_
- `Options ticker types`_

.. automethod:: polygon.RESTClient.get_ticker_types

====================
List splits
====================

- `Stocks splits`_

.. automethod:: polygon.RESTClient.list_splits

====================
List dividends
====================

- `Stocks dividends`_

.. automethod:: polygon.RESTClient.list_dividends

====================
List conditions
====================

- `Stocks conditions`_
- `Options conditions`_
- `Forex conditions`_
- `Crypto conditions`_

.. automethod:: polygon.RESTClient.list_conditions

====================
Get exchanges
====================

- `Stocks exchanges`_
- `Options exchanges`_
- `Forex exchanges`_
- `Crypto exchanges`_

.. automethod:: polygon.RESTClient.get_exchanges

.. _Stocks market holidays: https://polygon.io/docs/stocks/get_v1_marketstatus_upcoming
.. _Options market holidays: https://polygon.io/docs/options/get_v1_marketstatus_upcoming
.. _Forex market holidays: https://polygon.io/docs/forex/get_v1_marketstatus_upcoming
.. _Crypto market holidays: https://polygon.io/docs/crypto/get_v1_marketstatus_upcoming
.. _Stocks market status: https://polygon.io/docs/stocks/get_v1_marketstatus_now
.. _Options market status: https://polygon.io/docs/options/get_v1_marketstatus_now
.. _Forex market status: https://polygon.io/docs/forex/get_v1_marketstatus_now
.. _Crypto market status: https://polygon.io/docs/crypto/get_v1_marketstatus_now
.. _Stocks tickers: https://polygon.io/docs/stocks/get_v3_reference_tickers
.. _Options tickers: https://polygon.io/docs/options/get_v3_reference_tickers
.. _Forex tickers: https://polygon.io/docs/forex/get_v3_reference_tickers
.. _Crypto tickers: https://polygon.io/docs/crypto/get_v3_reference_tickers
.. _Stocks ticker details: https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker
.. _Options ticker details: https://polygon.io/docs/options/get_v3_reference_tickers__ticker
.. _Stocks ticker news: https://polygon.io/docs/stocks/get_v2_reference_news
.. _Options ticker news: https://polygon.io/docs/options/get_v2_reference_news
.. _Stocks ticker types: https://polygon.io/docs/stocks/get_v3_reference_tickers_types
.. _Options ticker types: https://polygon.io/docs/options/get_v3_reference_tickers_types
.. _Stocks splits: https://polygon.io/docs/stocks/get_v3_reference_splits
.. _Stocks dividends: https://polygon.io/docs/stocks/get_v3_reference_dividends
.. _Stocks conditions: https://polygon.io/docs/stocks/get_v3_reference_conditions
.. _Options conditions: https://polygon.io/docs/options/get_v3_reference_conditions
.. _Forex conditions: https://polygon.io/docs/forex/get_v3_reference_conditions
.. _Crypto conditions: https://polygon.io/docs/crypto/get_v3_reference_conditions
.. _Stocks exchanges: https://polygon.io/docs/stocks/get_v3_reference_exchanges
.. _Options exchanges: https://polygon.io/docs/options/get_v3_reference_exchanges
.. _Forex exchanges: https://polygon.io/docs/forex/get_v3_reference_exchanges
.. _Crypto exchanges: https://polygon.io/docs/crypto/get_v3_reference_exchanges
35 changes: 34 additions & 1 deletion docs/source/Snapshot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,57 @@ Snapshot
=================================
Get all snapshots
=================================

- `Stocks snapshot all tickers`_
- `Forex snapshot all tickers`_
- `Crypto snapshot all tickers`_

.. automethod:: polygon.RESTClient.get_snapshot_all

=================================
Get gainers/losers snapshot
=================================

- `Stocks snapshot gainers/losers`_
- `Forex snapshot gainers/losers`_
- `Crypto snapshot gainers/losers`_

.. automethod:: polygon.RESTClient.get_snapshot_direction

=================================
Get ticker snapshot
=================================

- `Stocks snapshot ticker`_
- `Forex snapshot ticker`_
- `Crypto snapshot ticker`_

.. automethod:: polygon.RESTClient.get_snapshot_ticker

=================================
Get options snapshot
=================================

- `Options snapshot option contract`_

.. automethod:: polygon.RESTClient.get_snapshot_option

=================================
Get crypto L2 book snapshot
=================================
.. automethod:: polygon.RESTClient.get_snapshot_crypto_book

- `Crypto snapshot ticker full book (L2)`_

.. automethod:: polygon.RESTClient.get_snapshot_crypto_book

.. _Stocks snapshot all tickers: https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks_tickers
.. _Forex snapshot all tickers: https://polygon.io/docs/forex/get_v2_snapshot_locale_global_markets_forex_tickers
.. _Crypto snapshot all tickers: https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto_tickers
.. _Stocks snapshot gainers/losers: https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks__direction
.. _Forex snapshot gainers/losers: https://polygon.io/docs/forex/get_v2_snapshot_locale_global_markets_forex__direction
.. _Crypto snapshot gainers/losers: https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto__direction
.. _Stocks snapshot ticker: https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks_tickers__stocksticker
.. _Forex snapshot ticker: https://polygon.io/docs/forex/get_v2_snapshot_locale_global_markets_forex_tickers__ticker
.. _Crypto snapshot ticker: https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto_tickers__ticker
.. _Options snapshot option contract: https://polygon.io/docs/options/get_v3_snapshot_options__underlyingasset___optioncontract
.. _Crypto snapshot ticker full book (L2): https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto_tickers__ticker__book
21 changes: 20 additions & 1 deletion docs/source/Trades.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,33 @@ Trades
==================================================================
List trades
==================================================================

- `Stocks trades`_
- `Options trades`_
- `Crypto trades`_

.. automethod:: polygon.RESTClient.list_trades

==================================================================
Get last trade
==================================================================

- `Stocks last trade`_
- `Options last trade`_

.. automethod:: polygon.RESTClient.get_last_trade

==================================================================
Get last crypto trade
==================================================================
.. automethod:: polygon.RESTClient.get_last_crypto_trade

- `Crypto last trade for crypto pair`_

.. automethod:: polygon.RESTClient.get_last_crypto_trade

.. _Stocks trades: https://polygon.io/docs/stocks/get_v3_trades__stockticker
.. _Options trades: https://polygon.io/docs/options/get_v3_trades__optionsticker
.. _Crypto trades: https://polygon.io/docs/crypto/get_v3_trades__cryptoticker
.. _Stocks last trade: https://polygon.io/docs/stocks/get_v2_last_trade__stocksticker
.. _Options last trade: https://polygon.io/docs/options/get_v2_last_trade__optionsticker
.. _Crypto last trade for crypto pair: https://polygon.io/docs/crypto/get_v1_last_crypto__from___to
9 changes: 9 additions & 0 deletions docs/source/WebSocket.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
WebSocket
==========

- `Stocks getting started`_
- `Options getting started`_
- `Forex getting started`_
- `Crypto getting started`_

===========
Init client
===========
Expand Down Expand Up @@ -34,3 +39,7 @@ Close
============================
.. automethod:: polygon.WebSocketClient.close

.. _Stocks getting started: https://polygon.io/docs/stocks/ws_getting-started
.. _Options getting started: https://polygon.io/docs/options/ws_getting-started
.. _Forex getting started: https://polygon.io/docs/forex/ws_getting-started
.. _Crypto getting started: https://polygon.io/docs/crypto/ws_getting-started
4 changes: 4 additions & 0 deletions docs/source/vX.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,9 @@ vX
======================
List stock financials
======================

- `Stocks financials vX`_

.. automethod:: polygon.rest.VXClient.list_stock_financials

.. _Stocks financials vX: https://polygon.io/docs/stocks/get_vx_reference_financials
8 changes: 8 additions & 0 deletions polygon/rest/models/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,11 @@ class SnapshotMarketType(Enum):
class Timeframe(Enum):
ANNUAL = "annual"
QUARTERLY = "quarterly"


class Precision(Enum):
ZERO = 0
ONE = 1
TWO = 2
THREE = 3
FOUR = 4
Loading