@bitget-ai/getagent-skill 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/.claude-plugin/marketplace.json +2 -2
  2. package/.claude-plugin/plugin.json +1 -1
  3. package/VERSION +1 -1
  4. package/package.json +1 -1
  5. package/skills/getagent/SKILL.md +29 -1
  6. package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
  7. package/skills/getagent/references/api/publish.md +4 -0
  8. package/skills/getagent/references/backtest-engine.md +80 -151
  9. package/skills/getagent/references/package-schema.md +30 -8
  10. package/skills/getagent/references/sdk/backtest/catalog.md +15 -2
  11. package/skills/getagent/references/sdk/data/arxiv.md +8 -10
  12. package/skills/getagent/references/sdk/data/catalog.md +1 -4
  13. package/skills/getagent/references/sdk/data/commodity.md +25 -39
  14. package/skills/getagent/references/sdk/data/coverage.md +0 -3
  15. package/skills/getagent/references/sdk/data/crypto.md +158 -357
  16. package/skills/getagent/references/sdk/data/currency.md +7 -15
  17. package/skills/getagent/references/sdk/data/derivatives.md +35 -50
  18. package/skills/getagent/references/sdk/data/economy.md +175 -259
  19. package/skills/getagent/references/sdk/data/equity.md +257 -393
  20. package/skills/getagent/references/sdk/data/etf.md +40 -64
  21. package/skills/getagent/references/sdk/data/famafrench.md +38 -50
  22. package/skills/getagent/references/sdk/data/fixedincome.md +89 -139
  23. package/skills/getagent/references/sdk/data/imf_utils.md +0 -8
  24. package/skills/getagent/references/sdk/data/index.md +18 -32
  25. package/skills/getagent/references/sdk/data/news.md +52 -58
  26. package/skills/getagent/references/sdk/data/playbook-supported.md +965 -1600
  27. package/skills/getagent/references/sdk/data/regulators.md +23 -43
  28. package/skills/getagent/references/sdk/data/sentiment.md +12 -34
  29. package/skills/getagent/references/sdk/data/uscongress.md +13 -21
  30. package/skills/getagent/references/sdk/data/web_search.md +3 -7
  31. package/skills/getagent/references/sdk/data/wikipedia.md +12 -18
  32. package/skills/getagent/scripts/validate.py +127 -1
@@ -23,7 +23,7 @@ are callable through the DataSDK wrapper.
23
23
  ### `etf.countries`
24
24
 
25
25
  ```python
26
- data.etf.countries(symbol=..., use_cache=True, provider=...)
26
+ data.etf.countries(symbol=..., use_cache=True)
27
27
  ```
28
28
 
29
29
  Summary: Countries
@@ -33,7 +33,6 @@ Summary: Countries
33
33
  | Endpoint ID | `etf.countries` |
34
34
  | HTTP | `GET` |
35
35
  | Path | `/inner/v1/agent-data/etf/countries` |
36
- | Default provider | - |
37
36
  | SDK | `supported` |
38
37
  | Host | `supported` |
39
38
  | Notes | - |
@@ -42,16 +41,15 @@ Summary: Countries
42
41
 
43
42
  | Param | Required | Type | Default | Notes |
44
43
  |---|---|---|---|---|
45
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, tmx. |
46
- | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) |
47
- | `provider` | `yes` | `string` | `-` | enum: fmp, tmx |
44
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
45
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. |
48
46
 
49
47
  ---
50
48
 
51
49
  ### `etf.discovery.active`
52
50
 
53
51
  ```python
54
- data.etf.discovery.active(sort='desc', limit=10, provider='wsj')
52
+ data.etf.discovery.active(sort='desc', limit=10)
55
53
  ```
56
54
 
57
55
  Summary: Active
@@ -61,7 +59,6 @@ Summary: Active
61
59
  | Endpoint ID | `etf.discovery.active` |
62
60
  | HTTP | `GET` |
63
61
  | Path | `/inner/v1/agent-data/etf/discovery/active` |
64
- | Default provider | `wsj` |
65
62
  | SDK | `supported` |
66
63
  | Host | `supported` |
67
64
  | Notes | - |
@@ -72,14 +69,13 @@ Summary: Active
72
69
  |---|---|---|---|---|
73
70
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
74
71
  | `limit` | `no` | `integer` | `10` | The number of data entries to return. |
75
- | `provider` | `no` | `string` | `wsj` | - |
76
72
 
77
73
  ---
78
74
 
79
75
  ### `etf.discovery.gainers`
80
76
 
81
77
  ```python
82
- data.etf.discovery.gainers(sort='desc', limit=10, provider='wsj')
78
+ data.etf.discovery.gainers(sort='desc', limit=10)
83
79
  ```
84
80
 
85
81
  Summary: Gainers
@@ -89,7 +85,6 @@ Summary: Gainers
89
85
  | Endpoint ID | `etf.discovery.gainers` |
90
86
  | HTTP | `GET` |
91
87
  | Path | `/inner/v1/agent-data/etf/discovery/gainers` |
92
- | Default provider | `wsj` |
93
88
  | SDK | `supported` |
94
89
  | Host | `supported` |
95
90
  | Notes | - |
@@ -100,14 +95,13 @@ Summary: Gainers
100
95
  |---|---|---|---|---|
101
96
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
102
97
  | `limit` | `no` | `integer` | `10` | The number of data entries to return. |
103
- | `provider` | `no` | `string` | `wsj` | - |
104
98
 
105
99
  ---
106
100
 
107
101
  ### `etf.discovery.losers`
108
102
 
109
103
  ```python
110
- data.etf.discovery.losers(sort='desc', limit=10, provider='wsj')
104
+ data.etf.discovery.losers(sort='desc', limit=10)
111
105
  ```
112
106
 
113
107
  Summary: Losers
@@ -117,7 +111,6 @@ Summary: Losers
117
111
  | Endpoint ID | `etf.discovery.losers` |
118
112
  | HTTP | `GET` |
119
113
  | Path | `/inner/v1/agent-data/etf/discovery/losers` |
120
- | Default provider | `wsj` |
121
114
  | SDK | `supported` |
122
115
  | Host | `supported` |
123
116
  | Notes | - |
@@ -128,14 +121,13 @@ Summary: Losers
128
121
  |---|---|---|---|---|
129
122
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
130
123
  | `limit` | `no` | `integer` | `10` | The number of data entries to return. |
131
- | `provider` | `no` | `string` | `wsj` | - |
132
124
 
133
125
  ---
134
126
 
135
127
  ### `etf.equity_exposure`
136
128
 
137
129
  ```python
138
- data.etf.equity_exposure(symbol=..., provider='fmp')
130
+ data.etf.equity_exposure(symbol=...)
139
131
  ```
140
132
 
141
133
  Summary: Equity Exposure
@@ -145,7 +137,6 @@ Summary: Equity Exposure
145
137
  | Endpoint ID | `etf.equity_exposure` |
146
138
  | HTTP | `GET` |
147
139
  | Path | `/inner/v1/agent-data/etf/equity_exposure` |
148
- | Default provider | `fmp` |
149
140
  | SDK | `supported` |
150
141
  | Host | `supported` |
151
142
  | Notes | - |
@@ -154,15 +145,14 @@ Summary: Equity Exposure
154
145
 
155
146
  | Param | Required | Type | Default | Notes |
156
147
  |---|---|---|---|---|
157
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (underlying equity) Multiple comma separated items allowed for provider(s): fmp. |
158
- | `provider` | `no` | `string` | `fmp` | - |
148
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (underlying equity) Multiple comma separated items allowed |
159
149
 
160
150
  ---
161
151
 
162
152
  ### `etf.historical`
163
153
 
