@@ -20,11 +20,20 @@ With AutoQuant, users can easily try ideas to create better Quant investment str
2020 - [ Backtest] ( #backtest )
2121- [ Advanced Topics] ( #advanced-topics )
2222 - [ Market] ( #market )
23+ - [ Index] ( #index )
2324 - [ Metrics] ( #metrics )
2425 - [ Exclusive Metrics] ( #exclusive-metrics )
2526 - [ TA-Lib Metrics] ( #ta-lib-metrics )
26- - [ Price Provider] ( #price-provider )
27- - [ Financial Statement Provider] ( #financial-statement-provider )
27+ - [ Providers] ( #providers )
28+ - [ Price Provider] ( #price-provider )
29+ - [ Provides List] ( #provides-list )
30+ - [ API] ( #api )
31+ - [ Financial Statement Provider] ( #financial-statement-provider )
32+ - [ Provides List] ( #provides-list-1 )
33+ - [ API] ( #api-1 )
34+ - [ Index Provider] ( #index-provider )
35+ - [ Provides List] ( #provides-list-2 )
36+ - [ API] ( #api-2 )
2837- [ Contribution Guide] ( #contribution-guide )
2938 - [ Test] ( #test )
3039 - [ Test all] ( #test-all )
@@ -111,6 +120,18 @@ Market.HK
111120Market.US
112121```
113122
123+ ## Index
124+ AutoQuant support the indexes in multiple markets now.
125+ Use StocksIndex Enum in codes:
126+ ```
127+ from autoquant import StocksIndex
128+
129+ StocksIndex.ZZ500
130+ StocksIndex.HS300
131+ StocksIndex.SZ50
132+
133+ ```
134+
114135## Metrics
115136
116137### Exclusive Metrics
@@ -138,17 +159,53 @@ close = numpy.random.random(100)
138159output = MOM(close, timeperiod=5)
139160```
140161
141- ## Price Provider
162+
163+ ## Providers
164+ ### Price Provider
165+
166+ #### Provides List
142167
143168- BaostockProvider
144169- TushareProvider
145170
171+ #### API
172+ ```
173+ def daily_prices(self, market: Market, code: str, start: date, end: date, **kwargs)
174+
175+ ```
176+
146177
147- ## Financial Statement Provider
178+ ### Financial Statement Provider
148179
180+
181+ #### Provides List
149182- SnowballProvider
150183
151184
185+ #### API
186+
187+ ```
188+ def quarter_statement(self, market: Market, code: str, quarter: date, **kwargs)
189+
190+ def yearly_balance_sheet(self, market: Market, code: str, years: list, **kwargs)
191+
192+ def yearly_income_sheets(self, market: Market, code: str, years: list, **kwargs)
193+
194+ ```
195+
196+ ### Index Provider
197+
198+
199+ #### Provides List
200+ - BaostockProvider
201+
202+
203+ #### API
204+
205+ ```
206+ def stocks_of_index(self, index: StocksIndex, **kwargs)
207+ ```
208+
152209# Contribution Guide
153210
154211## Test
0 commit comments