8000 Add docs backlinks and missing endpoints (#170) · Raptorly1/client-python@aee3465 · GitHub
[go: up one dir, main page]
Skip to content

Commit aee3465

Browse files
Darcy-LindeDarcy-Linde
authored
Add docs backlinks and missing endpoints (polygon-io#170)
1 parent 53c87c9 commit aee3465

17 files changed

+1001
-16
lines changed

‎docs/source/Aggs.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Aggs
77
Get aggs
88
===========
99

10-
- `Stock aggs`_
10+
- `Stocks aggs`_
1111
- `Options aggs`_
1212
- `Forex aggs`_
1313
- `Crypto aggs`_
@@ -17,19 +17,45 @@ Get aggs
1717
============================
1818
Get grouped daily aggs
1919
============================
20+
21+
- `Stocks grouped daily aggs`_
22+
- `Forex grouped daily aggs`_
23+
- `Crypto grouped daily aggs`_
24+
2025
.. automethod:: polygon.RESTClient.get_grouped_daily_aggs
2126

2227
============================
2328
Get daily open close agg
2429
============================
30+
31+
- `Stocks daily open/close agg`_
32+
- `Options daily open/close agg`_
33+
- `Crypto daily open/close agg`_
34+
2535
.. automethod:: polygon.RESTClient.get_daily_open_close_agg
2636

2737
============================
2838
Get previous close agg
2939
============================
40+
41+
- `Stocks previous close agg`_
42+
- `Options previous close agg`_
43+
- `Forex previous close agg`_
44+
- `Crypto previous close agg`_
45+
3046
.. automethod:: polygon.RESTClient.get_previous_close_agg
3147

32-
.. _Stock aggs: https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to
48+
.. _Stocks aggs: https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__range__multiplier___timespan___from___to
3349
.. _Options aggs: https://polygon.io/docs/options/get_v2_aggs_ticker__optionsticker__range__multiplier___timespan___from___to
3450
.. _Forex aggs: https://polygon.io/docs/forex/get_v2_aggs_ticker__forexticker__range__multiplier___timespan___from___to
3551
.. _Crypto aggs: https://polygon.io/docs/crypto/get_v2_aggs_ticker__cryptoticker__range__multiplier___timespan___from___to
52+
.. _Stocks grouped daily aggs: https://polygon.io/docs/stocks/get_v2_aggs_grouped_locale_us_market_stocks__date
53+
.. _Forex grouped daily aggs: https://polygon.io/docs/forex/get_v2_aggs_grouped_locale_global_market_fx__date
54+
.. _Crypto grouped daily aggs: https://polygon.io/docs/crypto/get_v2_aggs_grouped_locale_global_market_crypto__date
55+
.. _Stocks daily open/close agg: https://polygon.io/docs/stocks/get_v1_open-close__stocksticker___date
56+
.. _Options daily open/close agg: https://polygon.io/docs/options/get_v1_open-close__optionsticker___date
57+
.. _Crypto daily open/close agg: https://polygon.io/docs/crypto/get_v1_open-close_crypto__from___to___date
58+
.. _Stocks previous close agg: https://polygon.io/docs/stocks/get_v2_aggs_ticker__stocksticker__prev
59+
.. _Options previous close agg: https://polygon.io/docs/options/get_v2_aggs_ticker__optionsticker__prev
60+
.. _Forex previous close agg: https://polygon.io/docs/forex/get_v2_aggs_ticker__forexticker__prev
61+
.. _Crypto previous close agg: https://polygon.io/docs/crypto/get_v2_aggs_ticker__cryptoticker__prev

‎docs/source/Enums.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,9 @@ Timeframe
9494
:members:
9595
:undoc-members:
9696

97+
==============================================================
98+
Precision
99+
==============================================================
100+
.. autoclass:: polygon.rest.models.Precision
101+
:members:
102+
:undoc-members:

‎docs/source/Quotes.rst

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,45 @@
11
.. _quotes_header:
22

33
Quotes
4-
==========
4+
=================================
55

6-
===========
6+
=================================
77
List quotes
8-
===========
8+
=================================
9+
10+
- `Stocks quotes`_
11+
- `Options quotes`_
12+
- `Forex quotes`_
13+
914
.. automethod:: polygon.RESTClient.list_quotes
1015

11-
==============
16+
=================================
1217
Get last quote
13-
==============
18+
=================================
19+
20+
- `Stocks last quote`_
21+
1422
.. automethod:: polygon.RESTClient.get_last_quote
23+
24+
=================================
25+
Get last forex quote
26+
=================================
27+
28+
- `Forex last quote for a currency pair`_
29+
30+
.. automethod:: polygon.RESTClient.get_last_forex_quote
31+
32+
=================================
33+
Get real-time currency conversion
34+
=================================
35+
36+
- `Forex real-time currency conversion`_
37+
38+
.. automethod:: polygon.RESTClient.get_real_time_currency_conversion
39+
40+
.. _Stocks quotes: https://polygon.io/docs/stocks/get_v3_quotes__stockticker
41+
.. _Options quotes: https://polygon.io/docs/options/get_v3_quotes__optionsticker
42+
.. _Forex quotes: https://polygon.io/docs/forex/get_v3_quotes__fxticker
43+
.. _Stocks last quote: https://polygon.io/docs/stocks/get_v2_last_nbbo__stocksticker
44+
.. _Forex last quote for a currency pair: https://polygon.io/docs/forex/get_v1_last_quote_currencies__from___to
45+
.. _Forex real-time currency conversion: https://polygon.io/docs/forex/get_v1_conversion__from___to

‎docs/source/Reference.rst

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,49 +6,126 @@ Reference
66
====================
77
Get market holidays
88
====================
9+
10+
- `Stocks market holidays`_
11+
- `Options market holidays`_
12+
- `Forex market holidays`_
13+
- `Crypto market holidays`_
14+
915
.. automethod:: polygon.RESTClient.get_market_holidays
1016

1117
====================
1218
Get market status
1319
====================
20+
21+
- `Stocks market status`_
22+
- `Options market status`_
23+
- `Forex market status`_
24+
- `Crypto market status`_
25+
1426
.. automethod:: polygon.RESTClient.get_market_status
1527

1628
====================
1729
List tickers
1830
====================
31+
32+
- `Stocks tickers`_
33+
- `Options tickers`_
34+
- `Forex tickers`_
35+
- `Crypto tickers`_
36+
1937
.. automethod:: polygon.RESTClient.list_tickers
2038

2139
====================
2240
Get ticker details
2341
====================
42+
43+
- `Stocks ticker details`_
44+
- `Options ticker details`_
45+
2446
.. automethod:: polygon.RESTClient.get_ticker_details
2547

2648
====================
2749
List ticker news
2850
====================
51+
52+
- `Stocks ticker news`_
53+
- `Options ticker news`_
54+
2955
.. automethod:: polygon.RESTClient.list_ticker_news
3056

3157
====================
3258
Get ticker types
3359
====================
60+
61+
- `Stocks ticker types`_
62+
- `Options ticker types`_
63+
3464
.. automethod:: polygon.RESTClient.get_ticker_types
3565

3666
====================
3767
List splits
3868
====================
69+
70+
- `Stocks splits`_
71+
3972
.. automethod:: polygon.RESTClient.list_splits
4073

4174
====================
4275
List dividends
4376
====================
77+
78+
- `Stocks dividends`_
79+
4480
.. automethod:: polygon.RESTClient.list_dividends
4581

4682
====================
4783
List conditions
4884
====================
85+
86+
- `Stocks conditions`_
87+
- `Options conditions`_
88+
- `Forex conditions`_
89+
- `Crypto conditions`_
90+
4991
.. automethod:: polygon.RESTClient.list_conditions
5092

5193
====================
5294
Get exchanges
5395
====================
96+
97+
- `Stocks exchanges`_
98+
- `Options exchanges`_
99+
- `Forex exchanges`_
100+
- `Crypto exchanges`_
101+
54102
.. automethod:: polygon.RESTClient.get_exchanges
103+
104+
.. _Stocks market holidays: https://polygon.io/docs/stocks/get_v1_marketstatus_upcoming
105+
.. _Options market holidays: https://polygon.io/docs/options/get_v1_marketstatus_upcoming
106+
.. _Forex market holidays: https://polygon.io/docs/forex/get_v1_marketstatus_upcoming
107+
.. _Crypto market holidays: https://polygon.io/docs/crypto/get_v1_marketstatus_upcoming
108+
.. _Stocks market status: https://polygon.io/docs/stocks/get_v1_marketstatus_now
109+
.. _Options market status: https://polygon.io/docs/options/get_v1_marketstatus_now
110+
.. _Forex market status: https://polygon.io/docs/forex/get_v1_marketstatus_now
111+
.. _Crypto market status: https://polygon.io/docs/crypto/get_v1_marketstatus_now
112+
.. _Stocks tickers: https://polygon.io/docs/stocks/get_v3_reference_tickers
113+
.. _Options tickers: https://polygon.io/docs/options/get_v3_reference_tickers
114+
.. _Forex tickers: https://polygon.io/docs/forex/get_v3_reference_tickers
115+
.. _Crypto tickers: https://polygon.io/docs/crypto/get_v3_reference_tickers
116+
.. _Stocks ticker details: https://polygon.io/docs/stocks/get_v3_reference_tickers__ticker
117+
.. _Options ticker details: https://polygon.io/docs/options/get_v3_reference_tickers__ticker
118+
.. _Stocks ticker news: https://polygon.io/docs/stocks/get_v2_reference_news
119+
.. _Options ticker news: https://polygon.io/docs/options/get_v2_reference_news
120+
.. _Stocks ticker types: https://polygon.io/docs/stocks/get_v3_reference_tickers_types
121+
.. _Options ticker types: https://polygon.io/docs/options/get_v3_reference_tickers_types
122+
.. _Stocks splits: https://polygon.io/docs/stocks/get_v3_reference_splits
123+
.. _Stocks dividends: https://polygon.io/docs/stocks/get_v3_reference_dividends
124+
.. _Stocks conditions: https://polygon.io/docs/stocks/get_v3_reference_conditions
125+
.. _Options conditions: https://polygon.io/docs/options/get_v3_reference_conditions
126+
.. _Forex conditions: https://polygon.io/docs/forex/get_v3_reference_conditions
127+
.. _Crypto conditions: https://polygon.io/docs/crypto/get_v3_reference_conditions
128+
.. _Stocks exchanges: https://polygon.io/docs/stocks/get_v3_reference_exchanges
129+
.. _Options exchanges: https://polygon.io/docs/options/get_v3_reference_exchanges
130+
.. _Forex exchanges: https://polygon.io/docs/forex/get_v3_reference_exchanges
131+
.. _Crypto exchanges: https://polygon.io/docs/crypto/get_v3_reference_exchanges

‎docs/source/Snapshot.rst

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,57 @@ Snapshot
66
=================================
77
Get all snapshots
88
=================================
9+
10+
- `Stocks snapshot all tickers`_
11+
- `Forex snapshot all tickers`_
12+
- `Crypto snapshot all tickers`_
13+
914
.. automethod:: polygon.RESTClient.get_snapshot_all
1015

1116
=================================
1217
Get gainers/losers snapshot
1318
=================================
19+
20+
- `Stocks snapshot gainers/losers`_
21+
- `Forex snapshot gainers/losers`_
22+
- `Crypto snapshot gainers/losers`_
23+
1424
.. automethod:: polygon.RESTClient.get_snapshot_direction
1525

1626
=================================
1727
Get ticker snapshot
1828
=================================
29+
30+
- `Stocks snapshot ticker`_
31+
- `Forex snapshot ticker`_
32+
- `Crypto snapshot ticker`_
33+
1934
.. automethod:: polygon.RESTClient.get_snapshot_ticker
2035

2136
=================================
2237
Get options snapshot
2338
=================================
39+
40+
- `Options snapshot option contract`_
41+
2442
.. automethod:: polygon.RESTClient.get_snapshot_option
2543

2644
=================================
2745
Get crypto L2 book snapshot
2846
=================================
29-
.. automethod:: polygon.RESTClient.get_snapshot_crypto_book
47+
48+
- `Crypto snapshot ticker full book (L2)`_
49+
50+
.. automethod:: polygon.RESTClient.get_snapshot_crypto_book
51+
52+
.. _Stocks snapshot all tickers: https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks_tickers
53+
.. _Forex snapshot all tickers: https://polygon.io/docs/forex/get_v2_snapshot_locale_global_markets_forex_tickers
54+
.. _Crypto snapshot all tickers: https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto_tickers
55+
.. _Stocks snapshot gainers/losers: https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks__direction
56+
.. _Forex snapshot gainers/losers: https://polygon.io/docs/forex/get_v2_snapshot_locale_global_markets_forex__direction
57+
.. _Crypto snapshot gainers/losers: https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto__direction
58+
.. _Stocks snapshot ticker: https://polygon.io/docs/stocks/get_v2_snapshot_locale_us_markets_stocks_tickers__stocksticker
59+
.. _Forex snapshot ticker: https://polygon.io/docs/forex/get_v2_snapshot_locale_global_markets_forex_tickers__ticker
60+
.. _Crypto snapshot ticker: https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto_tickers__ticker
61+
.. _Options snapshot option contract: https://polygon.io/docs/options/get_v3_snapshot_options__underlyingasset___optioncontract
62+
.. _Crypto snapshot ticker full book (L2): https://polygon.io/docs/crypto/get_v2_snapshot_locale_global_markets_crypto_tickers__ticker__book

‎docs/source/Trades.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,33 @@ Trades
66
==================================================================
77
List trades
88
==================================================================
9+
10+
- `Stocks trades`_
11+
- `Options trades`_
12+
- `Crypto trades`_
13+
914
.. automethod:: polygon.RESTClient.list_trades
1015

1116
==================================================================
1217
Get last trade
1318
==================================================================
19+
20+
- `Stocks last trade`_
21+
- `Options last trade`_
22+
1423
.. automethod:: polygon.RESTClient.get_last_trade
1524

1625
==================================================================
1726
Get last crypto trade
1827
==================================================================
19-
.. automethod:: polygon.RESTClient.get_last_crypto_trade
28+
29+
- `Crypto last trade for crypto pair`_
30+
31+
.. automethod:: polygon.RESTClient.get_last_crypto_trade
32+
33+
.. _Stocks trades: https://polygon.io/docs/stocks/get_v3_trades__stockticker
34+
.. _Options trades: https://polygon.io/docs/options/get_v3_trades__optionsticker
35+
.. _Crypto trades: https://polygon.io/docs/crypto/get_v3_trades__cryptoticker
36+
.. _Stocks last trade: https://polygon.io/docs/stocks/get_v2_last_trade__stocksticker
37+
.. _Options last trade: https://polygon.io/docs/options/get_v2_last_trade__optionsticker
38+
.. _Crypto last trade for crypto pair: https://polygon.io/docs/crypto/get_v1_last_crypto__from___to

‎docs/source/WebSocket.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
WebSocket
44
==========
55

6+
- `Stocks getting started`_
7+
- `Options getting started`_
8+
- `Forex getting started`_
9+
- `Crypto getting started`_
10+
611
===========
712
Init client
813
===========
@@ -34,3 +39,7 @@ Close
3439
============================
3540
.. automethod:: polygon.WebSocketClient.close
3641

42+
.. _Stocks getting started: https://polygon.io/docs/stocks/ws_getting-started
43+
.. _Options getting started: https://polygon.io/docs/options/ws_getting-started
44+
.. _Forex getting started: https://polygon.io/docs/forex/ws_getting-started
45+
.. _Crypto getting started: https://polygon.io/docs/crypto/ws_getting-started

‎docs/source/vX.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,9 @@ vX
1111
======================
1212
List stock financials
1313
======================
14+
15+
- `Stocks financials vX`_
16+
1417
.. automethod:: polygon.rest.VXClient.list_stock_financials
1518

19+
.. _Stocks financials vX: https://polygon.io/docs/stocks/get_vx_reference_financials

‎polygon/rest/models/common.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,3 +76,11 @@ class SnapshotMarketType(Enum):
7676
class Timeframe(Enum):
7777
ANNUAL = "annual"
7878
QUARTERLY = "quarterly"
79+
80+
81+
class Precision(Enum):
82+
ZERO = 0
83+
ONE = 1
84+
TWO = 2
85+
THREE = 3
86+
FOUR = 4

0 commit comments

Comments
 (0)
0