164
154
  ```python
165
- data.etf.historical(symbol=..., start_time=None, end_time=None, interval='1d', adjustment='splits_only', extended_hours=False, use_cache=True, start_clock_time=None, end_clock_time=None, timezone='America/New_York', source='realtime', include_actions=True, provider=...)
155
+ data.etf.historical(symbol=..., start_time=None, end_time=None, interval='1d', adjustment='splits_only', extended_hours=False, use_cache=True, start_clock_time=None, end_clock_time=None, timezone='America/New_York', source='realtime', include_actions=True)
166
156
  ```
167
157
 
168
158
  Summary: Historical
@@ -172,7 +162,6 @@ Summary: Historical
172
162
  | Endpoint ID | `etf.historical` |
173
163
  | HTTP | `GET` |
174
164
  | Path | `/inner/v1/agent-data/etf/historical` |
175
- | Default provider | - |
176
165
  | SDK | `supported` |
177
166
  | Host | `supported` |
178
167
  | Notes | - |
@@ -181,26 +170,25 @@ Summary: Historical
181
170
 
182
171
  | Param | Required | Type | Default | Notes |
183
172
  |---|---|---|---|---|
184
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, cboe, fmp, tiingo, tmx, tradier, yfinance.; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). (provider: intrinio) |
173
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). |
185
174
  | `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
186
175
  | `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
187
- | `interval` | `no` | `string | integer` | `1d` | Time interval of the data to return. (provider: alpha_vantage,cboe,fmp,intrinio,tiingo,tmx,tradier, yfinance) |
188
- | `adjustment` | `no` | `string` | `splits_only` | The adjustment factor to apply. 'splits_only' is not supported for intraday data. (provider: alpha_vantage); Type of adjustment for historical prices. Only applies to daily data. (provider: fmp); The adjustment factor to apply. Only valid for daily data. (provider: tmx); The adjustment factor to apply. Default is splits only. (provider: yfinance) |
189
- | `extended_hours` | `no` | `boolean` | `false` | Include Pre and Post market data. (provider: alpha_vantage,tradier, yfinance) |
190
- | `use_cache` | `no` | `boolean` | `true` | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. (provider: cboe) |
191
- | `start_clock_time` | `no` | `string | null` | `-` | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) |
192
- | `end_clock_time` | `no` | `string | null` | `-` | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio) |
193
- | `timezone` | `no` | `string | null` | `America/New_York` | Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) |
194
- | `source` | `no` | `string` | `realtime` | enum: realtime, delayed, nasdaq_basic The source of the data. (provider: intrinio) |
195
- | `include_actions` | `no` | `boolean` | `true` | Include dividends and stock splits in results. (provider: yfinance) |
196
- | `provider` | `yes` | `string` | `-` | enum: alpha_vantage, cboe, fmp, intrinio, tiingo, tmx, tradier, yfinance |
176
+ | `interval` | `no` | `string | integer` | `1d` | Time interval of the data to return. |
177
+ | `adjustment` | `no` | `string` | `splits_only` | The adjustment factor to apply. 'splits_only' is not supported for intraday data.; Type of adjustment for historical prices. Only applies to daily data.; The adjustment factor to apply. Only valid for daily data.; The adjustment factor to apply. Default is splits only. |
178
+ | `extended_hours` | `no` | `boolean` | `false` | Include Pre and Post market data. |
179
+ | `use_cache` | `no` | `boolean` | `true` | When True, the company directories will be cached for 24 hours and are used to validate symbols. The results of the function are not cached. Set as False to bypass. |
180
+ | `start_clock_time` | `no` | `string | null` | `-` | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. |
181
+ | `end_clock_time` | `no` | `string | null` | `-` | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. |
182
+ | `timezone` | `no` | `string | null` | `America/New_York` | Timezone of the data, in the IANA format (Continent/City). |
183
+ | `source` | `no` | `string` | `realtime` | enum: realtime, delayed, nasdaq_basic The source of the data. |
184
+ | `include_actions` | `no` | `boolean` | `true` | Include dividends and stock splits in results. |
197
185
 
198
186
  ---
199
187
 
200
188
  ### `etf.holdings`
201
189
 
202
190
  ```python
203
- data.etf.holdings(symbol=..., date=None, use_cache=True, provider=...)
191
+ data.etf.holdings(symbol=..., date=None, use_cache=True)
204
192
  ```
205
193
 
206
194
  Summary: Holdings
@@ -210,7 +198,6 @@ Summary: Holdings
210
198
  | Endpoint ID | `etf.holdings` |
211
199
  | HTTP | `GET` |
212
200
  | Path | `/inner/v1/agent-data/etf/holdings` |
213
- | Default provider | - |
214
201
  | SDK | `supported` |
215
202
  | Host | `supported` |
216
203
  | Notes | - |
@@ -220,16 +207,15 @@ Summary: Holdings
220
207
  | Param | Required | Type | Default | Notes |
221
208
  |---|---|---|---|---|
222
209
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (ETF) |
223
- | `date` | `no` | `string | null` | `-` | A specific date to get data for. (provider: intrinio) |
224
- | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) |
225
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, tmx |
210
+ | `date` | `no` | `string | null` | `-` | A specific date to get data for. |
211
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. |
226
212
 
227
213
  ---
228
214
 
229
215
  ### `etf.info`
230
216
 
231
217
  ```python
232
- data.etf.info(symbol=..., use_cache=True, provider=...)
218
+ data.etf.info(symbol=..., use_cache=True)
233
219
  ```
234
220
 
235
221
  Summary: Info
@@ -239,7 +225,6 @@ Summary: Info
239
225
  | Endpoint ID | `etf.info` |
240
226
  | HTTP | `GET` |
241
227
  | Path | `/inner/v1/agent-data/etf/info` |
242
- | Default provider | - |
243
228
  | SDK | `supported` |
244
229
  | Host | `supported` |
245
230
  | Notes | - |
@@ -248,16 +233,15 @@ Summary: Info
248
233
 
249
234
  | Param | Required | Type | Default | Notes |
250
235
  |---|---|---|---|---|
251
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance. |
252
- | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) |
253
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, tmx, yfinance |
236
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (ETF) Multiple comma separated items allowed |
237
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. |
254
238
 
255
239
  ---
256
240
 
257
241
  ### `etf.nport_disclosure`
258
242
 
259
243
  ```python
260
- data.etf.nport_disclosure(symbol=..., year=None, quarter=None, use_cache=True, provider=...)
244
+ data.etf.nport_disclosure(symbol=..., year=None, quarter=None, use_cache=True)
261
245
  ```
262
246
 
263
247
  Summary: Nport Disclosure
@@ -267,7 +251,6 @@ Summary: Nport Disclosure
267
251
  | Endpoint ID | `etf.nport_disclosure` |
268
252
  | HTTP | `GET` |
269
253
  | Path | `/inner/v1/agent-data/etf/nport_disclosure` |
270
- | Default provider | - |
271
254
  | SDK | `supported` |
272
255
  | Host | `supported` |
273
256
  | Notes | - |
@@ -279,15 +262,14 @@ Summary: Nport Disclosure
279
262
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (Fund ticker or CIK) |
280
263
  | `year` | `no` | `integer | null` | `-` | Reporting year of the filing. Default is the year for the most recent, reported, quarter. |
281
264
  | `quarter` | `no` | `integer | null` | `-` | Reporting quarter of the filing. Default is the most recent, reported, quarter. |
282
- | `use_cache` | `no` | `boolean` | `true` | Whether or not to use cache for the request. (provider: sec) |
283
- | `provider` | `yes` | `string` | `-` | enum: fmp, sec |
265
+ | `use_cache` | `no` | `boolean` | `true` | Whether or not to use cache for the request. |
284
266
 
285
267
  ---
286
268
 
287
269
  ### `etf.price_performance`
288
270
 
289
271
  ```python
290
- data.etf.price_performance(symbol=..., return_type='trailing', adjustment='splits_and_dividends', provider=...)
272
+ data.etf.price_performance(symbol=..., return_type='trailing', adjustment='splits_and_dividends')
291
273
  ```
292
274
 
293
275
  Summary: Price Performance
@@ -297,7 +279,6 @@ Summary: Price Performance
297
279
  | Endpoint ID | `etf.price_performance` |
298
280
  | HTTP | `GET` |
299
281
  | Path | `/inner/v1/agent-data/etf/price_performance` |
300
- | Default provider | - |
301
282
  | SDK | `supported` |
302
283
  | Host | `supported` |
303
284
  | Notes | - |
@@ -306,17 +287,16 @@ Summary: Price Performance
306
287
 
307
288
  | Param | Required | Type | Default | Notes |
308
289
  |---|---|---|---|---|
309
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio. |
310
- | `return_type` | `no` | `string` | `trailing` | enum: trailing, calendar The type of returns to return, a trailing or calendar window. (provider: intrinio) |
311
- | `adjustment` | `no` | `string` | `splits_and_dividends` | enum: splits_only, splits_and_dividends The adjustment factor, 'splits_only' will return pure price performance. (provider: intrinio) |
312
- | `provider` | `yes` | `string` | `-` | enum: finviz, fmp, intrinio |
290
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
291
+ | `return_type` | `no` | `string` | `trailing` | enum: trailing, calendar The type of returns to return, a trailing or calendar window. |
292
+ | `adjustment` | `no` | `string` | `splits_and_dividends` | enum: splits_only, splits_and_dividends The adjustment factor, 'splits_only' will return pure price performance. |
313
293
 
314
294
  ---
315
295
 
316
296
  ### `etf.search`
317
297
 
318
298
  ```python
319
- data.etf.search(query='', exchange=None, country=None, div_freq=None, sort_by=None, use_cache=True, provider=...)
299
+ data.etf.search(query='', exchange=None, country=None, div_freq=None, sort_by=None, use_cache=True)
320
300
  ```
321
301
 
322
302
  Summary: Search
@@ -326,7 +306,6 @@ Summary: Search
326
306
  | Endpoint ID | `etf.search` |
327
307
  | HTTP | `GET` |
328
308
  | Path | `/inner/v1/agent-data/etf/search` |
329
- | Default provider | - |
330
309
  | SDK | `supported` |
331
310
  | Host | `supported` |
332
311
  | Notes | - |
@@ -336,19 +315,18 @@ Summary: Search
336
315
  | Param | Required | Type | Default | Notes |
337
316
  |---|---|---|---|---|
338
317
  | `query` | `no` | `string | null` | `` | Search query. |
339
- | `exchange` | `no` | `string | null` | `-` | Exchange where the ETF is listed. If not provided, all exchanges are searched. (provider: fmp); Target a specific exchange by providing the MIC code. (provider: intrinio) |
340
- | `country` | `no` | `string | null` | `-` | Filter by country. Accepts ISO 3166-1 alpha-2 codes (e.g., 'US', 'DE'), alpha-3 codes (e.g., 'USA'), or country names (e.g., 'United States', 'united_states'). (provider: fmp) |
341
- | `div_freq` | `no` | `string | null` | `-` | The dividend payment frequency. (provider: tmx) |
342
- | `sort_by` | `no` | `string | null` | `-` | The column to sort by. (provider: tmx) |
343
- | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) |
344
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, tmx |
318
+ | `exchange` | `no` | `string | null` | `-` | Exchange where the ETF is listed. If not provided, all exchanges are searched.; Target a specific exchange by providing the MIC code. |
319
+ | `country` | `no` | `string | null` | `-` | Filter by country. Accepts ISO 3166-1 alpha-2 codes (e.g., 'US', 'DE'), alpha-3 codes (e.g., 'USA'), or country names (e.g., 'United States', 'united_states'). |
320
+ | `div_freq` | `no` | `string | null` | `-` | The dividend payment frequency. |
321
+ | `sort_by` | `no` | `string | null` | `-` | The column to sort by. |
322
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. |
345
323
 
346
324
  ---
347
325
 
348
326
  ### `etf.sectors`
349
327
 
350
328
  ```python
351
- data.etf.sectors(symbol=..., use_cache=True, provider=...)
329
+ data.etf.sectors(symbol=..., use_cache=True)
352
330
  ```
353
331
 
354
332
  Summary: Sectors
@@ -358,7 +336,6 @@ Summary: Sectors
358
336
  | Endpoint ID | `etf.sectors` |
359
337
  | HTTP | `GET` |
360
338
  | Path | `/inner/v1/agent-data/etf/sectors` |
361
- | Default provider | - |
362
339
  | SDK | `supported` |
363
340
  | Host | `supported` |
364
341
  | Notes | - |
@@ -367,6 +344,5 @@ Summary: Sectors
367
344
 
368
345
  | Param | Required | Type | Default | Notes |
369
346
  |---|---|---|---|---|
370
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (ETF) Multiple comma separated items allowed for provider(s): fmp, tmx. |
371
- | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. (provider: tmx) |
372
- | `provider` | `yes` | `string` | `-` | enum: fmp, tmx |
347
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. (ETF) Multiple comma separated items allowed |
348
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use a cached request. All ETF data comes from a single JSON file that is updated daily. To bypass, set to False. If True, the data will be cached for 4 hours. |
@@ -17,7 +17,7 @@ are callable through the DataSDK wrapper.
17
17
  ### `famafrench.breakpoints`
18
18
 
19
19
  ```python
20
- data.famafrench.breakpoints(breakpoint_type='me', start_date=None, end_date=None, provider='famafrench')
20
+ data.famafrench.breakpoints(breakpoint_type='me', start_date=None, end_date=None)
21
21
  ```
22
22
 
23
23
  Summary: Breakpoints
@@ -27,7 +27,6 @@ Summary: Breakpoints
27
27
  | Endpoint ID | `famafrench.breakpoints` |
28
28
  | HTTP | `GET` |
29
29
  | Path | `/inner/v1/agent-data/famafrench/breakpoints` |
30
- | Default provider | `famafrench` |
31
30
  | SDK | `supported` |
32
31
  | Host | `supported` |
33
32
  | Notes | - |
@@ -36,17 +35,16 @@ Summary: Breakpoints
36
35
 
37
36
  | Param | Required | Type | Default | Notes |
38
37
  |---|---|---|---|---|
39
- | `breakpoint_type` | `no` | `string` | `me` | Type of breakpoint to fetch. The breakpoints for month t use all NYSE stocks that have a CRSP share code of 10 or 11 and have good shares and price data. We exclude closed end funds and REITs. Breakpoints are computed either monthly or annually, see the description of each breakpoint type below. Data contains every fifth percentile, from 5% to 100%. ME -- Market Equity. Market equity (size) is price times shares outstanding. Price and shares outstanding are from CRSP. ME breakpoints are computed for each month. It is price times shares outstanding (divided by 1,000,000) at month end. BE/ME ----- BE/ME breakpoints are computed at the end of each June. The BE used in June of year t is the book equity for the last fiscal year end in t-1. ME is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) BE for the last fiscal year end in t-1. Operating Profitability ----------------------- Operating Profitability breakpoints are computed at the end of each June. OP for June of year t is annual revenues minus - cost of goods sold - interest expense - selling, general, and administrative expenses divided by book equity for the last fiscal year end in t-1. Please be aware that some of the value-weight averages of operating profitability for deciles 1 and 10 are extreme. These are driven by extraordinary values of OP for individual firms. We have spot checked the accounting data that produce the extraordinary values and all the numbers we examined accurately reflect the data in the firm's accounting statements. The breakpoints for year t use all NYSE stocks for which we have (positive) book equity data for t-1, non-missing revenues data for t-1, and non-missing data for at least one of the following: - cost of goods sold - selling, general and administrative expenses - interest expense for t-1. Investment ---------- Investment breakpoints are computed at the end of each June. Inv used in June of year t is the change in total assets from the fiscal year ending in year t-2 to the fiscal year ending in t-1, divided by t-2 total assets. The breakpoints for year t use all NYSE stocks for which we have total assets data for t-2 and t-1. E/P --- E/P (in percent) breakpoints are computed at the end of each June. The E used in June of year t is the earnings for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) earnings for the last fiscal year end in t-1. CF/P ---- CF/P (in percent) breakpoints is computed at the end of each June. The CF used in June of year t is the cash flow for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) cash flow for the last fiscal year end in t-1. D/P --- D/P (in percent) breakpoints are computed at the end of each June. The dividend yield in June of year t is the total dividends paid from July of t-1 to June of t per dollar of equity in June of t. The breakpoints for year t use NYSE stocks for which we have at least seven months (to compute the dividend yield) from July of t-1 to June of t. (Only six monthly returns are required in June 1926.) We do not include stocks that pay no dividends from July of t-1 to June of t. Prior 2-12 ---------- Prior return breakpoints are computed for each month. The prior return at the end of month t is the cumulative return from month t-11 to month t-1. The breakpoints for month t use NYSE stocks. To be included, a stock must have a price for the end of month t-12 and a good return for t-1. In addition, any missing returns from t-11 to t-2 must be -99.0, CRSP's code for a missing price. (provider: famafrench) |
40
- | `start_date` | `no` | `string | null` | `-` | Start date for the data. (provider: famafrench) |
41
- | `end_date` | `no` | `string | null` | `-` | End date for the data. (provider: famafrench) |
42
- | `provider` | `no` | `string` | `famafrench` | - |
38
+ | `breakpoint_type` | `no` | `string` | `me` | Type of breakpoint to fetch. The breakpoints for month t use all NYSE stocks that have a CRSP share code of 10 or 11 and have good shares and price data. We exclude closed end funds and REITs. Breakpoints are computed either monthly or annually, see the description of each breakpoint type below. Data contains every fifth percentile, from 5% to 100%. ME -- Market Equity. Market equity (size) is price times shares outstanding. Price and shares outstanding are from CRSP. ME breakpoints are computed for each month. It is price times shares outstanding (divided by 1,000,000) at month end. BE/ME ----- BE/ME breakpoints are computed at the end of each June. The BE used in June of year t is the book equity for the last fiscal year end in t-1. ME is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) BE for the last fiscal year end in t-1. Operating Profitability ----------------------- Operating Profitability breakpoints are computed at the end of each June. OP for June of year t is annual revenues minus - cost of goods sold - interest expense - selling, general, and administrative expenses divided by book equity for the last fiscal year end in t-1. Please be aware that some of the value-weight averages of operating profitability for deciles 1 and 10 are extreme. These are driven by extraordinary values of OP for individual firms. We have spot checked the accounting data that produce the extraordinary values and all the numbers we examined accurately reflect the data in the firm's accounting statements. The breakpoints for year t use all NYSE stocks for which we have (positive) book equity data for t-1, non-missing revenues data for t-1, and non-missing data for at least one of the following: - cost of goods sold - selling, general and administrative expenses - interest expense for t-1. Investment ---------- Investment breakpoints are computed at the end of each June. Inv used in June of year t is the change in total assets from the fiscal year ending in year t-2 to the fiscal year ending in t-1, divided by t-2 total assets. The breakpoints for year t use all NYSE stocks for which we have total assets data for t-2 and t-1. E/P --- E/P (in percent) breakpoints are computed at the end of each June. The E used in June of year t is the earnings for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) earnings for the last fiscal year end in t-1. CF/P ---- CF/P (in percent) breakpoints is computed at the end of each June. The CF used in June of year t is the cash flow for the last fiscal year end in t-1. P (actually ME) is price times shares outstanding at the end of December of t-1. The breakpoints for year t use all NYSE stocks for which we have ME for December of t-1 and (positive) cash flow for the last fiscal year end in t-1. D/P --- D/P (in percent) breakpoints are computed at the end of each June. The dividend yield in June of year t is the total dividends paid from July of t-1 to June of t per dollar of equity in June of t. The breakpoints for year t use NYSE stocks for which we have at least seven months (to compute the dividend yield) from July of t-1 to June of t. (Only six monthly returns are required in June 1926.) We do not include stocks that pay no dividends from July of t-1 to June of t. Prior 2-12 ---------- Prior return breakpoints are computed for each month. The prior return at the end of month t is the cumulative return from month t-11 to month t-1. The breakpoints for month t use NYSE stocks. To be included, a stock must have a price for the end of month t-12 and a good return for t-1. In addition, any missing returns from t-11 to t-2 must be -99.0, CRSP's code for a missing price. |
39
+ | `start_date` | `no` | `string | null` | `-` | Start date for the data. |
40
+ | `end_date` | `no` | `string | null` | `-` | End date for the data. |
43
41
 
44
42
  ---
45
43
 
46
44
  ### `famafrench.country_portfolio_returns`
47
45
 
48
46
  ```python
49
- data.famafrench.country_portfolio_returns(country='united_kingdom', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None, provider='famafrench')
47
+ data.famafrench.country_portfolio_returns(country='united_kingdom', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None)
50
48
  ```
51
49
 
52
50
  Summary: Country Portfolio Returns
@@ -56,7 +54,6 @@ Summary: Country Portfolio Returns
56
54
  | Endpoint ID | `famafrench.country_portfolio_returns` |
57
55
  | HTTP | `GET` |
58
56
  | Path | `/inner/v1/agent-data/famafrench/country_portfolio_returns` |
59
- | Default provider | `famafrench` |
60
57
  | SDK | `supported` |
61
58
  | Host | `supported` |
62
59
  | Notes | - |
@@ -65,21 +62,20 @@ Summary: Country Portfolio Returns
65
62
 
66
63
  | Param | Required | Type | Default | Notes |
67
64
  |---|---|---|---|---|
68
- | `country` | `no` | `string` | `united_kingdom` | enum: austria, australia, belgium, canada, denmark, finland, france, germany, hong_kong, ireland, italy, japan, malaysia, netherlands, new_zealand, norway, singapore, spain, sweden, switzerland, united_kingdom Country to fetch the portfolio returns for. (provider: famafrench) |
69
- | `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'. (provider: famafrench) |
70
- | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'. (provider: famafrench) |
71
- | `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends. (provider: famafrench) |
72
- | `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data. (provider: famafrench) |
73
- | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. (provider: famafrench) |
74
- | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. (provider: famafrench) |
75
- | `provider` | `no` | `string` | `famafrench` | - |
65
+ | `country` | `no` | `string` | `united_kingdom` | enum: austria, australia, belgium, canada, denmark, finland, france, germany, hong_kong, ireland, italy, japan, malaysia, netherlands, new_zealand, norway, singapore, spain, sweden, switzerland, united_kingdom Country to fetch the portfolio returns for. |
66
+ | `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'. |
67
+ | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'. |
68
+ | `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends. |
69
+ | `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data. |
70
+ | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
71
+ | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |
76
72
 
77
73
  ---
78
74
 
79
75
  ### `famafrench.factors`
80
76
 
81
77
  ```python
82
- data.famafrench.factors(region='america', factor='3_factors', frequency='monthly', start_date=None, end_date=None, provider='famafrench')
78
+ data.famafrench.factors(region='america', factor='3_factors', frequency='monthly', start_date=None, end_date=None)
83
79
  ```
84
80
 
85
81
  Summary: Factors
@@ -89,7 +85,6 @@ Summary: Factors
89
85
  | Endpoint ID | `famafrench.factors` |
90
86
  | HTTP | `GET` |
91
87
  | Path | `/inner/v1/agent-data/famafrench/factors` |
92
- | Default provider | `famafrench` |
93
88
  | SDK | `supported` |
94
89
  | Host | `supported` |
95
90
  | Notes | - |
@@ -98,19 +93,18 @@ Summary: Factors
98
93
 
99
94
  | Param | Required | Type | Default | Notes |
100
95
  |---|---|---|---|---|
101
- | `region` | `no` | `string` | `america` | Region of focus. Default is America. (provider: famafrench) |
102
- | `factor` | `no` | `string` | `3_factors` | Factor to fetch. Default is the 3-Factor Model.Short/long-term reversals are available only for America. (provider: famafrench) |
103
- | `frequency` | `no` | `string` | `monthly` | Frequency of the factor data.Not all are available for all regions, and intervals depend on the factor selected. Weekly is only available for the US 3-Factor Model. (provider: famafrench) |
104
- | `start_date` | `no` | `string | null` | `-` | Start date of the data. Defaults to the complete data range. (provider: famafrench) |
105
- | `end_date` | `no` | `string | null` | `-` | End date of the data. Defaults to the complete data range. (provider: famafrench) |
106
- | `provider` | `no` | `string` | `famafrench` | - |
96
+ | `region` | `no` | `string` | `america` | Region of focus. Default is America. |
97
+ | `factor` | `no` | `string` | `3_factors` | Factor to fetch. Default is the 3-Factor Model.Short/long-term reversals are available only for America. |
98
+ | `frequency` | `no` | `string` | `monthly` | Frequency of the factor data.Not all are available for all regions, and intervals depend on the factor selected. Weekly is only available for the US 3-Factor Model. |
99
+ | `start_date` | `no` | `string | null` | `-` | Start date of the data. Defaults to the complete data range. |
100
+ | `end_date` | `no` | `string | null` | `-` | End date of the data. Defaults to the complete data range. |
107
101
 
108
102
  ---
109
103
 
110
104
  ### `famafrench.international_index_returns`
111
105
 
112
106
  ```python
113
- data.famafrench.international_index_returns(index='all', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None, provider='famafrench')
107
+ data.famafrench.international_index_returns(index='all', measure='usd', frequency='monthly', dividends=None, all_data_items_required=None, start_date=None, end_date=None)
114
108
  ```
115
109
 
116
110
  Summary: International Index Returns
@@ -120,7 +114,6 @@ Summary: International Index Returns
120
114
  | Endpoint ID | `famafrench.international_index_returns` |
121
115
  | HTTP | `GET` |
122
116
  | Path | `/inner/v1/agent-data/famafrench/international_index_returns` |
123
- | Default provider | `famafrench` |
124
117
  | SDK | `supported` |
125
118
  | Host | `supported` |
126
119
  | Notes | - |
@@ -129,21 +122,20 @@ Summary: International Index Returns
129
122
 
130
123
  | Param | Required | Type | Default | Notes |
131
124
  |---|---|---|---|---|
132
- | `index` | `no` | `string` | `all` | International index to fetch the portfolio returns for. Defaults to 'all'. (provider: famafrench) |
133
- | `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'. (provider: famafrench) |
134
- | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'. (provider: famafrench) |
135
- | `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends. (provider: famafrench) |
136
- | `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data. (provider: famafrench) |
137
- | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. (provider: famafrench) |
138
- | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. (provider: famafrench) |
139
- | `provider` | `no` | `string` | `famafrench` | - |
125
+ | `index` | `no` | `string` | `all` | International index to fetch the portfolio returns for. Defaults to 'all'. |
126
+ | `measure` | `no` | `string` | `usd` | The measure to fetch for the portfolio. Only 'annual' frequency is supported for 'ratios'. |
127
+ | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when `measure` is set to 'ratios'. |
128
+ | `dividends` | `no` | `boolean | null` | `-` | When False, portoflios exclude dividends. |
129
+ | `all_data_items_required` | `no` | `boolean | null` | `-` | If True (default), includes firms with data for all four ratios. When False, includes only firms with Book-to-Market (B/M) data. |
130
+ | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
131
+ | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |
140
132
 
141
133
  ---
142
134
 
143
135
  ### `famafrench.regional_portfolio_returns`
144
136
 
145
137
  ```python
146
- data.famafrench.regional_portfolio_returns(portfolio='developed_ex_us_6_portfolios_me_op', measure='value', frequency='monthly', start_date=None, end_date=None, provider='famafrench')
138
+ data.famafrench.regional_portfolio_returns(portfolio='developed_ex_us_6_portfolios_me_op', measure='value', frequency='monthly', start_date=None, end_date=None)
147
139
  ```
148
140
 
149
141
  Summary: Regional Portfolio Returns
@@ -153,7 +145,6 @@ Summary: Regional Portfolio Returns
153
145
  | Endpoint ID | `famafrench.regional_portfolio_returns` |
154
146
  | HTTP | `GET` |
155
147
  | Path | `/inner/v1/agent-data/famafrench/regional_portfolio_returns` |
156
- | Default provider | `famafrench` |
157
148
  | SDK | `supported` |
158
149
  | Host | `supported` |
159
150
  | Notes | - |
@@ -162,19 +153,18 @@ Summary: Regional Portfolio Returns
162
153
 
163
154
  | Param | Required | Type | Default | Notes |
164
155
  |---|---|---|---|---|
165
- | `portfolio` | `no` | `string` | `developed_ex_us_6_portfolios_me_op` | enum: asia_pacific_ex_japan_25_portfolios_me_be-me, asia_pacific_ex_japan_25_portfolios_me_be-me_daily, asia_pacific_ex_japan_25_portfolios_me_inv, asia_pacific_ex_japan_25_portfolios_me_inv_daily, asia_pacific_ex_japan_25_portfolios_me_op, asia_pacific_ex_japan_25_portfolios_me_op_daily, asia_pacific_ex_japan_25_portfolios_me_prior_12_2, asia_pacific_ex_japan_25_portfolios_me_prior_250_20_daily, asia_pacific_ex_japan_32_portfolios_me_be-me_inv_2x4x4, asia_pacific_ex_japan_32_portfolios_me_be-me_op_2x4x4, asia_pacific_ex_japan_32_portfolios_me_inv_op_2x4x4, asia_pacific_ex_japan_6_portfolios_me_be-me, asia_pacific_ex_japan_6_portfolios_me_be-me_daily, asia_pacific_ex_japan_6_portfolios_me_inv, asia_pacific_ex_japan_6_portfolios_me_inv_daily, asia_pacific_ex_japan_6_portfolios_me_op, asia_pacific_ex_japan_6_portfolios_me_op_daily, asia_pacific_ex_japan_6_portfolios_me_prior_12_2, asia_pacific_ex_japan_6_portfolios_me_prior_250_20_daily, developed_25_portfolios_me_be-me, developed_25_portfolios_me_be-me_daily, developed_25_portfolios_me_inv, developed_25_portfolios_me_inv_daily, developed_25_portfolios_me_op, developed_25_portfolios_me_op_daily, developed_25_portfolios_me_prior_12_2, developed_25_portfolios_me_prior_250_20_daily, developed_32_portfolios_me_be-me_inv_2x4x4, developed_32_portfolios_me_be-me_op_2x4x4, developed_32_portfolios_me_inv_op_2x4x4, developed_6_portfolios_me_be-me, developed_6_portfolios_me_be-me_daily, developed_6_portfolios_me_inv, developed_6_portfolios_me_inv_daily, developed_6_portfolios_me_op, developed_6_portfolios_me_op_daily, developed_6_portfolios_me_prior_12_2, developed_6_portfolios_me_prior_250_20_daily, developed_ex_us_25_portfolios_me_be-me, developed_ex_us_25_portfolios_me_be-me_daily, developed_ex_us_25_portfolios_me_inv, developed_ex_us_25_portfolios_me_inv_daily, developed_ex_us_25_portfolios_me_op, developed_ex_us_25_portfolios_me_op_daily, developed_ex_us_25_portfolios_me_prior_12_2, developed_ex_us_25_portfolios_me_prior_250_20_daily, developed_ex_us_32_portfolios_me_be-me_inv_2x4x4, developed_ex_us_32_portfolios_me_be-me_op_2x4x4, developed_ex_us_32_portfolios_me_inv_op_2x4x4, developed_ex_us_6_portfolios_me_be-me, developed_ex_us_6_portfolios_me_be-me_daily, developed_ex_us_6_portfolios_me_inv, developed_ex_us_6_portfolios_me_inv_daily, developed_ex_us_6_portfolios_me_op, developed_ex_us_6_portfolios_me_op_daily, developed_ex_us_6_portfolios_me_prior_12_2, developed_ex_us_6_portfolios_me_prior_250_20_daily, emerging_markets_4_portfolios_be-me_inv, emerging_markets_4_portfolios_be-me_op, emerging_markets_4_portfolios_op_inv, emerging_markets_6_portfolios_me_be-me, emerging_markets_6_portfolios_me_inv, emerging_markets_6_portfolios_me_op, emerging_markets_6_portfolios_me_prior_12_2, europe_25_portfolios_me_be-me, europe_25_portfolios_me_be-me_daily, europe_25_portfolios_me_inv, europe_25_portfolios_me_inv_daily, europe_25_portfolios_me_op, europe_25_portfolios_me_op_daily, europe_25_portfolios_me_prior_12_2, europe_25_portfolios_me_prior_250_20_daily, europe_32_portfolios_me_be-me_inv_2x4x4, europe_32_portfolios_me_be-me_op_2x4x4, europe_32_portfolios_me_inv_op_2x4x4, europe_6_portfolios_me_be-me, europe_6_portfolios_me_be-me_daily, europe_6_portfolios_me_inv, europe_6_portfolios_me_inv_daily, europe_6_portfolios_me_op, europe_6_portfolios_me_op_daily, europe_6_portfolios_me_prior_12_2, europe_6_portfolios_me_prior_250_20_daily, japan_25_portfolios_me_be-me, japan_25_portfolios_me_be-me_daily, japan_25_portfolios_me_inv, japan_25_portfolios_me_inv_daily, japan_25_portfolios_me_op, japan_25_portfolios_me_op_daily, japan_25_portfolios_me_prior_12_2, japan_25_portfolios_me_prior_250_20_daily, japan_32_portfolios_me_be-me_inv_2x4x4, japan_32_portfolios_me_be-me_op_2x4x4, japan_32_portfolios_me_inv_op_2x4x4, japan_6_portfolios_me_be-me, japan_6_portfolios_me_be-me_daily, japan_6_portfolios_me_inv, japan_6_portfolios_me_inv_daily, japan_6_portfolios_me_op, japan_6_portfolios_me_op_daily, japan_6_portfolios_me_prior_12_2, japan_6_portfolios_me_prior_250_20_daily, north_america_25_portfolios_me_be-me, north_america_25_portfolios_me_be-me_daily, north_america_25_portfolios_me_inv, north_america_25_portfolios_me_inv_daily, north_america_25_portfolios_me_op, north_america_25_portfolios_me_op_daily, north_america_25_portfolios_me_prior_12_2, north_america_25_portfolios_me_prior_250_20_daily, north_america_32_portfolios_me_be-me_inv_2x4x4, north_america_32_portfolios_me_be-me_op_2x4x4, north_america_32_portfolios_me_inv_op_2x4x4, north_america_6_portfolios_me_be-me, north_america_6_portfolios_me_be-me_daily, north_america_6_portfolios_me_inv, north_america_6_portfolios_me_inv_daily, north_america_6_portfolios_me_op, north_america_6_portfolios_me_op_daily, north_america_6_portfolios_me_prior_12_2, north_america_6_portfolios_me_prior_250_20_daily The specific portfolio file to fetch. (provider: famafrench) |
166
- | `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio. (provider: famafrench) |
167
- | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when the portfolio ends with 'daily'. (provider: famafrench) |
168
- | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. (provider: famafrench) |
169
- | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. (provider: famafrench) |
170
- | `provider` | `no` | `string` | `famafrench` | - |
156
+ | `portfolio` | `no` | `string` | `developed_ex_us_6_portfolios_me_op` | enum: asia_pacific_ex_japan_25_portfolios_me_be-me, asia_pacific_ex_japan_25_portfolios_me_be-me_daily, asia_pacific_ex_japan_25_portfolios_me_inv, asia_pacific_ex_japan_25_portfolios_me_inv_daily, asia_pacific_ex_japan_25_portfolios_me_op, asia_pacific_ex_japan_25_portfolios_me_op_daily, asia_pacific_ex_japan_25_portfolios_me_prior_12_2, asia_pacific_ex_japan_25_portfolios_me_prior_250_20_daily, asia_pacific_ex_japan_32_portfolios_me_be-me_inv_2x4x4, asia_pacific_ex_japan_32_portfolios_me_be-me_op_2x4x4, asia_pacific_ex_japan_32_portfolios_me_inv_op_2x4x4, asia_pacific_ex_japan_6_portfolios_me_be-me, asia_pacific_ex_japan_6_portfolios_me_be-me_daily, asia_pacific_ex_japan_6_portfolios_me_inv, asia_pacific_ex_japan_6_portfolios_me_inv_daily, asia_pacific_ex_japan_6_portfolios_me_op, asia_pacific_ex_japan_6_portfolios_me_op_daily, asia_pacific_ex_japan_6_portfolios_me_prior_12_2, asia_pacific_ex_japan_6_portfolios_me_prior_250_20_daily, developed_25_portfolios_me_be-me, developed_25_portfolios_me_be-me_daily, developed_25_portfolios_me_inv, developed_25_portfolios_me_inv_daily, developed_25_portfolios_me_op, developed_25_portfolios_me_op_daily, developed_25_portfolios_me_prior_12_2, developed_25_portfolios_me_prior_250_20_daily, developed_32_portfolios_me_be-me_inv_2x4x4, developed_32_portfolios_me_be-me_op_2x4x4, developed_32_portfolios_me_inv_op_2x4x4, developed_6_portfolios_me_be-me, developed_6_portfolios_me_be-me_daily, developed_6_portfolios_me_inv, developed_6_portfolios_me_inv_daily, developed_6_portfolios_me_op, developed_6_portfolios_me_op_daily, developed_6_portfolios_me_prior_12_2, developed_6_portfolios_me_prior_250_20_daily, developed_ex_us_25_portfolios_me_be-me, developed_ex_us_25_portfolios_me_be-me_daily, developed_ex_us_25_portfolios_me_inv, developed_ex_us_25_portfolios_me_inv_daily, developed_ex_us_25_portfolios_me_op, developed_ex_us_25_portfolios_me_op_daily, developed_ex_us_25_portfolios_me_prior_12_2, developed_ex_us_25_portfolios_me_prior_250_20_daily, developed_ex_us_32_portfolios_me_be-me_inv_2x4x4, developed_ex_us_32_portfolios_me_be-me_op_2x4x4, developed_ex_us_32_portfolios_me_inv_op_2x4x4, developed_ex_us_6_portfolios_me_be-me, developed_ex_us_6_portfolios_me_be-me_daily, developed_ex_us_6_portfolios_me_inv, developed_ex_us_6_portfolios_me_inv_daily, developed_ex_us_6_portfolios_me_op, developed_ex_us_6_portfolios_me_op_daily, developed_ex_us_6_portfolios_me_prior_12_2, developed_ex_us_6_portfolios_me_prior_250_20_daily, emerging_markets_4_portfolios_be-me_inv, emerging_markets_4_portfolios_be-me_op, emerging_markets_4_portfolios_op_inv, emerging_markets_6_portfolios_me_be-me, emerging_markets_6_portfolios_me_inv, emerging_markets_6_portfolios_me_op, emerging_markets_6_portfolios_me_prior_12_2, europe_25_portfolios_me_be-me, europe_25_portfolios_me_be-me_daily, europe_25_portfolios_me_inv, europe_25_portfolios_me_inv_daily, europe_25_portfolios_me_op, europe_25_portfolios_me_op_daily, europe_25_portfolios_me_prior_12_2, europe_25_portfolios_me_prior_250_20_daily, europe_32_portfolios_me_be-me_inv_2x4x4, europe_32_portfolios_me_be-me_op_2x4x4, europe_32_portfolios_me_inv_op_2x4x4, europe_6_portfolios_me_be-me, europe_6_portfolios_me_be-me_daily, europe_6_portfolios_me_inv, europe_6_portfolios_me_inv_daily, europe_6_portfolios_me_op, europe_6_portfolios_me_op_daily, europe_6_portfolios_me_prior_12_2, europe_6_portfolios_me_prior_250_20_daily, japan_25_portfolios_me_be-me, japan_25_portfolios_me_be-me_daily, japan_25_portfolios_me_inv, japan_25_portfolios_me_inv_daily, japan_25_portfolios_me_op, japan_25_portfolios_me_op_daily, japan_25_portfolios_me_prior_12_2, japan_25_portfolios_me_prior_250_20_daily, japan_32_portfolios_me_be-me_inv_2x4x4, japan_32_portfolios_me_be-me_op_2x4x4, japan_32_portfolios_me_inv_op_2x4x4, japan_6_portfolios_me_be-me, japan_6_portfolios_me_be-me_daily, japan_6_portfolios_me_inv, japan_6_portfolios_me_inv_daily, japan_6_portfolios_me_op, japan_6_portfolios_me_op_daily, japan_6_portfolios_me_prior_12_2, japan_6_portfolios_me_prior_250_20_daily, north_america_25_portfolios_me_be-me, north_america_25_portfolios_me_be-me_daily, north_america_25_portfolios_me_inv, north_america_25_portfolios_me_inv_daily, north_america_25_portfolios_me_op, north_america_25_portfolios_me_op_daily, north_america_25_portfolios_me_prior_12_2, north_america_25_portfolios_me_prior_250_20_daily, north_america_32_portfolios_me_be-me_inv_2x4x4, north_america_32_portfolios_me_be-me_op_2x4x4, north_america_32_portfolios_me_inv_op_2x4x4, north_america_6_portfolios_me_be-me, north_america_6_portfolios_me_be-me_daily, north_america_6_portfolios_me_inv, north_america_6_portfolios_me_inv_daily, north_america_6_portfolios_me_op, north_america_6_portfolios_me_op_daily, north_america_6_portfolios_me_prior_12_2, north_america_6_portfolios_me_prior_250_20_daily The specific portfolio file to fetch. |
157
+ | `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio. |
158
+ | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored when the portfolio ends with 'daily'. |
159
+ | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
160
+ | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |
171
161
 
172
162
  ---
173
163
 
174
164
  ### `famafrench.us_portfolio_returns`
175
165
 
176
166
  ```python
177
- data.famafrench.us_portfolio_returns(portfolio='portfolios_formed_on_me', measure='value', frequency='monthly', start_date=None, end_date=None, provider='famafrench')
167
+ data.famafrench.us_portfolio_returns(portfolio='portfolios_formed_on_me', measure='value', frequency='monthly', start_date=None, end_date=None)
178
168
  ```
179
169
 
180
170
  Summary: Us Portfolio Returns
@@ -184,7 +174,6 @@ Summary: Us Portfolio Returns
184
174
  | Endpoint ID | `famafrench.us_portfolio_returns` |
185
175
  | HTTP | `GET` |
186
176
  | Path | `/inner/v1/agent-data/famafrench/us_portfolio_returns` |
187
- | Default provider | `famafrench` |
188
177
  | SDK | `supported` |
189
178
  | Host | `supported` |
190
179
  | Notes | - |
@@ -193,9 +182,8 @@ Summary: Us Portfolio Returns
193
182
 
194
183
  | Param | Required | Type | Default | Notes |
195
184
  |---|---|---|---|---|
196
- | `portfolio` | `no` | `string` | `portfolios_formed_on_me` | enum: portfolios_formed_on_me, portfolios_formed_on_me_wout_div, portfolios_formed_on_me_daily, portfolios_formed_on_be-me, portfolios_formed_on_be-me_wout_div, portfolios_formed_on_be-me_daily, portfolios_formed_on_op, portfolios_formed_on_op_wout_div, portfolios_formed_on_op_daily, portfolios_formed_on_inv, portfolios_formed_on_inv_wout_div, portfolios_formed_on_inv_daily, 6_portfolios_2x3, 6_portfolios_2x3_wout_div, 6_portfolios_2x3_weekly, 6_portfolios_2x3_daily, 25_portfolios_5x5, 25_portfolios_5x5_wout_div, 25_portfolios_5x5_daily, 100_portfolios_10x10, 100_portfolios_10x10_wout_div, 100_portfolios_10x10_daily, 6_portfolios_me_op_2x3, 6_portfolios_me_op_2x3_wout_div, 6_portfolios_me_op_2x3_daily, 25_portfolios_me_op_5x5, 25_portfolios_me_op_5x5_wout_div, 25_portfolios_me_op_5x5_daily, 100_portfolios_me_op_10x10, 100_portfolios_10x10_me_op_wout_div, 100_portfolios_me_op_10x10_daily, 6_portfolios_me_inv_2x3, 6_portfolios_me_inv_2x3_wout_div, 6_portfolios_me_inv_2x3_daily, 25_portfolios_me_inv_5x5, 25_portfolios_me_inv_5x5_wout_div, 25_portfolios_me_inv_5x5_daily, 100_portfolios_me_inv_10x10, 100_portfolios_10x10_me_inv_wout_div, 100_portfolios_me_inv_10x10_daily, 25_portfolios_beme_op_5x5, 25_portfolios_beme_op_5x5_wout_div, 25_portfolios_beme_op_5x5_daily, 25_portfolios_beme_inv_5x5, 25_portfolios_beme_inv_5x5_wout_div, 25_portfolios_beme_inv_5x5_daily, 25_portfolios_op_inv_5x5, 25_portfolios_op_inv_5x5_wout_div, 25_portfolios_op_inv_5x5_daily, 32_portfolios_me_beme_op_2x4x4, 32_portfolios_me_beme_op_2x4x4_wout_div, 32_portfolios_me_beme_inv_2x4x4, 32_portfolios_me_beme_inv_2x4x4_wout_div, 32_portfolios_me_op_inv_2x4x4, 32_portfolios_me_op_inv_2x4x4_wout_div, portfolios_formed_on_e-p, portfolios_formed_on_e-p_wout_div, portfolios_formed_on_cf-p, portfolios_formed_on_cf-p_wout_div, portfolios_formed_on_d-p, portfolios_formed_on_d-p_wout_div, 6_portfolios_me_ep_2x3, 6_portfolios_me_ep_2x3_wout_div, 6_portfolios_me_cfp_2x3, 6_portfolios_me_cfp_2x3_wout_div, 6_portfolios_me_dp_2x3, 6_portfolios_me_dp_2x3_wout_div, 6_portfolios_me_prior_12_2, 6_portfolios_me_prior_12_2_daily, 25_portfolios_me_prior_12_2, 25_portfolios_me_prior_12_2_daily, 10_portfolios_prior_12_2, 10_portfolios_prior_12_2_daily, 6_portfolios_me_prior_1_0, 6_portfolios_me_prior_1_0_daily, 25_portfolios_me_prior_1_0, 25_portfolios_me_prior_1_0_daily, 10_portfolios_prior_1_0, 10_portfolios_prior_1_0_daily, 6_portfolios_me_prior_60_13, 6_portfolios_me_prior_60_13_daily, 25_portfolios_me_prior_60_13, 25_portfolios_me_prior_60_13_daily, 10_portfolios_prior_60_13, 10_portfolios_prior_60_13_daily, portfolios_formed_on_ac, 25_portfolios_me_ac_5x5, portfolios_formed_on_beta, 25_portfolios_me_beta_5x5, portfolios_formed_on_ni, 25_portfolios_me_ni_5x5, portfolios_formed_on_var, 25_portfolios_me_var_5x5, portfolios_formed_on_resvar, 25_portfolios_me_resvar_5x5, 5_industry_portfolios, 5_industry_portfolios_wout_div, 5_industry_portfolios_daily, 10_industry_portfolios, 10_industry_portfolios_wout_div, 10_industry_portfolios_daily, 12_industry_portfolios, 12_industry_portfolios_wout_div, 12_industry_portfolios_daily, 17_industry_portfolios, 17_industry_portfolios_wout_div, 17_industry_portfolios_daily, 30_industry_portfolios, 30_industry_portfolios_wout_div, 30_industry_portfolios_daily, 38_industry_portfolios, 38_industry_portfolios_wout_div, 38_industry_portfolios_daily, 48_industry_portfolios, 48_industry_portfolios_wout_div, 48_industry_portfolios_daily, 49_industry_portfolios, 49_industry_portfolios_wout_div, 49_industry_portfolios_daily The specific portfolio file to fetch. (provider: famafrench) |
197
- | `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio. (provider: famafrench) |
198
- | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored if the portfolio ends with 'daily' or 'weekly'. (provider: famafrench) |
199
- | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. (provider: famafrench) |
200
- | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. (provider: famafrench) |
201
- | `provider` | `no` | `string` | `famafrench` | - |
185
+ | `portfolio` | `no` | `string` | `portfolios_formed_on_me` | enum: portfolios_formed_on_me, portfolios_formed_on_me_wout_div, portfolios_formed_on_me_daily, portfolios_formed_on_be-me, portfolios_formed_on_be-me_wout_div, portfolios_formed_on_be-me_daily, portfolios_formed_on_op, portfolios_formed_on_op_wout_div, portfolios_formed_on_op_daily, portfolios_formed_on_inv, portfolios_formed_on_inv_wout_div, portfolios_formed_on_inv_daily, 6_portfolios_2x3, 6_portfolios_2x3_wout_div, 6_portfolios_2x3_weekly, 6_portfolios_2x3_daily, 25_portfolios_5x5, 25_portfolios_5x5_wout_div, 25_portfolios_5x5_daily, 100_portfolios_10x10, 100_portfolios_10x10_wout_div, 100_portfolios_10x10_daily, 6_portfolios_me_op_2x3, 6_portfolios_me_op_2x3_wout_div, 6_portfolios_me_op_2x3_daily, 25_portfolios_me_op_5x5, 25_portfolios_me_op_5x5_wout_div, 25_portfolios_me_op_5x5_daily, 100_portfolios_me_op_10x10, 100_portfolios_10x10_me_op_wout_div, 100_portfolios_me_op_10x10_daily, 6_portfolios_me_inv_2x3, 6_portfolios_me_inv_2x3_wout_div, 6_portfolios_me_inv_2x3_daily, 25_portfolios_me_inv_5x5, 25_portfolios_me_inv_5x5_wout_div, 25_portfolios_me_inv_5x5_daily, 100_portfolios_me_inv_10x10, 100_portfolios_10x10_me_inv_wout_div, 100_portfolios_me_inv_10x10_daily, 25_portfolios_beme_op_5x5, 25_portfolios_beme_op_5x5_wout_div, 25_portfolios_beme_op_5x5_daily, 25_portfolios_beme_inv_5x5, 25_portfolios_beme_inv_5x5_wout_div, 25_portfolios_beme_inv_5x5_daily, 25_portfolios_op_inv_5x5, 25_portfolios_op_inv_5x5_wout_div, 25_portfolios_op_inv_5x5_daily, 32_portfolios_me_beme_op_2x4x4, 32_portfolios_me_beme_op_2x4x4_wout_div, 32_portfolios_me_beme_inv_2x4x4, 32_portfolios_me_beme_inv_2x4x4_wout_div, 32_portfolios_me_op_inv_2x4x4, 32_portfolios_me_op_inv_2x4x4_wout_div, portfolios_formed_on_e-p, portfolios_formed_on_e-p_wout_div, portfolios_formed_on_cf-p, portfolios_formed_on_cf-p_wout_div, portfolios_formed_on_d-p, portfolios_formed_on_d-p_wout_div, 6_portfolios_me_ep_2x3, 6_portfolios_me_ep_2x3_wout_div, 6_portfolios_me_cfp_2x3, 6_portfolios_me_cfp_2x3_wout_div, 6_portfolios_me_dp_2x3, 6_portfolios_me_dp_2x3_wout_div, 6_portfolios_me_prior_12_2, 6_portfolios_me_prior_12_2_daily, 25_portfolios_me_prior_12_2, 25_portfolios_me_prior_12_2_daily, 10_portfolios_prior_12_2, 10_portfolios_prior_12_2_daily, 6_portfolios_me_prior_1_0, 6_portfolios_me_prior_1_0_daily, 25_portfolios_me_prior_1_0, 25_portfolios_me_prior_1_0_daily, 10_portfolios_prior_1_0, 10_portfolios_prior_1_0_daily, 6_portfolios_me_prior_60_13, 6_portfolios_me_prior_60_13_daily, 25_portfolios_me_prior_60_13, 25_portfolios_me_prior_60_13_daily, 10_portfolios_prior_60_13, 10_portfolios_prior_60_13_daily, portfolios_formed_on_ac, 25_portfolios_me_ac_5x5, portfolios_formed_on_beta, 25_portfolios_me_beta_5x5, portfolios_formed_on_ni, 25_portfolios_me_ni_5x5, portfolios_formed_on_var, 25_portfolios_me_var_5x5, portfolios_formed_on_resvar, 25_portfolios_me_resvar_5x5, 5_industry_portfolios, 5_industry_portfolios_wout_div, 5_industry_portfolios_daily, 10_industry_portfolios, 10_industry_portfolios_wout_div, 10_industry_portfolios_daily, 12_industry_portfolios, 12_industry_portfolios_wout_div, 12_industry_portfolios_daily, 17_industry_portfolios, 17_industry_portfolios_wout_div, 17_industry_portfolios_daily, 30_industry_portfolios, 30_industry_portfolios_wout_div, 30_industry_portfolios_daily, 38_industry_portfolios, 38_industry_portfolios_wout_div, 38_industry_portfolios_daily, 48_industry_portfolios, 48_industry_portfolios_wout_div, 48_industry_portfolios_daily, 49_industry_portfolios, 49_industry_portfolios_wout_div, 49_industry_portfolios_daily The specific portfolio file to fetch. |
186
+ | `measure` | `no` | `string` | `value` | The measure to fetch for the portfolio. |
187
+ | `frequency` | `no` | `string` | `monthly` | The frequency of the data to fetch. Ignored if the portfolio ends with 'daily' or 'weekly'. |
188
+ | `start_date` | `no` | `string | null` | `-` | The start date for the data. Defaults to the earliest available date. |
189
+ | `end_date` | `no` | `string | null` | `-` | The end date for the data. Defaults to the latest available date. |