@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
@@ -79,7 +79,7 @@ are callable through the DataSDK wrapper.
79
79
  ### `equity.calendar.dividend`
80
80
 
81
81
  ```python
82
- data.equity.calendar.dividend(start_time=None, end_time=None, provider=...)
82
+ data.equity.calendar.dividend(start_time=None, end_time=None)
83
83
  ```
84
84
 
85
85
  Summary: Dividend
@@ -89,7 +89,6 @@ Summary: Dividend
89
89
  | Endpoint ID | `equity.calendar.dividend` |
90
90
  | HTTP | `GET` |
91
91
  | Path | `/inner/v1/agent-data/equity/calendar/dividend` |
92
- | Default provider | - |
93
92
  | SDK | `supported` |
94
93
  | Host | `supported` |
95
94
  | Notes | - |
@@ -100,14 +99,13 @@ Summary: Dividend
100
99
  |---|---|---|---|---|
101
100
  | `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. |
102
101
  | `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. |
103
- | `provider` | `yes` | `string` | `-` | enum: fmp, nasdaq |
104
102
 
105
103
  ---
106
104
 
107
105
  ### `equity.calendar.earnings`
108
106
 
109
107
  ```python
110
- data.equity.calendar.earnings(start_time=None, end_time=None, symbol=None, country='us', provider=...)
108
+ data.equity.calendar.earnings(start_time=None, end_time=None, symbol=None, country='us')
111
109
  ```
112
110
 
113
111
  Summary: Earnings
@@ -117,7 +115,6 @@ Summary: Earnings
117
115
  | Endpoint ID | `equity.calendar.earnings` |
118
116
  | HTTP | `GET` |
119
117
  | Path | `/inner/v1/agent-data/equity/calendar/earnings` |
120
- | Default provider | - |
121
118
  | SDK | `supported` |
122
119
  | Host | `supported` |
123
120
  | Notes | - |
@@ -129,15 +126,14 @@ Summary: Earnings
129
126
  | `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. |
130
127
  | `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. |
131
128
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
132
- | `country` | `no` | `string` | `us` | enum: us, ca The country to get calendar data for. Accepts 'us'/'ca', ISO codes ('US', 'USA', 'CA', 'CAN'), or names ('United States', 'Canada'). (provider: seeking_alpha) |
133
- | `provider` | `yes` | `string` | `-` | enum: finnhub, fmp, nasdaq, seeking_alpha, tmx |
129
+ | `country` | `no` | `string` | `us` | enum: us, ca The country to get calendar data for. Accepts 'us'/'ca', ISO codes ('US', 'USA', 'CA', 'CAN'), or names ('United States', 'Canada'). |
134
130
 
135
131
  ---
136
132
 
137
133
  ### `equity.calendar.events`
138
134
 
139
135
  ```python
140
- data.equity.calendar.events(start_time=None, end_time=None, country=None, provider='fmp')
136
+ data.equity.calendar.events(start_time=None, end_time=None, country=None)
141
137
  ```
142
138
 
143
139
  Summary: Events
@@ -147,7 +143,6 @@ Summary: Events
147
143
  | Endpoint ID | `equity.calendar.events` |
148
144
  | HTTP | `GET` |
149
145
  | Path | `/inner/v1/agent-data/equity/calendar/events` |
150
- | Default provider | `fmp` |
151
146
  | SDK | `supported` |
152
147
  | Host | `supported` |
153
148
  | Notes | - |
@@ -158,15 +153,14 @@ Summary: Events
158
153
  |---|---|---|---|---|
159
154
  | `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. |
160
155
  | `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. |
161
- | `country` | `no` | `string | null` | `-` | Country code to filter economic events (e.g., 'US', 'JP', 'CN'). (provider: fmp) |
162
- | `provider` | `no` | `string` | `fmp` | - |
156
+ | `country` | `no` | `string | null` | `-` | Country code to filter economic events (e.g., 'US', 'JP', 'CN'). |
163
157
 
164
158
  ---
165
159
 
166
160
  ### `equity.calendar.ipo`
167
161
 
168
162
  ```python
169
- data.equity.calendar.ipo(start_time=None, end_time=None, symbol=None, limit=100, status=None, min_value=None, max_value=None, is_spo=False, provider=...)
163
+ data.equity.calendar.ipo(start_time=None, end_time=None, symbol=None, limit=100, status=None, min_value=None, max_value=None, is_spo=False)
170
164
  ```
171
165
 
172
166
  Summary: Ipo
@@ -176,7 +170,6 @@ Summary: Ipo
176
170
  | Endpoint ID | `equity.calendar.ipo` |
177
171
  | HTTP | `GET` |
178
172
  | Path | `/inner/v1/agent-data/equity/calendar/ipo` |
179
- | Default provider | - |
180
173
  | SDK | `supported` |
181
174
  | Host | `supported` |
182
175
  | Notes | - |
@@ -189,18 +182,17 @@ Summary: Ipo
189
182
  | `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. |
190
183
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
191
184
  | `limit` | `no` | `integer | null` | `100` | The number of data entries to return. |
192
- | `status` | `no` | `string | null` | `-` | Status of the IPO. [upcoming, priced, or withdrawn] (provider: intrinio); The status of the IPO. (provider: nasdaq) |
193
- | `min_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount greater than the given amount. (provider: intrinio) |
194
- | `max_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount less than the given amount. (provider: intrinio) |
195
- | `is_spo` | `no` | `boolean` | `false` | If True, returns data for secondary public offerings (SPOs). (provider: nasdaq) |
196
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, nasdaq |
185
+ | `status` | `no` | `string | null` | `-` | Status of the IPO. [upcoming, priced, or withdrawn]; The status of the IPO. |
186
+ | `min_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount greater than the given amount. |
187
+ | `max_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount less than the given amount. |
188
+ | `is_spo` | `no` | `boolean` | `false` | If True, returns data for secondary public offerings (SPOs). |
197
189
 
198
190
  ---
199
191
 
200
192
  ### `equity.calendar.splits`
201
193
 
202
194
  ```python
203
- data.equity.calendar.splits(start_time=None, end_time=None, provider='fmp')
195
+ data.equity.calendar.splits(start_time=None, end_time=None)
204
196
  ```
205
197
 
206
198
  Summary: Splits
@@ -210,7 +202,6 @@ Summary: Splits
210
202
  | Endpoint ID | `equity.calendar.splits` |
211
203
  | HTTP | `GET` |
212
204
  | Path | `/inner/v1/agent-data/equity/calendar/splits` |
213
- | Default provider | `fmp` |
214
205
  | SDK | `supported` |
215
206
  | Host | `supported` |
216
207
  | Notes | - |
@@ -221,14 +212,13 @@ Summary: Splits
221
212
  |---|---|---|---|---|
222
213
  | `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. |
223
214
  | `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. |
224
- | `provider` | `no` | `string` | `fmp` | - |
225
215
 
226
216
  ---
227
217
 
228
218
  ### `equity.compare.company_facts`
229
219
 
230
220
  ```python
231
- data.equity.compare.company_facts(symbol=None, fact='', year=None, fiscal_period=None, instantaneous=False, use_cache=True, provider='sec')
221
+ data.equity.compare.company_facts(symbol=None, fact='', year=None, fiscal_period=None, instantaneous=False, use_cache=True)
232
222
  ```
233
223
 
234
224
  Summary: Company Facts
@@ -238,7 +228,6 @@ Summary: Company Facts
238
228
  | Endpoint ID | `equity.compare.company_facts` |
239
229
  | HTTP | `GET` |
240
230
  | Path | `/inner/v1/agent-data/equity/compare/company_facts` |
241
- | Default provider | `sec` |
242
231
  | SDK | `supported` |
243
232
  | Host | `supported` |
244
233
  | Notes | - |
@@ -247,20 +236,19 @@ Summary: Company Facts
247
236
 
248
237
  | Param | Required | Type | Default | Notes |
249
238
  |---|---|---|---|---|
250
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): sec. |
251
- | `fact` | `no` | `string` | `` | The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.; Fact or concept from the SEC taxonomy, in UpperCamelCase. Defaults to, 'Revenues'. AAPL, MSFT, GOOG, BRK-A currently report revenue as, 'RevenueFromContractWithCustomerExcludingAssessedTax'. In previous years, they have reported as 'Revenues'. (provider: sec) |
252
- | `year` | `no` | `integer | null` | `-` | The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. (provider: sec) |
253
- | `fiscal_period` | `no` | `string | null` | `-` | The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. (provider: sec) |
254
- | `instantaneous` | `no` | `boolean` | `false` | Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data. The function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. (provider: sec) |
255
- | `use_cache` | `no` | `boolean` | `true` | Whether to use cache for the request. Defaults to True. (provider: sec) |
256
- | `provider` | `no` | `string` | `sec` | - |
239
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
240
+ | `fact` | `no` | `string` | `` | The fact to lookup, typically a GAAP-reporting measure. Choices vary by provider.; Fact or concept from the SEC taxonomy, in UpperCamelCase. Defaults to, 'Revenues'. AAPL, MSFT, GOOG, BRK-A currently report revenue as, 'RevenueFromContractWithCustomerExcludingAssessedTax'. In previous years, they have reported as 'Revenues'. |
241
+ | `year` | `no` | `integer | null` | `-` | The year to retrieve the data for. If not provided, the current year is used. When symbol(s) are provided, excluding the year will return all reported values for the concept. |
242
+ | `fiscal_period` | `no` | `string | null` | `-` | The fiscal period to retrieve the data for. If not provided, the most recent quarter is used. This parameter is ignored when a symbol is supplied. |
243
+ | `instantaneous` | `no` | `boolean` | `false` | Whether to retrieve instantaneous data. See the notes above for more information. Defaults to False. Some facts are only available as instantaneous data. The function will automatically attempt the inverse of this parameter if the initial fiscal quarter request fails. This parameter is ignored when a symbol is supplied. |
244
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use cache for the request. Defaults to True. |
257
245
 
258
246
  ---
259
247
 
260
248
  ### `equity.compare.groups`
261
249
 
262
250
  ```python
263
- data.equity.compare.groups(group='sector', metric='performance', provider='finviz')
251
+ data.equity.compare.groups(group='sector', metric='performance')
264
252
  ```
265
253
 
266
254
  Summary: Groups
@@ -270,7 +258,6 @@ Summary: Groups
270
258
  | Endpoint ID | `equity.compare.groups` |
271
259
  | HTTP | `GET` |
272
260
  | Path | `/inner/v1/agent-data/equity/compare/groups` |
273
- | Default provider | `finviz` |
274
261
  | SDK | `supported` |
275
262
  | Host | `supported` |
276
263
  | Notes | - |
@@ -279,16 +266,15 @@ Summary: Groups
279
266
 
280
267
  | Param | Required | Type | Default | Notes |
281
268
  |---|---|---|---|---|
282
- | `group` | `no` | `string` | `sector` | enum: sector, industry, country, capitalization, energy, materials, industrials, consumer_cyclical, consumer_defensive, healthcare, financial, technology, communication_services, utilities, real_estate US-listed stocks only. When an individual sector is selected, it is broken down by industry. The default is 'sector'. (provider: finviz) |
283
- | `metric` | `no` | `string` | `performance` | enum: performance, valuation, overview Statistical metric to return. Select from: ['performance', 'valuation', 'overview'] The default is 'performance'. (provider: finviz) |
284
- | `provider` | `no` | `string` | `finviz` | - |
269
+ | `group` | `no` | `string` | `sector` | enum: sector, industry, country, capitalization, energy, materials, industrials, consumer_cyclical, consumer_defensive, healthcare, financial, technology, communication_services, utilities, real_estate US-listed stocks only. When an individual sector is selected, it is broken down by industry. The default is 'sector'. |
270
+ | `metric` | `no` | `string` | `performance` | enum: performance, valuation, overview Statistical metric to return. Select from: ['performance', 'valuation', 'overview'] The default is 'performance'. |
285
271
 
286
272
  ---
287
273
 
288
274
  ### `equity.compare.peers`
289
275
 
290
276
  ```python
291
- data.equity.compare.peers(symbol=..., provider='fmp')
277
+ data.equity.compare.peers(symbol=...)
292
278
  ```
293
279
 
294
280
  Summary: Peers
@@ -298,7 +284,6 @@ Summary: Peers
298
284
  | Endpoint ID | `equity.compare.peers` |
299
285
  | HTTP | `GET` |
300
286
  | Path | `/inner/v1/agent-data/equity/compare/peers` |
301
- | Default provider | `fmp` |
302
287
  | SDK | `supported` |
303
288
  | Host | `supported` |
304
289
  | Notes | - |
@@ -308,14 +293,13 @@ Summary: Peers
308
293
  | Param | Required | Type | Default | Notes |
309
294
  |---|---|---|---|---|
310
295
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
311
- | `provider` | `no` | `string` | `fmp` | - |
312
296
 
313
297
  ---
314
298
 
315
299
  ### `equity.darkpool.otc`
316
300
 
317
301
  ```python
318
- data.equity.darkpool.otc(symbol=None, tier='T1', is_ats=True, provider='finra')
302
+ data.equity.darkpool.otc(symbol=None, tier='T1', is_ats=True)
319
303
  ```
320
304
 
321
305
  Summary: Otc
@@ -325,7 +309,6 @@ Summary: Otc
325
309
  | Endpoint ID | `equity.darkpool.otc` |
326
310
  | HTTP | `GET` |
327
311
  | Path | `/inner/v1/agent-data/equity/darkpool/otc` |
328
- | Default provider | `finra` |
329
312
  | SDK | `supported` |
330
313
  | Host | `supported` |
331
314
  | Notes | - |
@@ -335,16 +318,15 @@ Summary: Otc
335
318
  | Param | Required | Type | Default | Notes |
336
319
  |---|---|---|---|---|
337
320
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
338
- | `tier` | `no` | `string` | `T1` | "T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities (provider: finra) |
339
- | `is_ats` | `no` | `boolean` | `true` | ATS data if true, NON-ATS otherwise (provider: finra) |
340
- | `provider` | `no` | `string` | `finra` | - |
321
+ | `tier` | `no` | `string` | `T1` | "T1 - Securities included in the S&P 500, Russell 1000 and selected exchange-traded products; T2 - All other NMS stocks; OTC - Over-the-Counter equity securities |
322
+ | `is_ats` | `no` | `boolean` | `true` | ATS data if true, NON-ATS otherwise |
341
323
 
342
324
  ---
343
325
 
344
326
  ### `equity.discovery.active`
345
327
 
346
328
  ```python
347
- data.equity.discovery.active(sort='desc', limit=200, provider=...)
329
+ data.equity.discovery.active(sort='desc', limit=200)
348
330
  ```
349
331
 
350
332
  Summary: Active
@@ -354,7 +336,6 @@ Summary: Active
354
336
  | Endpoint ID | `equity.discovery.active` |
355
337
  | HTTP | `GET` |
356
338
  | Path | `/inner/v1/agent-data/equity/discovery/active` |
357
- | Default provider | - |
358
339
  | SDK | `supported` |
359
340
  | Host | `supported` |
360
341
  | Notes | - |
@@ -364,15 +345,14 @@ Summary: Active
364
345
  | Param | Required | Type | Default | Notes |
365
346
  |---|---|---|---|---|
366
347
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
367
- | `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
368
- | `provider` | `yes` | `string` | `-` | enum: fmp, yfinance |
348
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
369
349
 
370
350
  ---
371
351
 
372
352
  ### `equity.discovery.aggressive_small_caps`
373
353
 
374
354
  ```python
375
- data.equity.discovery.aggressive_small_caps(sort='desc', limit=None, provider='yfinance')
355
+ data.equity.discovery.aggressive_small_caps(sort='desc', limit=None)
376
356
  ```
377
357
 
378
358
  Summary: Aggressive Small Caps
@@ -382,7 +362,6 @@ Summary: Aggressive Small Caps
382
362
  | Endpoint ID | `equity.discovery.aggressive_small_caps` |
383
363
  | HTTP | `GET` |
384
364
  | Path | `/inner/v1/agent-data/equity/discovery/aggressive_small_caps` |
385
- | Default provider | `yfinance` |
386
365
  | SDK | `supported` |
387
366
  | Host | `supported` |
388
367
  | Notes | - |
@@ -392,15 +371,14 @@ Summary: Aggressive Small Caps
392
371
  | Param | Required | Type | Default | Notes |
393
372
  |---|---|---|---|---|
394
373
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
395
- | `limit` | `no` | `integer | null` | `-` | Limit the number of results. Default is all. (provider: yfinance) |
396
- | `provider` | `no` | `string` | `yfinance` | - |
374
+ | `limit` | `no` | `integer | null` | `-` | Limit the number of results. Default is all. |
397
375
 
398
376
  ---
399
377
 
400
378
  ### `equity.discovery.filings`
401
379
 
402
380
  ```python
403
- data.equity.discovery.filings(start_time=None, end_time=None, form_type=None, limit=None, provider='fmp')
381
+ data.equity.discovery.filings(start_time=None, end_time=None, form_type=None, limit=None)
404
382
  ```
405
383
 
406
384
  Summary: Filings
@@ -410,7 +388,6 @@ Summary: Filings
410
388
  | Endpoint ID | `equity.discovery.filings` |
411
389
  | HTTP | `GET` |
412
390
  | Path | `/inner/v1/agent-data/equity/discovery/filings` |
413
- | Default provider | `fmp` |
414
391
  | SDK | `supported` |
415
392
  | Host | `supported` |
416
393
  | Notes | - |
@@ -422,15 +399,14 @@ Summary: Filings
422
399
  | `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. |
423
400
  | `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. |
424
401
  | `form_type` | `no` | `string | null` | `-` | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. |
425
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; The maximum number of results to return. Default is 10000. (provider: fmp) |
426
- | `provider` | `no` | `string` | `fmp` | - |
402
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; The maximum number of results to return. Default is 10000. |
427
403
 
428
404
  ---
429
405
 
430
406
  ### `equity.discovery.gainers`
431
407
 
432
408
  ```python
433
- data.equity.discovery.gainers(sort='desc', category='price_performer', limit=200, provider=...)
409
+ data.equity.discovery.gainers(sort='desc', category='price_performer', limit=200)
434
410
  ```
435
411
 
436
412
  Summary: Gainers
@@ -440,7 +416,6 @@ Summary: Gainers
440
416
  | Endpoint ID | `equity.discovery.gainers` |
441
417
  | HTTP | `GET` |
442
418
  | Path | `/inner/v1/agent-data/equity/discovery/gainers` |
443
- | Default provider | - |
444
419
  | SDK | `supported` |
445
420
  | Host | `supported` |
446
421
  | Notes | - |
@@ -450,16 +425,15 @@ Summary: Gainers
450
425
  | Param | Required | Type | Default | Notes |
451
426
  |---|---|---|---|---|
452
427
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
453
- | `category` | `no` | `string` | `price_performer` | enum: dividend, energy, healthcare, industrials, price_performer, rising_stars, real_estate, tech, utilities, 52w_high, volume The category of list to retrieve. Defaults to `price_performer`. (provider: tmx) |
454
- | `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
455
- | `provider` | `yes` | `string` | `-` | enum: fmp, tmx, yfinance |
428
+ | `category` | `no` | `string` | `price_performer` | enum: dividend, energy, healthcare, industrials, price_performer, rising_stars, real_estate, tech, utilities, 52w_high, volume The category of list to retrieve. Defaults to `price_performer`. |
429
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
456
430
 
457
431
  ---
458
432
 
459
433
  ### `equity.discovery.growth_tech`
460
434
 
461
435
  ```python
462
- data.equity.discovery.growth_tech(sort='desc', limit=200, provider='yfinance')
436
+ data.equity.discovery.growth_tech(sort='desc', limit=200)
463
437
  ```
464
438
 
465
439
  Summary: Growth Tech
@@ -469,7 +443,6 @@ Summary: Growth Tech
469
443
  | Endpoint ID | `equity.discovery.growth_tech` |
470
444
  | HTTP | `GET` |
471
445
  | Path | `/inner/v1/agent-data/equity/discovery/growth_tech` |
472
- | Default provider | `yfinance` |
473
446
  | SDK | `supported` |
474
447
  | Host | `supported` |
475
448
  | Notes | - |
@@ -479,15 +452,14 @@ Summary: Growth Tech
479
452
  | Param | Required | Type | Default | Notes |
480
453
  |---|---|---|---|---|
481
454
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
482
- | `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
483
- | `provider` | `no` | `string` | `yfinance` | - |
455
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
484
456
 
485
457
  ---
486
458
 
487
459
  ### `equity.discovery.latest_financial_reports`
488
460
 
489
461
  ```python
490
- data.equity.discovery.latest_financial_reports(date=None, report_type=None, provider='sec')
462
+ data.equity.discovery.latest_financial_reports(date=None, report_type=None)
491
463
  ```
492
464
 
493
465
  Summary: Latest Financial Reports
@@ -497,7 +469,6 @@ Summary: Latest Financial Reports
497
469
  | Endpoint ID | `equity.discovery.latest_financial_reports` |
498
470
  | HTTP | `GET` |
499
471
  | Path | `/inner/v1/agent-data/equity/discovery/latest_financial_reports` |
500
- | Default provider | `sec` |
501
472
  | SDK | `supported` |
502
473
  | Host | `supported` |
503
474
  | Notes | - |
@@ -506,16 +477,15 @@ Summary: Latest Financial Reports
506
477
 
507
478
  | Param | Required | Type | Default | Notes |
508
479
  |---|---|---|---|---|
509
- | `date` | `no` | `string | null` | `-` | A specific date to get data for. Defaults to today. (provider: sec) |
510
- | `report_type` | `no` | `string | null` | `-` | Return only a specific form type. Default is all quarterly, annual, and current reports. Choices: 1-K, 1-SA, 1-U, 10-D, 10-K, 10-KT, 10-Q, 10-QT, 20-F, 40-F, 6-K, 8-K. Multiple comma separated items allowed. (provider: sec) |
511
- | `provider` | `no` | `string` | `sec` | - |
480
+ | `date` | `no` | `string | null` | `-` | A specific date to get data for. Defaults to today. |
481
+ | `report_type` | `no` | `string | null` | `-` | Return only a specific form type. Default is all quarterly, annual, and current reports. Choices: 1-K, 1-SA, 1-U, 10-D, 10-K, 10-KT, 10-Q, 10-QT, 20-F, 40-F, 6-K, 8-K. Multiple comma separated items allowed. |
512
482
 
513
483
  ---
514
484
 
515
485
  ### `equity.discovery.losers`
516
486
 
517
487
  ```python
518
- data.equity.discovery.losers(sort='desc', limit=200, provider=...)
488
+ data.equity.discovery.losers(sort='desc', limit=200)
519
489
  ```
520
490
 
521
491
  Summary: Losers
@@ -525,7 +495,6 @@ Summary: Losers
525
495
  | Endpoint ID | `equity.discovery.losers` |
526
496
  | HTTP | `GET` |
527
497
  | Path | `/inner/v1/agent-data/equity/discovery/losers` |
528
- | Default provider | - |
529
498
  | SDK | `supported` |
530
499
  | Host | `supported` |
531
500
  | Notes | - |
@@ -535,15 +504,14 @@ Summary: Losers
535
504
  | Param | Required | Type | Default | Notes |
536
505
  |---|---|---|---|---|
537
506
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
538
- | `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
539
- | `provider` | `yes` | `string` | `-` | enum: fmp, yfinance |
507
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
540
508
 
541
509
  ---
542
510
 
543
511
  ### `equity.discovery.top_retail`
544
512
 
545
513
  ```python
546
- data.equity.discovery.top_retail(limit=5, provider='nasdaq')
514
+ data.equity.discovery.top_retail(limit=5)
547
515
  ```
548
516
 
549
517
  Summary: Top Retail
@@ -553,7 +521,6 @@ Summary: Top Retail
553
521
  | Endpoint ID | `equity.discovery.top_retail` |
554
522
  | HTTP | `GET` |
555
523
  | Path | `/inner/v1/agent-data/equity/discovery/top_retail` |
556
- | Default provider | `nasdaq` |
557
524
  | SDK | `supported` |
558
525
  | Host | `supported` |
559
526
  | Notes | - |
@@ -563,14 +530,13 @@ Summary: Top Retail
563
530
  | Param | Required | Type | Default | Notes |
564
531
  |---|---|---|---|---|
565
532
  | `limit` | `no` | `integer` | `5` | The number of data entries to return. |
566
- | `provider` | `no` | `string` | `nasdaq` | - |
567
533
 
568
534
  ---
569
535
 
570
536
  ### `equity.discovery.undervalued_growth`
571
537
 
572
538
  ```python
573
- data.equity.discovery.undervalued_growth(sort='desc', limit=200, provider='yfinance')
539
+ data.equity.discovery.undervalued_growth(sort='desc', limit=200)
574
540
  ```
575
541
 
576
542
  Summary: Undervalued Growth
@@ -580,7 +546,6 @@ Summary: Undervalued Growth
580
546
  | Endpoint ID | `equity.discovery.undervalued_growth` |
581
547
  | HTTP | `GET` |
582
548
  | Path | `/inner/v1/agent-data/equity/discovery/undervalued_growth` |
583
- | Default provider | `yfinance` |
584
549
  | SDK | `supported` |
585
550
  | Host | `supported` |
586
551
  | Notes | - |
@@ -590,15 +555,14 @@ Summary: Undervalued Growth
590
555
  | Param | Required | Type | Default | Notes |
591
556
  |---|---|---|---|---|
592
557
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
593
- | `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
594
- | `provider` | `no` | `string` | `yfinance` | - |
558
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
595
559
 
596
560
  ---
597
561
 
598
562
  ### `equity.discovery.undervalued_large_caps`
599
563
 
600
564
  ```python
601
- data.equity.discovery.undervalued_large_caps(sort='desc', limit=200, provider='yfinance')
565
+ data.equity.discovery.undervalued_large_caps(sort='desc', limit=200)
602
566
  ```
603
567
 
604
568
  Summary: Undervalued Large Caps
@@ -608,7 +572,6 @@ Summary: Undervalued Large Caps
608
572
  | Endpoint ID | `equity.discovery.undervalued_large_caps` |
609
573
  | HTTP | `GET` |
610
574
  | Path | `/inner/v1/agent-data/equity/discovery/undervalued_large_caps` |
611
- | Default provider | `yfinance` |
612
575
  | SDK | `supported` |
613
576
  | Host | `supported` |
614
577
  | Notes | - |
@@ -618,15 +581,14 @@ Summary: Undervalued Large Caps
618
581
  | Param | Required | Type | Default | Notes |
619
582
  |---|---|---|---|---|
620
583
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
621
- | `limit` | `no` | `integer | null` | `200` | Limit the number of results. (provider: yfinance) |
622
- | `provider` | `no` | `string` | `yfinance` | - |
584
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
623
585
 
624
586
  ---
625
587
 
626
588
  ### `equity.estimates.analyst_search`
627
589
 
628
590
  ```python
629
- data.equity.estimates.analyst_search(analyst_name=None, firm_name=None, analyst_ids=None, firm_ids=None, limit=100, page=0, fields=None, provider='benzinga')
591
+ data.equity.estimates.analyst_search(analyst_name=None, firm_name=None, analyst_ids=None, firm_ids=None, limit=100, page=0, fields=None)
630
592
  ```
631
593
 
632
594
  Summary: Analyst Search
@@ -636,7 +598,6 @@ Summary: Analyst Search
636
598
  | Endpoint ID | `equity.estimates.analyst_search` |
637
599
  | HTTP | `GET` |
638
600
  | Path | `/inner/v1/agent-data/equity/estimates/analyst_search` |
639
- | Default provider | `benzinga` |
640
601
  | SDK | `supported` |
641
602
  | Host | `supported` |
642
603
  | Notes | - |
@@ -645,21 +606,20 @@ Summary: Analyst Search
645
606
 
646
607
  | Param | Required | Type | Default | Notes |
647
608
  |---|---|---|---|---|
648
- | `analyst_name` | `no` | `string | null` | `-` | Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed for provider(s): benzinga. |
649
- | `firm_name` | `no` | `string | null` | `-` | Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed for provider(s): benzinga. |
650
- | `analyst_ids` | `no` | `string | null` | `-` | List of analyst IDs to return. Multiple comma separated items allowed. (provider: benzinga) |
651
- | `firm_ids` | `no` | `string | null` | `-` | Firm IDs to return. Multiple comma separated items allowed. (provider: benzinga) |
652
- | `limit` | `no` | `integer | null` | `100` | Number of results returned. Limit 1000. (provider: benzinga) |
653
- | `page` | `no` | `integer | null` | `0` | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. (provider: benzinga) |
654
- | `fields` | `no` | `string | null` | `-` | Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga) |
655
- | `provider` | `no` | `string` | `benzinga` | - |
609
+ | `analyst_name` | `no` | `string | null` | `-` | Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed |
610
+ | `firm_name` | `no` | `string | null` | `-` | Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed |
611
+ | `analyst_ids` | `no` | `string | null` | `-` | List of analyst IDs to return. Multiple comma separated items allowed. |
612
+ | `firm_ids` | `no` | `string | null` | `-` | Firm IDs to return. Multiple comma separated items allowed. |
613
+ | `limit` | `no` | `integer | null` | `100` | Number of results returned. Limit 1000. |
614
+ | `page` | `no` | `integer | null` | `0` | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. |
615
+ | `fields` | `no` | `string | null` | `-` | Fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. |
656
616
 
657
617
  ---
658
618
 
659
619
  ### `equity.estimates.consensus`
660
620
 
661
621
  ```python
662
- data.equity.estimates.consensus(symbol=None, industry_group_number=None, provider=...)
622
+ data.equity.estimates.consensus(symbol=None, industry_group_number=None)
663
623
  ```
664
624
 
665
625
  Summary: Consensus
@@ -669,7 +629,6 @@ Summary: Consensus
669
629
  | Endpoint ID | `equity.estimates.consensus` |
670
630
  | HTTP | `GET` |
671
631
  | Path | `/inner/v1/agent-data/equity/estimates/consensus` |
672
- | Default provider | - |
673
632
  | SDK | `supported` |
674
633
  | Host | `supported` |
675
634
  | Notes | - |
@@ -678,16 +637,15 @@ Summary: Consensus
678
637
 
679
638
  | Param | Required | Type | Default | Notes |
680
639
  |---|---|---|---|---|
681
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio, tmx, yfinance. |
682
- | `industry_group_number` | `no` | `integer | null` | `-` | The Zacks industry group number. (provider: intrinio) |
683
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, tmx, yfinance |
640
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
641
+ | `industry_group_number` | `no` | `integer | null` | `-` | The Zacks industry group number. |
684
642
 
685
643
  ---
686
644
 
687
645
  ### `equity.estimates.forward_ebitda`
688
646
 
689
647
  ```python
690
- data.equity.estimates.forward_ebitda(symbol=None, fiscal_period='annual', limit=None, include_historical=False, estimate_type=None, provider=...)
648
+ data.equity.estimates.forward_ebitda(symbol=None, fiscal_period='annual', limit=None, include_historical=False, estimate_type=None)
691
649
  ```
692
650
 
693
651
  Summary: Forward Ebitda
@@ -697,7 +655,6 @@ Summary: Forward Ebitda
697
655
  | Endpoint ID | `equity.estimates.forward_ebitda` |
698
656
  | HTTP | `GET` |
699
657
  | Path | `/inner/v1/agent-data/equity/estimates/forward_ebitda` |
700
- | Default provider | - |
701
658
  | SDK | `supported` |
702
659
  | Host | `supported` |
703
660
  | Notes | - |
@@ -706,19 +663,18 @@ Summary: Forward Ebitda
706
663
 
707
664
  | Param | Required | Type | Default | Notes |
708
665
  |---|---|---|---|---|
709
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. |
710
- | `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for. (provider: fmp); Filter for only full-year or quarterly estimates. (provider: intrinio) |
711
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. (provider: fmp) |
712
- | `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. (provider: fmp) |
713
- | `estimate_type` | `no` | `string | null` | `-` | Limit the EBITDA estimates to this type. (provider: intrinio) |
714
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
666
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
667
+ | `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for.; Filter for only full-year or quarterly estimates. |
668
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. |
669
+ | `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. |
670
+ | `estimate_type` | `no` | `string | null` | `-` | Limit the EBITDA estimates to this type. |
715
671
 
716
672
  ---
717
673
 
718
674
  ### `equity.estimates.forward_eps`
719
675
 
720
676
  ```python
721
- data.equity.estimates.forward_eps(symbol=None, fiscal_period='annual', limit=None, include_historical=False, fiscal_year=None, calendar_year=None, calendar_period=None, provider=...)
677
+ data.equity.estimates.forward_eps(symbol=None, fiscal_period='annual', limit=None, include_historical=False, fiscal_year=None, calendar_year=None, calendar_period=None)
722
678
  ```
723
679
 
724
680
  Summary: Forward Eps
@@ -728,7 +684,6 @@ Summary: Forward Eps
728
684
  | Endpoint ID | `equity.estimates.forward_eps` |
729
685
  | HTTP | `GET` |
730
686
  | Path | `/inner/v1/agent-data/equity/estimates/forward_eps` |
731
- | Default provider | - |
732
687
  | SDK | `supported` |
733
688
  | Host | `supported` |
734
689
  | Notes | - |
@@ -737,21 +692,20 @@ Summary: Forward Eps
737
692
 
738
693
  | Param | Required | Type | Default | Notes |
739
694
  |---|---|---|---|---|
740
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. |
741
- | `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for. (provider: fmp, intrinio) |
742
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. (provider: fmp) |
743
- | `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. (provider: fmp) |
744
- | `fiscal_year` | `no` | `integer | null` | `-` | The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
745
- | `calendar_year` | `no` | `integer | null` | `-` | The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
746
- | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. (provider: intrinio) |
747
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
695
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
696
+ | `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for. |
697
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. |
698
+ | `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. |
699
+ | `fiscal_year` | `no` | `integer | null` | `-` | The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. |
700
+ | `calendar_year` | `no` | `integer | null` | `-` | The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. |
701
+ | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. |
748
702
 
749
703
  ---
750
704
 
751
705
  ### `equity.estimates.forward_pe`
752
706
 
753
707
  ```python
754
- data.equity.estimates.forward_pe(symbol=None, provider='intrinio')
708
+ data.equity.estimates.forward_pe(symbol=None)
755
709
  ```
756
710
 
757
711
  Summary: Forward Pe
@@ -761,7 +715,6 @@ Summary: Forward Pe
761
715
  | Endpoint ID | `equity.estimates.forward_pe` |
762
716
  | HTTP | `GET` |
763
717
  | Path | `/inner/v1/agent-data/equity/estimates/forward_pe` |
764
- | Default provider | `intrinio` |
765
718
  | SDK | `supported` |
766
719
  | Host | `supported` |
767
720
  | Notes | - |
@@ -770,15 +723,14 @@ Summary: Forward Pe
770
723
 
771
724
  | Param | Required | Type | Default | Notes |
772
725
  |---|---|---|---|---|
773
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
774
- | `provider` | `no` | `string` | `intrinio` | - |
726
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
775
727
 
776
728
  ---
777
729
 
778
730
  ### `equity.estimates.forward_sales`
779
731
 
780
732
  ```python
781
- data.equity.estimates.forward_sales(symbol=None, fiscal_year=None, fiscal_period=None, calendar_year=None, calendar_period=None, provider='intrinio')
733
+ data.equity.estimates.forward_sales(symbol=None, fiscal_year=None, fiscal_period=None, calendar_year=None, calendar_period=None)
782
734
  ```
783
735
 
784
736
  Summary: Forward Sales
@@ -788,7 +740,6 @@ Summary: Forward Sales
788
740
  | Endpoint ID | `equity.estimates.forward_sales` |
789
741
  | HTTP | `GET` |
790
742
  | Path | `/inner/v1/agent-data/equity/estimates/forward_sales` |
791
- | Default provider | `intrinio` |
792
743
  | SDK | `supported` |
793
744
  | Host | `supported` |
794
745
  | Notes | - |
@@ -797,19 +748,18 @@ Summary: Forward Sales
797
748
 
798
749
  | Param | Required | Type | Default | Notes |
799
750
  |---|---|---|---|---|
800
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
801
- | `fiscal_year` | `no` | `integer | null` | `-` | The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
802
- | `fiscal_period` | `no` | `string | null` | `-` | The future fiscal period to retrieve estimates for. (provider: intrinio) |
803
- | `calendar_year` | `no` | `integer | null` | `-` | The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. (provider: intrinio) |
804
- | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. (provider: intrinio) |
805
- | `provider` | `no` | `string` | `intrinio` | - |
751
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
752
+ | `fiscal_year` | `no` | `integer | null` | `-` | The future fiscal year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. |
753
+ | `fiscal_period` | `no` | `string | null` | `-` | The future fiscal period to retrieve estimates for. |
754
+ | `calendar_year` | `no` | `integer | null` | `-` | The future calendar year to retrieve estimates for. When no symbol and year is supplied the current calendar year is used. |
755
+ | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. |
806
756
 
807
757
  ---
808
758
 
809
759
  ### `equity.estimates.historical`
810
760
 
811
761
  ```python
812
- data.equity.estimates.historical(symbol=..., freq='quarterly', period='annual', limit=None, page=None, provider=...)
762
+ data.equity.estimates.historical(symbol=..., freq='quarterly', period='annual', limit=None, page=None)
813
763
  ```
814
764
 
815
765
  Summary: Historical
@@ -819,7 +769,6 @@ Summary: Historical
819
769
  | Endpoint ID | `equity.estimates.historical` |
820
770
  | HTTP | `GET` |
821
771
  | Path | `/inner/v1/agent-data/equity/estimates/historical` |
822
- | Default provider | - |
823
772
  | SDK | `supported` |
824
773
  | Host | `supported` |
825
774
  | Notes | - |
@@ -828,19 +777,18 @@ Summary: Historical
828
777
 
829
778
  | Param | Required | Type | Default | Notes |
830
779
  |---|---|---|---|---|
831
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
832
- | `freq` | `no` | `string` | `quarterly` | enum: annual, quarterly The frequency of the data. Can be 'annual' or 'quarterly'. (provider: finnhub) |
833
- | `period` | `no` | `string` | `annual` | enum: quarter, annual Time period of the data to return. (provider: fmp) |
834
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: fmp) |
835
- | `page` | `no` | `integer | null` | `-` | Page number for paginated results. Used with limit. (provider: fmp) |
836
- | `provider` | `yes` | `string` | `-` | enum: finnhub, fmp |
780
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
781
+ | `freq` | `no` | `string` | `quarterly` | enum: annual, quarterly The frequency of the data. Can be 'annual' or 'quarterly'. |
782
+ | `period` | `no` | `string` | `annual` | enum: quarter, annual Time period of the data to return. |
783
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
784
+ | `page` | `no` | `integer | null` | `-` | Page number for paginated results. Used with limit. |
837
785
 
838
786
  ---
839
787
 
840
788
  ### `equity.estimates.price_target`
841
789
 
842
790
  ```python
843
- data.equity.estimates.price_target(symbol=None, limit=None, start_time=None, end_time=None, page=0, date=None, updated=None, importance=None, action=None, analyst_ids=None, firm_ids=None, fields=None, provider=...)
791
+ data.equity.estimates.price_target(symbol=None, limit=None, start_time=None, end_time=None, page=0, date=None, updated=None, importance=None, action=None, analyst_ids=None, firm_ids=None, fields=None)
844
792
  ```
845
793
 
846
794
  Summary: Price Target
@@ -850,7 +798,6 @@ Summary: Price Target
850
798
  | Endpoint ID | `equity.estimates.price_target` |
851
799
  | HTTP | `GET` |
852
800
  | Path | `/inner/v1/agent-data/equity/estimates/price_target` |
853
- | Default provider | - |
854
801
  | SDK | `supported` |
855
802
  | Host | `supported` |
856
803
  | Notes | - |
@@ -859,26 +806,25 @@ Summary: Price Target
859
806
 
860
807
  | Param | Required | Type | Default | Notes |
861
808
  |---|---|---|---|---|
862
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, finviz, fmp. |
809
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
863
810
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
864
811
  | `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. |
865
812
  | `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. |
866
- | `page` | `no` | `integer | null` | `0` | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters. (provider: benzinga) |
867
- | `date` | `no` | `string | null` | `-` | Date for calendar data, shorthand for date_from and date_to. (provider: benzinga) |
868
- | `updated` | `no` | `string | integer | null` | `-` | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD. (provider: benzinga) |
869
- | `importance` | `no` | `integer | null` | `-` | Importance level to filter by. Uses Greater Than or Equal To the importance indicated (provider: benzinga) |
870
- | `action` | `no` | `string | null` | `-` | Filter by a specific action_company. (provider: benzinga) |
871
- | `analyst_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. (provider: benzinga) |
872
- | `firm_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of firm IDs. Multiple comma separated items allowed. (provider: benzinga) |
873
- | `fields` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. (provider: benzinga) |
874
- | `provider` | `yes` | `string` | `-` | enum: benzinga, finnhub, finviz, fmp |
813
+ | `page` | `no` | `integer | null` | `0` | Page offset. For optimization, performance and technical reasons, page offsets are limited from 0 - 100000. Limit the query results by other parameters such as date. Used in conjunction with the limit and date parameters. |
814
+ | `date` | `no` | `string | null` | `-` | Date for calendar data, shorthand for date_from and date_to. |
815
+ | `updated` | `no` | `string | integer | null` | `-` | Records last Updated Unix timestamp (UTC). This will force the sort order to be Greater Than or Equal to the timestamp indicated. The date can be a date string or a Unix timestamp. The date string must be in the format of YYYY-MM-DD. |
816
+ | `importance` | `no` | `integer | null` | `-` | Importance level to filter by. Uses Greater Than or Equal To the importance indicated |
817
+ | `action` | `no` | `string | null` | `-` | Filter by a specific action_company. |
818
+ | `analyst_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of analyst (person) IDs. Omitting will bring back all available analysts. Multiple comma separated items allowed. |
819
+ | `firm_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of firm IDs. Multiple comma separated items allowed. |
820
+ | `fields` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of fields to include in the response. See https://docs.benzinga.io/benzinga-apis/calendar/get-ratings to learn about the available fields. Multiple comma separated items allowed. |
875
821
 
876
822
  ---
877
823
 
878
824
  ### `equity.fundamental.balance`
879
825
 
880
826
  ```python
881
- data.equity.fundamental.balance(symbol=..., limit=None, period='annual', fiscal_year=None, provider=...)
827
+ data.equity.fundamental.balance(symbol=..., limit=None, period='annual', fiscal_year=None)
882
828
  ```
883
829
 
884
830
  Summary: Balance
@@ -888,7 +834,6 @@ Summary: Balance
888
834
  | Endpoint ID | `equity.fundamental.balance` |
889
835
  | HTTP | `GET` |
890
836
  | Path | `/inner/v1/agent-data/equity/fundamental/balance` |
891
- | Default provider | - |
892
837
  | SDK | `supported` |
893
838
  | Host | `supported` |
894
839
  | Notes | - |
@@ -899,16 +844,15 @@ Summary: Balance
899
844
  |---|---|---|---|---|
900
845
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
901
846
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
902
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp,intrinio, yfinance) |
903
- | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
904
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
847
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
848
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
905
849
 
906
850
  ---
907
851
 
908
852
  ### `equity.fundamental.balance_growth`
909
853
 
910
854
  ```python
911
- data.equity.fundamental.balance_growth(symbol=..., limit=None, period='annual', provider='fmp')
855
+ data.equity.fundamental.balance_growth(symbol=..., limit=None, period='annual')
912
856
  ```
913
857
 
914
858
  Summary: Balance Growth
@@ -918,7 +862,6 @@ Summary: Balance Growth
918
862
  | Endpoint ID | `equity.fundamental.balance_growth` |
919
863
  | HTTP | `GET` |
920
864
  | Path | `/inner/v1/agent-data/equity/fundamental/balance_growth` |
921
- | Default provider | `fmp` |
922
865
  | SDK | `supported` |
923
866
  | Host | `supported` |
924
867
  | Notes | - |
@@ -928,16 +871,15 @@ Summary: Balance Growth
928
871
  | Param | Required | Type | Default | Notes |
929
872
  |---|---|---|---|---|
930
873
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
931
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: fmp) |
932
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
933
- | `provider` | `no` | `string` | `fmp` | - |
874
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
875
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
934
876
 
935
877
  ---
936
878
 
937
879
  ### `equity.fundamental.cash`
938
880
 
939
881
  ```python
940
- data.equity.fundamental.cash(symbol=..., limit=5, period='annual', fiscal_year=None, provider=...)
882
+ data.equity.fundamental.cash(symbol=..., limit=5, period='annual', fiscal_year=None)
941
883
  ```
942
884
 
943
885
  Summary: Cash
@@ -947,7 +889,6 @@ Summary: Cash
947
889
  | Endpoint ID | `equity.fundamental.cash` |
948
890
  | HTTP | `GET` |
949
891
  | Path | `/inner/v1/agent-data/equity/fundamental/cash` |
950
- | Default provider | - |
951
892
  | SDK | `supported` |
952
893
  | Host | `supported` |
953
894
  | Notes | - |
@@ -958,16 +899,15 @@ Summary: Cash
958
899
  |---|---|---|---|---|
959
900
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
960
901
  | `limit` | `no` | `integer | null` | `5` | The number of data entries to return. |
961
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp,intrinio, yfinance) |
962
- | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
963
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
902
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
903
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
964
904
 
965
905
  ---
966
906
 
967
907
  ### `equity.fundamental.cash_growth`
968
908
 
969
909
  ```python
970
- data.equity.fundamental.cash_growth(symbol=..., limit=None, period='annual', provider='fmp')
910
+ data.equity.fundamental.cash_growth(symbol=..., limit=None, period='annual')
971
911
  ```
972
912
 
973
913
  Summary: Cash Growth
@@ -977,7 +917,6 @@ Summary: Cash Growth
977
917
  | Endpoint ID | `equity.fundamental.cash_growth` |
978
918
  | HTTP | `GET` |
979
919
  | Path | `/inner/v1/agent-data/equity/fundamental/cash_growth` |
980
- | Default provider | `fmp` |
981
920
  | SDK | `supported` |
982
921
  | Host | `supported` |
983
922
  | Notes | - |
@@ -988,15 +927,14 @@ Summary: Cash Growth
988
927
  |---|---|---|---|---|
989
928
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
990
929
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
991
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
992
- | `provider` | `no` | `string` | `fmp` | - |
930
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
993
931
 
994
932
  ---
995
933
 
996
934
  ### `equity.fundamental.dividends`
997
935
 
998
936
  ```python
999
- data.equity.fundamental.dividends(symbol=..., start_time=None, end_time=None, limit=None, provider=...)
937
+ data.equity.fundamental.dividends(symbol=..., start_time=None, end_time=None, limit=None)
1000
938
  ```
1001
939
 
1002
940
  Summary: Dividends
@@ -1006,7 +944,6 @@ Summary: Dividends
1006
944
  | Endpoint ID | `equity.fundamental.dividends` |
1007
945
  | HTTP | `GET` |
1008
946
  | Path | `/inner/v1/agent-data/equity/fundamental/dividends` |
1009
- | Default provider | - |
1010
947
  | SDK | `supported` |
1011
948
  | Host | `supported` |
1012
949
  | Notes | - |
@@ -1015,18 +952,17 @@ Summary: Dividends
1015
952
 
1016
953
  | Param | Required | Type | Default | Notes |
1017
954
  |---|---|---|---|---|
1018
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, nasdaq. |
955
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1019
956
  | `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. |
1020
957
  | `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. |
1021
- | `limit` | `no` | `integer | null` | `-` | Return N most recent payments. (provider: fmp); The number of data entries to return. (provider: intrinio) |
1022
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, nasdaq, tmx, yfinance |
958
+ | `limit` | `no` | `integer | null` | `-` | Return N most recent payments.; The number of data entries to return. |
1023
959
 
1024
960
  ---
1025
961
 
1026
962
  ### `equity.fundamental.employee_count`
1027
963
 
1028
964
  ```python
1029
- data.equity.fundamental.employee_count(symbol=..., start_time=None, end_time=None, limit=None, provider='fmp')
965
+ data.equity.fundamental.employee_count(symbol=..., start_time=None, end_time=None, limit=None)
1030
966
  ```
1031
967
 
1032
968
  Summary: Employee Count
@@ -1036,7 +972,6 @@ Summary: Employee Count
1036
972
  | Endpoint ID | `equity.fundamental.employee_count` |
1037
973
  | HTTP | `GET` |
1038
974
  | Path | `/inner/v1/agent-data/equity/fundamental/employee_count` |
1039
- | Default provider | `fmp` |
1040
975
  | SDK | `supported` |
1041
976
  | Host | `supported` |
1042
977
  | Notes | - |
@@ -1045,18 +980,17 @@ Summary: Employee Count
1045
980
 
1046
981
  | Param | Required | Type | Default | Notes |
1047
982
  |---|---|---|---|---|
1048
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
983
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1049
984
  | `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. |
1050
985
  | `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. |
1051
- | `limit` | `no` | `integer | null` | `-` | Number of records to return. Default is all. (provider: fmp) |
1052
- | `provider` | `no` | `string` | `fmp` | - |
986
+ | `limit` | `no` | `integer | null` | `-` | Number of records to return. Default is all. |
1053
987
 
1054
988
  ---
1055
989
 
1056
990
  ### `equity.fundamental.esg_score`
1057
991
 
1058
992
  ```python
1059
- data.equity.fundamental.esg_score(symbol=..., provider='fmp')
993
+ data.equity.fundamental.esg_score(symbol=...)
1060
994
  ```
1061
995
 
1062
996
  Summary: Esg Score
@@ -1066,7 +1000,6 @@ Summary: Esg Score
1066
1000
  | Endpoint ID | `equity.fundamental.esg_score` |
1067
1001
  | HTTP | `GET` |
1068
1002
  | Path | `/inner/v1/agent-data/equity/fundamental/esg_score` |
1069
- | Default provider | `fmp` |
1070
1003
  | SDK | `supported` |
1071
1004
  | Host | `supported` |
1072
1005
  | Notes | - |
@@ -1075,15 +1008,14 @@ Summary: Esg Score
1075
1008
 
1076
1009
  | Param | Required | Type | Default | Notes |
1077
1010
  |---|---|---|---|---|
1078
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
1079
- | `provider` | `no` | `string` | `fmp` | - |
1011
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1080
1012
 
1081
1013
  ---
1082
1014
 
1083
1015
  ### `equity.fundamental.filings`
1084
1016
 
1085
1017
  ```python
1086
- data.equity.fundamental.filings(symbol=None, start_time=None, end_time=None, cik=None, limit=1000, page=0, form_type=None, thea_enabled=None, year=None, form_group='8k', use_cache=True, provider=...)
1018
+ data.equity.fundamental.filings(symbol=None, start_time=None, end_time=None, cik=None, limit=1000, page=0, form_type=None, thea_enabled=None, year=None, form_group='8k', use_cache=True)
1087
1019
  ```
1088
1020
 
1089
1021
  Summary: Filings
@@ -1093,7 +1025,6 @@ Summary: Filings
1093
1025
  | Endpoint ID | `equity.fundamental.filings` |
1094
1026
  | HTTP | `GET` |
1095
1027
  | Path | `/inner/v1/agent-data/equity/fundamental/filings` |
1096
- | Default provider | - |
1097
1028
  | SDK | `supported` |
1098
1029
  | Host | `supported` |
1099
1030
  | Notes | - |
@@ -1105,22 +1036,21 @@ Summary: Filings
1105
1036
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
1106
1037
  | `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. |
1107
1038
  | `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. |
1108
- | `cik` | `no` | `string | integer | null` | `-` | CIK number to look up. Overrides symbol. (provider: fmp); Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec) |
1109
- | `limit` | `no` | `integer | null` | `1000` | Number of results to return. Max results is 1000. (provider: fmp); The number of data entries to return. (provider: intrinio); The number of data entries to return. (provider: sec) |
1110
- | `page` | `no` | `integer` | `0` | Page number for paginated results. Max page is 100. (provider: fmp) |
1111
- | `form_type` | `no` | `string | null` | `-` | SEC form type to filter by. (provider: intrinio, sec) |
1112
- | `thea_enabled` | `no` | `boolean | null` | `-` | Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio) |
1113
- | `year` | `no` | `integer | null` | `-` | Calendar year of the data, default is current year. The earliest year available is 1994, for all companies and form types. (provider: nasdaq) |
1114
- | `form_group` | `no` | `string` | `8k` | enum: annual, quarterly, proxy, insider, 8k, registration, comment The form group to fetch, default is 8k. (provider: nasdaq) |
1115
- | `use_cache` | `no` | `boolean` | `true` | Whether or not to use cache. If True, cache will store for one day. (provider: sec) |
1116
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, nasdaq, sec, tmx |
1039
+ | `cik` | `no` | `string | integer | null` | `-` | CIK number to look up. Overrides symbol.; Lookup filings by Central Index Key (CIK) instead of by symbol. |
1040
+ | `limit` | `no` | `integer | null` | `1000` | Number of results to return. Max results is 1000.; The number of data entries to return. |
1041
+ | `page` | `no` | `integer` | `0` | Page number for paginated results. Max page is 100. |
1042
+ | `form_type` | `no` | `string | null` | `-` | SEC form type to filter by. |
1043
+ | `thea_enabled` | `no` | `boolean | null` | `-` | Return filings that have been read by Intrinio's Thea NLP. |
1044
+ | `year` | `no` | `integer | null` | `-` | Calendar year of the data, default is current year. The earliest year available is 1994, for all companies and form types. |
1045
+ | `form_group` | `no` | `string` | `8k` | enum: annual, quarterly, proxy, insider, 8k, registration, comment The form group to fetch, default is 8k. |
1046
+ | `use_cache` | `no` | `boolean` | `true` | Whether or not to use cache. If True, cache will store for one day. |
1117
1047
 
1118
1048
  ---
1119
1049
 
1120
1050
  ### `equity.fundamental.historical_attributes`
1121
1051
 
1122
1052
  ```python
1123
- data.equity.fundamental.historical_attributes(symbol=..., tag=..., start_time=None, end_time=None, frequency='yearly', limit=1000, tag_type=None, sort='desc', provider='intrinio')
1053
+ data.equity.fundamental.historical_attributes(symbol=..., tag=..., start_time=None, end_time=None, frequency='yearly', limit=1000, tag_type=None, sort='desc')
1124
1054
  ```
1125
1055
 
1126
1056
  Summary: Historical Attributes
@@ -1130,7 +1060,6 @@ Summary: Historical Attributes
1130
1060
  | Endpoint ID | `equity.fundamental.historical_attributes` |
1131
1061
  | HTTP | `GET` |
1132
1062
  | Path | `/inner/v1/agent-data/equity/fundamental/historical_attributes` |
1133
- | Default provider | `intrinio` |
1134
1063
  | SDK | `supported` |
1135
1064
  | Host | `supported` |
1136
1065
  | Notes | - |
@@ -1139,22 +1068,21 @@ Summary: Historical Attributes
1139
1068
 
1140
1069
  | Param | Required | Type | Default | Notes |
1141
1070
  |---|---|---|---|---|
1142
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
1143
- | `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. |
1071
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1072
+ | `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed |
1144
1073
  | `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. |
1145
1074
  | `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. |
1146
1075
  | `frequency` | `no` | `string | null` | `yearly` | The frequency of the data. |
1147
1076
  | `limit` | `no` | `integer | null` | `1000` | The number of data entries to return. |
1148
1077
  | `tag_type` | `no` | `string | null` | `-` | Filter by type, when applicable. |
1149
1078
  | `sort` | `no` | `string | null` | `desc` | Sort order. |
1150
- | `provider` | `no` | `string` | `intrinio` | - |
1151
1079
 
1152
1080
  ---
1153
1081
 
1154
1082
  ### `equity.fundamental.historical_eps`
1155
1083
 
1156
1084
  ```python
1157
- data.equity.fundamental.historical_eps(symbol=..., period='quarter', limit=None, provider=...)
1085
+ data.equity.fundamental.historical_eps(symbol=..., period='quarter', limit=None)
1158
1086
  ```
1159
1087
 
1160
1088
  Summary: Historical Eps
@@ -1164,7 +1092,6 @@ Summary: Historical Eps
1164
1092
  | Endpoint ID | `equity.fundamental.historical_eps` |
1165
1093
  | HTTP | `GET` |
1166
1094
  | Path | `/inner/v1/agent-data/equity/fundamental/historical_eps` |
1167
- | Default provider | - |
1168
1095
  | SDK | `supported` |
1169
1096
  | Host | `supported` |
1170
1097
  | Notes | - |
@@ -1173,17 +1100,16 @@ Summary: Historical Eps
1173
1100
 
1174
1101
  | Param | Required | Type | Default | Notes |
1175
1102
  |---|---|---|---|---|
1176
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): alpha_vantage, fmp. |
1177
- | `period` | `no` | `string` | `quarter` | enum: annual, quarter Time period of the data to return. (provider: alpha_vantage) |
1178
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: alpha_vantage, fmp) |
1179
- | `provider` | `yes` | `string` | `-` | enum: alpha_vantage, fmp |
1103
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1104
+ | `period` | `no` | `string` | `quarter` | enum: annual, quarter Time period of the data to return. |
1105
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1180
1106
 
1181
1107
  ---
1182
1108
 
1183
1109
  ### `equity.fundamental.historical_splits`
1184
1110
 
1185
1111
  ```python
1186
- data.equity.fundamental.historical_splits(symbol=..., provider='fmp')
1112
+ data.equity.fundamental.historical_splits(symbol=...)
1187
1113
  ```
1188
1114
 
1189
1115
  Summary: Historical Splits
@@ -1193,7 +1119,6 @@ Summary: Historical Splits
1193
1119
  | Endpoint ID | `equity.fundamental.historical_splits` |
1194
1120
  | HTTP | `GET` |
1195
1121
  | Path | `/inner/v1/agent-data/equity/fundamental/historical_splits` |
1196
- | Default provider | `fmp` |
1197
1122
  | SDK | `supported` |
1198
1123
  | Host | `supported` |
1199
1124
  | Notes | - |
@@ -1203,14 +1128,13 @@ Summary: Historical Splits
1203
1128
  | Param | Required | Type | Default | Notes |
1204
1129
  |---|---|---|---|---|
1205
1130
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1206
- | `provider` | `no` | `string` | `fmp` | - |
1207
1131
 
1208
1132
  ---
1209
1133
 
1210
1134
  ### `equity.fundamental.income`
1211
1135
 
1212
1136
  ```python
1213
- data.equity.fundamental.income(symbol=..., limit=None, period='annual', fiscal_year=None, provider=...)
1137
+ data.equity.fundamental.income(symbol=..., limit=None, period='annual', fiscal_year=None)
1214
1138
  ```
1215
1139
 
1216
1140
  Summary: Income
@@ -1220,7 +1144,6 @@ Summary: Income
1220
1144
  | Endpoint ID | `equity.fundamental.income` |
1221
1145
  | HTTP | `GET` |
1222
1146
  | Path | `/inner/v1/agent-data/equity/fundamental/income` |
1223
- | Default provider | - |
1224
1147
  | SDK | `supported` |
1225
1148
  | Host | `supported` |
1226
1149
  | Notes | - |
@@ -1231,16 +1154,15 @@ Summary: Income
1231
1154
  |---|---|---|---|---|
1232
1155
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1233
1156
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1234
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp,intrinio, yfinance) |
1235
- | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
1236
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
1157
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1158
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1237
1159
 
1238
1160
  ---
1239
1161
 
1240
1162
  ### `equity.fundamental.income_growth`
1241
1163
 
1242
1164
  ```python
1243
- data.equity.fundamental.income_growth(symbol=..., limit=None, period='annual', provider='fmp')
1165
+ data.equity.fundamental.income_growth(symbol=..., limit=None, period='annual')
1244
1166
  ```
1245
1167
 
1246
1168
  Summary: Income Growth
@@ -1250,7 +1172,6 @@ Summary: Income Growth
1250
1172
  | Endpoint ID | `equity.fundamental.income_growth` |
1251
1173
  | HTTP | `GET` |
1252
1174
  | Path | `/inner/v1/agent-data/equity/fundamental/income_growth` |
1253
- | Default provider | `fmp` |
1254
1175
  | SDK | `supported` |
1255
1176
  | Host | `supported` |
1256
1177
  | Notes | - |
@@ -1261,15 +1182,14 @@ Summary: Income Growth
1261
1182
  |---|---|---|---|---|
1262
1183
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1263
1184
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1264
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
1265
- | `provider` | `no` | `string` | `fmp` | - |
1185
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1266
1186
 
1267
1187
  ---
1268
1188
 
1269
1189
  ### `equity.fundamental.latest_attributes`
1270
1190
 
1271
1191
  ```python
1272
- data.equity.fundamental.latest_attributes(symbol=..., tag=..., provider='intrinio')
1192
+ data.equity.fundamental.latest_attributes(symbol=..., tag=...)
1273
1193
  ```
1274
1194
 
1275
1195
  Summary: Latest Attributes
@@ -1279,7 +1199,6 @@ Summary: Latest Attributes
1279
1199
  | Endpoint ID | `equity.fundamental.latest_attributes` |
1280
1200
  | HTTP | `GET` |
1281
1201
  | Path | `/inner/v1/agent-data/equity/fundamental/latest_attributes` |
1282
- | Default provider | `intrinio` |
1283
1202
  | SDK | `supported` |
1284
1203
  | Host | `supported` |
1285
1204
  | Notes | - |
@@ -1288,16 +1207,15 @@ Summary: Latest Attributes
1288
1207
 
1289
1208
  | Param | Required | Type | Default | Notes |
1290
1209
  |---|---|---|---|---|
1291
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
1292
- | `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed for provider(s): intrinio. |
1293
- | `provider` | `no` | `string` | `intrinio` | - |
1210
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1211
+ | `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed |
1294
1212
 
1295
1213
  ---
1296
1214
 
1297
1215
  ### `equity.fundamental.management`
1298
1216
 
1299
1217
  ```python
1300
- data.equity.fundamental.management(symbol=..., provider=...)
1218
+ data.equity.fundamental.management(symbol=...)
1301
1219
  ```
1302
1220
 
1303
1221
  Summary: Management
@@ -1307,7 +1225,6 @@ Summary: Management
1307
1225
  | Endpoint ID | `equity.fundamental.management` |
1308
1226
  | HTTP | `GET` |
1309
1227
  | Path | `/inner/v1/agent-data/equity/fundamental/management` |
1310
- | Default provider | - |
1311
1228
  | SDK | `supported` |
1312
1229
  | Host | `supported` |
1313
1230
  | Notes | - |
@@ -1317,14 +1234,13 @@ Summary: Management
1317
1234
  | Param | Required | Type | Default | Notes |
1318
1235
  |---|---|---|---|---|
1319
1236
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1320
- | `provider` | `yes` | `string` | `-` | enum: fmp, yfinance |
1321
1237
 
1322
1238
  ---
1323
1239
 
1324
1240
  ### `equity.fundamental.management_compensation`
1325
1241
 
1326
1242
  ```python
1327
- data.equity.fundamental.management_compensation(symbol=..., year=-1, provider='fmp')
1243
+ data.equity.fundamental.management_compensation(symbol=..., year=-1)
1328
1244
  ```
1329
1245
 
1330
1246
  Summary: Management Compensation
@@ -1334,7 +1250,6 @@ Summary: Management Compensation
1334
1250
  | Endpoint ID | `equity.fundamental.management_compensation` |
1335
1251
  | HTTP | `GET` |
1336
1252
  | Path | `/inner/v1/agent-data/equity/fundamental/management_compensation` |
1337
- | Default provider | `fmp` |
1338
1253
  | SDK | `supported` |
1339
1254
  | Host | `supported` |
1340
1255
  | Notes | - |
@@ -1343,16 +1258,15 @@ Summary: Management Compensation
1343
1258
 
1344
1259
  | Param | Required | Type | Default | Notes |
1345
1260
  |---|---|---|---|---|
1346
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
1347
- | `year` | `no` | `integer` | `-1` | Filters results by year, enter 0 for all data available. Default is the most recent year in the dataset, -1. (provider: fmp) |
1348
- | `provider` | `no` | `string` | `fmp` | - |
1261
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1262
+ | `year` | `no` | `integer` | `-1` | Filters results by year, enter 0 for all data available. Default is the most recent year in the dataset, -1. |
1349
1263
 
1350
1264
  ---
1351
1265
 
1352
1266
  ### `equity.fundamental.management_discussion_analysis`
1353
1267
 
1354
1268
  ```python
1355
- data.equity.fundamental.management_discussion_analysis(symbol=..., calendar_year=None, calendar_period=None, include_tables=True, use_cache=True, raw_html=False, provider='sec')
1269
+ data.equity.fundamental.management_discussion_analysis(symbol=..., calendar_year=None, calendar_period=None, include_tables=True, use_cache=True, raw_html=False)
1356
1270
  ```
1357
1271
 
1358
1272
  Summary: Management Discussion Analysis
@@ -1362,7 +1276,6 @@ Summary: Management Discussion Analysis
1362
1276
  | Endpoint ID | `equity.fundamental.management_discussion_analysis` |
1363
1277
  | HTTP | `GET` |
1364
1278
  | Path | `/inner/v1/agent-data/equity/fundamental/management_discussion_analysis` |
1365
- | Default provider | `sec` |
1366
1279
  | SDK | `supported` |
1367
1280
  | Host | `supported` |
1368
1281
  | Notes | - |
@@ -1374,17 +1287,16 @@ Summary: Management Discussion Analysis
1374
1287
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1375
1288
  | `calendar_year` | `no` | `integer | null` | `-` | Calendar year of the report. By default, is the current year. If the calendar period is not provided, but the calendar year is, it will return the annual report. |
1376
1289
  | `calendar_period` | `no` | `string | null` | `-` | Calendar period of the report. By default, is the most recent report available for the symbol. If no calendar year and no calendar period are provided, it will return the most recent report. |
1377
- | `include_tables` | `no` | `boolean` | `true` | Return tables formatted as markdown in the text. Default is True. (provider: sec) |
1378
- | `use_cache` | `no` | `boolean` | `true` | When True, the file will be cached for use later. Default is True. (provider: sec) |
1379
- | `raw_html` | `no` | `boolean` | `false` | When True, the raw HTML content of the entire filing will be returned. Default is False. Use this option to parse the document manually. (provider: sec) |
1380
- | `provider` | `no` | `string` | `sec` | - |
1290
+ | `include_tables` | `no` | `boolean` | `true` | Return tables formatted as markdown in the text. Default is True. |
1291
+ | `use_cache` | `no` | `boolean` | `true` | When True, the file will be cached for use later. Default is True. |
1292
+ | `raw_html` | `no` | `boolean` | `false` | When True, the raw HTML content of the entire filing will be returned. Default is False. Use this option to parse the document manually. |
1381
1293
 
1382
1294
  ---
1383
1295
 
1384
1296
  ### `equity.fundamental.metrics`
1385
1297
 
1386
1298
  ```python
1387
- data.equity.fundamental.metrics(symbol=..., ttm='only', period='annual', limit=None, provider=...)
1299
+ data.equity.fundamental.metrics(symbol=..., ttm='only', period='annual', limit=None)
1388
1300
  ```
1389
1301
 
1390
1302
  Summary: Metrics
@@ -1394,7 +1306,6 @@ Summary: Metrics
1394
1306
  | Endpoint ID | `equity.fundamental.metrics` |
1395
1307
  | HTTP | `GET` |
1396
1308
  | Path | `/inner/v1/agent-data/equity/fundamental/metrics` |
1397
- | Default provider | - |
1398
1309
  | SDK | `supported` |
1399
1310
  | Host | `supported` |
1400
1311
  | Notes | - |
@@ -1403,18 +1314,17 @@ Summary: Metrics
1403
1314
 
1404
1315
  | Param | Required | Type | Default | Notes |
1405
1316
  |---|---|---|---|---|
1406
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp, intrinio, yfinance. |
1407
- | `ttm` | `no` | `string` | `only` | enum: include, exclude, only Specify whether to include, exclude, or only show TTM (Trailing Twelve Months) data. The default is 'only'. (provider: fmp) |
1408
- | `period` | `no` | `string` | `annual` | enum: q1, q2, q3, q4, fy, annual, quarter Specify the fiscal period for the data. Ignored when TTM is set to 'only'. (provider: fmp) |
1409
- | `limit` | `no` | `integer | null` | `-` | Only applicable when TTM is not set to 'only'. Defines the number of most recent reporting periods to return. The default is 5. (provider: fmp) |
1410
- | `provider` | `yes` | `string` | `-` | enum: finviz, fmp, intrinio, yfinance |
1317
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1318
+ | `ttm` | `no` | `string` | `only` | enum: include, exclude, only Specify whether to include, exclude, or only show TTM (Trailing Twelve Months) data. The default is 'only'. |
1319
+ | `period` | `no` | `string` | `annual` | enum: q1, q2, q3, q4, fy, annual, quarter Specify the fiscal period for the data. Ignored when TTM is set to 'only'. |
1320
+ | `limit` | `no` | `integer | null` | `-` | Only applicable when TTM is not set to 'only'. Defines the number of most recent reporting periods to return. The default is 5. |
1411
1321
 
1412
1322
  ---
1413
1323
 
1414
1324
  ### `equity.fundamental.ratios`
1415
1325
 
1416
1326
  ```python
1417
- data.equity.fundamental.ratios(symbol=..., limit=None, ttm='only', period='annual', fiscal_year=None, provider=...)
1327
+ data.equity.fundamental.ratios(symbol=..., limit=None, ttm='only', period='annual', fiscal_year=None)
1418
1328
  ```
1419
1329
 
1420
1330
  Summary: Ratios
@@ -1424,7 +1334,6 @@ Summary: Ratios
1424
1334
  | Endpoint ID | `equity.fundamental.ratios` |
1425
1335
  | HTTP | `GET` |
1426
1336
  | Path | `/inner/v1/agent-data/equity/fundamental/ratios` |
1427
- | Default provider | - |
1428
1337
  | SDK | `supported` |
1429
1338
  | Host | `supported` |
1430
1339
  | Notes | - |
@@ -1433,19 +1342,18 @@ Summary: Ratios
1433
1342
 
1434
1343
  | Param | Required | Type | Default | Notes |
1435
1344
  |---|---|---|---|---|
1436
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
1437
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; Only applicable when TTM is not set to 'only'. Defines the number of most recent reporting periods to return. The default is 5. (provider: fmp) |
1438
- | `ttm` | `no` | `string` | `only` | enum: include, exclude, only Specify whether to include, exclude, or only show TTM (Trailing Twelve Months) data. The default is 'only'. (provider: fmp) |
1439
- | `period` | `no` | `string` | `annual` | Specify the fiscal period for the data. (provider: fmp); Time period of the data to return. (provider: intrinio) |
1440
- | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
1441
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
1345
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1346
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; Only applicable when TTM is not set to 'only'. Defines the number of most recent reporting periods to return. The default is 5. |
1347
+ | `ttm` | `no` | `string` | `only` | enum: include, exclude, only Specify whether to include, exclude, or only show TTM (Trailing Twelve Months) data. The default is 'only'. |
1348
+ | `period` | `no` | `string` | `annual` | Specify the fiscal period for the data.; Time period of the data to return. |
1349
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1442
1350
 
1443
1351
  ---
1444
1352
 
1445
1353
  ### `equity.fundamental.reported_financials`
1446
1354
 
1447
1355
  ```python
1448
- data.equity.fundamental.reported_financials(symbol=..., period='annual', statement_type='balance', limit=100, fiscal_year=None, provider='intrinio')
1356
+ data.equity.fundamental.reported_financials(symbol=..., period='annual', statement_type='balance', limit=100, fiscal_year=None)
1449
1357
  ```
1450
1358
 
1451
1359
  Summary: Reported Financials
@@ -1455,7 +1363,6 @@ Summary: Reported Financials
1455
1363
  | Endpoint ID | `equity.fundamental.reported_financials` |
1456
1364
  | HTTP | `GET` |
1457
1365
  | Path | `/inner/v1/agent-data/equity/fundamental/reported_financials` |
1458
- | Default provider | `intrinio` |
1459
1366
  | SDK | `supported` |
1460
1367
  | Host | `supported` |
1461
1368
  | Notes | - |
@@ -1466,17 +1373,16 @@ Summary: Reported Financials
1466
1373
  |---|---|---|---|---|
1467
1374
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1468
1375
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1469
- | `statement_type` | `no` | `string` | `balance` | The type of financial statement - i.e, balance, income, cash.; Cash flow statements are reported as YTD, Q4 is the same as FY. (provider: intrinio) |
1376
+ | `statement_type` | `no` | `string` | `balance` | The type of financial statement - i.e, balance, income, cash.; Cash flow statements are reported as YTD, Q4 is the same as FY. |
1470
1377
  | `limit` | `no` | `integer | null` | `100` | The number of data entries to return. Although the response object contains multiple results, because of the variance in the fields, year-to-year and quarter-to-quarter, it is recommended to view results in small chunks. |
1471
- | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. (provider: intrinio) |
1472
- | `provider` | `no` | `string` | `intrinio` | - |
1378
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1473
1379
 
1474
1380
  ---
1475
1381
 
1476
1382
  ### `equity.fundamental.revenue_per_geography`
1477
1383
 
1478
1384
  ```python
1479
- data.equity.fundamental.revenue_per_geography(symbol=..., period='annual', provider='fmp')
1385
+ data.equity.fundamental.revenue_per_geography(symbol=..., period='annual')
1480
1386
  ```
1481
1387
 
1482
1388
  Summary: Revenue Per Geography
@@ -1486,7 +1392,6 @@ Summary: Revenue Per Geography
1486
1392
  | Endpoint ID | `equity.fundamental.revenue_per_geography` |
1487
1393
  | HTTP | `GET` |
1488
1394
  | Path | `/inner/v1/agent-data/equity/fundamental/revenue_per_geography` |
1489
- | Default provider | `fmp` |
1490
1395
  | SDK | `supported` |
1491
1396
  | Host | `supported` |
1492
1397
  | Notes | - |
@@ -1496,15 +1401,14 @@ Summary: Revenue Per Geography
1496
1401
  | Param | Required | Type | Default | Notes |
1497
1402
  |---|---|---|---|---|
1498
1403
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1499
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
1500
- | `provider` | `no` | `string` | `fmp` | - |
1404
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1501
1405
 
1502
1406
  ---
1503
1407
 
1504
1408
  ### `equity.fundamental.revenue_per_segment`
1505
1409
 
1506
1410
  ```python
1507
- data.equity.fundamental.revenue_per_segment(symbol=..., period='annual', provider='fmp')
1411
+ data.equity.fundamental.revenue_per_segment(symbol=..., period='annual')
1508
1412
  ```
1509
1413
 
1510
1414
  Summary: Revenue Per Segment
@@ -1514,7 +1418,6 @@ Summary: Revenue Per Segment
1514
1418
  | Endpoint ID | `equity.fundamental.revenue_per_segment` |
1515
1419
  | HTTP | `GET` |
1516
1420
  | Path | `/inner/v1/agent-data/equity/fundamental/revenue_per_segment` |
1517
- | Default provider | `fmp` |
1518
1421
  | SDK | `supported` |
1519
1422
  | Host | `supported` |
1520
1423
  | Notes | - |
@@ -1524,15 +1427,14 @@ Summary: Revenue Per Segment
1524
1427
  | Param | Required | Type | Default | Notes |
1525
1428
  |---|---|---|---|---|
1526
1429
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1527
- | `period` | `no` | `string` | `annual` | Time period of the data to return. (provider: fmp) |
1528
- | `provider` | `no` | `string` | `fmp` | - |
1430
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1529
1431
 
1530
1432
  ---
1531
1433
 
1532
1434
  ### `equity.fundamental.search_attributes`
1533
1435
 
1534
1436
  ```python
1535
- data.equity.fundamental.search_attributes(query=..., limit=1000, provider='intrinio')
1437
+ data.equity.fundamental.search_attributes(query=..., limit=1000)
1536
1438
  ```
1537
1439
 
1538
1440
  Summary: Search Attributes
@@ -1542,7 +1444,6 @@ Summary: Search Attributes
1542
1444
  | Endpoint ID | `equity.fundamental.search_attributes` |
1543
1445
  | HTTP | `GET` |
1544
1446
  | Path | `/inner/v1/agent-data/equity/fundamental/search_attributes` |
1545
- | Default provider | `intrinio` |
1546
1447
  | SDK | `supported` |
1547
1448
  | Host | `supported` |
1548
1449
  | Notes | - |
@@ -1553,14 +1454,13 @@ Summary: Search Attributes
1553
1454
  |---|---|---|---|---|
1554
1455
  | `query` | `yes` | `string` | `-` | Query to search for. |
1555
1456
  | `limit` | `no` | `integer | null` | `1000` | The number of data entries to return. |
1556
- | `provider` | `no` | `string` | `intrinio` | - |
1557
1457
 
1558
1458
  ---
1559
1459
 
1560
1460
  ### `equity.fundamental.trailing_dividend_yield`
1561
1461
 
1562
1462
  ```python
1563
- data.equity.fundamental.trailing_dividend_yield(symbol=..., limit=252, provider='tiingo')
1463
+ data.equity.fundamental.trailing_dividend_yield(symbol=..., limit=252)
1564
1464
  ```
1565
1465
 
1566
1466
  Summary: Trailing Dividend Yield
@@ -1570,7 +1470,6 @@ Summary: Trailing Dividend Yield
1570
1470
  | Endpoint ID | `equity.fundamental.trailing_dividend_yield` |
1571
1471
  | HTTP | `GET` |
1572
1472
  | Path | `/inner/v1/agent-data/equity/fundamental/trailing_dividend_yield` |
1573
- | Default provider | `tiingo` |
1574
1473
  | SDK | `supported` |
1575
1474
  | Host | `supported` |
1576
1475
  | Notes | - |
@@ -1581,14 +1480,13 @@ Summary: Trailing Dividend Yield
1581
1480
  |---|---|---|---|---|
1582
1481
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1583
1482
  | `limit` | `no` | `integer | null` | `252` | The number of data entries to return. Default is 252, the number of trading days in a year. |
1584
- | `provider` | `no` | `string` | `tiingo` | - |
1585
1483
 
1586
1484
  ---
1587
1485
 
1588
1486
  ### `equity.fundamental.transcript`
1589
1487
 
1590
1488
  ```python
1591
- data.equity.fundamental.transcript(symbol=..., year=None, quarter=None, provider='fmp')
1489
+ data.equity.fundamental.transcript(symbol=..., year=None, quarter=None)
1592
1490
  ```
1593
1491
 
1594
1492
  Summary: Transcript
@@ -1598,7 +1496,6 @@ Summary: Transcript
1598
1496
  | Endpoint ID | `equity.fundamental.transcript` |
1599
1497
  | HTTP | `GET` |
1600
1498
  | Path | `/inner/v1/agent-data/equity/fundamental/transcript` |
1601
- | Default provider | `fmp` |
1602
1499
  | SDK | `supported` |
1603
1500
  | Host | `supported` |
1604
1501
  | Notes | - |
@@ -1610,14 +1507,13 @@ Summary: Transcript
1610
1507
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1611
1508
  | `year` | `no` | `integer | null` | `-` | Year of the earnings call transcript. |
1612
1509
  | `quarter` | `no` | `integer | null` | `-` | Quarterly period of the earnings call transcript. |
1613
- | `provider` | `no` | `string` | `fmp` | - |
1614
1510
 
1615
1511
  ---
1616
1512
 
1617
1513
  ### `equity.historical_market_cap`
1618
1514
 
1619
1515
  ```python
1620
- data.equity.historical_market_cap(symbol=..., start_time=None, end_time=None, interval='day', provider=...)
1516
+ data.equity.historical_market_cap(symbol=..., start_time=None, end_time=None, interval='day')
1621
1517
  ```
1622
1518
 
1623
1519
  Summary: Historical Market Cap
@@ -1627,7 +1523,6 @@ Summary: Historical Market Cap
1627
1523
  | Endpoint ID | `equity.historical_market_cap` |
1628
1524
  | HTTP | `GET` |
1629
1525
  | Path | `/inner/v1/agent-data/equity/historical_market_cap` |
1630
- | Default provider | - |
1631
1526
  | SDK | `supported` |
1632
1527
  | Host | `supported` |
1633
1528
  | Notes | - |
@@ -1636,18 +1531,17 @@ Summary: Historical Market Cap
1636
1531
 
1637
1532
  | Param | Required | Type | Default | Notes |
1638
1533
  |---|---|---|---|---|
1639
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. |
1534
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1640
1535
  | `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. |
1641
1536
  | `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. |
1642
1537
  | `interval` | `no` | `string` | `day` | enum: day, week, month, quarter, year None |
1643
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
1644
1538
 
1645
1539
  ---
1646
1540
 
1647
1541
  ### `equity.market_snapshots`
1648
1542
 
1649
1543
  ```python
1650
- data.equity.market_snapshots(market='nasdaq', date=None, provider=...)
1544
+ data.equity.market_snapshots(market='nasdaq', date=None)
1651
1545
  ```
1652
1546
 
1653
1547
  Summary: Market Snapshots
@@ -1657,7 +1551,6 @@ Summary: Market Snapshots
1657
1551
  | Endpoint ID | `equity.market_snapshots` |
1658
1552
  | HTTP | `GET` |
1659
1553
  | Path | `/inner/v1/agent-data/equity/market_snapshots` |
1660
- | Default provider | - |
1661
1554
  | SDK | `supported` |
1662
1555
  | Host | `supported` |
1663
1556
  | Notes | - |
@@ -1666,16 +1559,15 @@ Summary: Market Snapshots
1666
1559
 
1667
1560
  | Param | Required | Type | Default | Notes |
1668
1561
  |---|---|---|---|---|
1669
- | `market` | `no` | `string` | `nasdaq` | enum: amex, ams, ase, asx, ath, bme, bru, bud, bue, cai, cnq, commodity, cph, crypto, dfm, doh, dus, etf, euronext, forex, hel, hkse, ice, iob, index, ist, jkt, jnb, jpx, kls, koe, ksc, kuw, lse, mex, mil, mutual_fund, nasdaq, neo, nse, nyse, nze, osl, otc, pnk, pra, ris, sao, sau, ses, set, sgo, shh, shz, six, sto, tai, tlv, tsx, two, vie, wse, xetra The market to fetch data for. (provider: fmp) |
1670
- | `date` | `no` | `string | null` | `-` | The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400' (provider: intrinio) |
1671
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
1562
+ | `market` | `no` | `string` | `nasdaq` | enum: amex, ams, ase, asx, ath, bme, bru, bud, bue, cai, cnq, commodity, cph, crypto, dfm, doh, dus, etf, euronext, forex, hel, hkse, ice, iob, index, ist, jkt, jnb, jpx, kls, koe, ksc, kuw, lse, mex, mil, mutual_fund, nasdaq, neo, nse, nyse, nze, osl, otc, pnk, pra, ris, sao, sau, ses, set, sgo, shh, shz, six, sto, tai, tlv, tsx, two, vie, wse, xetra The market to fetch data for. |
1563
+ | `date` | `no` | `string | null` | `-` | The date of the data. Can be a datetime or an ISO datetime string. Historical data appears to go back to mid-June 2022. Example: '2024-03-08T12:15:00+0400' |
1672
1564
 
1673
1565
  ---
1674
1566
 
1675
1567
  ### `equity.ownership.form_13f`
1676
1568
 
1677
1569
  ```python
1678
- data.equity.ownership.form_13f(symbol=..., date=None, limit=1, provider='sec')
1570
+ data.equity.ownership.form_13f(symbol=..., date=None, limit=1)
1679
1571
  ```
1680
1572
 
1681
1573
  Summary: Form 13F
@@ -1685,7 +1577,6 @@ Summary: Form 13F
1685
1577
  | Endpoint ID | `equity.ownership.form_13f` |
1686
1578
  | HTTP | `GET` |
1687
1579
  | Path | `/inner/v1/agent-data/equity/ownership/form_13f` |
1688
- | Default provider | `sec` |
1689
1580
  | SDK | `supported` |
1690
1581
  | Host | `supported` |
1691
1582
  | Notes | - |
@@ -1697,14 +1588,13 @@ Summary: Form 13F
1697
1588
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. A CIK can be used. |
1698
1589
  | `date` | `no` | `string | null` | `-` | A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported. |
1699
1590
  | `limit` | `no` | `integer | null` | `1` | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. |
1700
- | `provider` | `no` | `string` | `sec` | - |
1701
1591
 
1702
1592
  ---
1703
1593
 
1704
1594
  ### `equity.ownership.government_trades`
1705
1595
 
1706
1596
  ```python
1707
- data.equity.ownership.government_trades(symbol=None, chamber='all', limit=None, provider='fmp')
1597
+ data.equity.ownership.government_trades(symbol=None, chamber='all', limit=None)
1708
1598
  ```
1709
1599
 
1710
1600
  Summary: Government Trades
@@ -1714,7 +1604,6 @@ Summary: Government Trades
1714
1604
  | Endpoint ID | `equity.ownership.government_trades` |
1715
1605
  | HTTP | `GET` |
1716
1606
  | Path | `/inner/v1/agent-data/equity/ownership/government_trades` |
1717
- | Default provider | `fmp` |
1718
1607
  | SDK | `supported` |
1719
1608
  | Host | `supported` |
1720
1609
  | Notes | - |
@@ -1723,17 +1612,16 @@ Summary: Government Trades
1723
1612
 
1724
1613
  | Param | Required | Type | Default | Notes |
1725
1614
  |---|---|---|---|---|
1726
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
1615
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1727
1616
  | `chamber` | `no` | `string` | `all` | Government Chamber. |
1728
1617
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1729
- | `provider` | `no` | `string` | `fmp` | - |
1730
1618
 
1731
1619
  ---
1732
1620
 
1733
1621
  ### `equity.ownership.insider_trading`
1734
1622
 
1735
1623
  ```python
1736
- data.equity.ownership.insider_trading(symbol=..., limit=None, start_time=None, end_time=None, transaction_type=None, statistics=False, ownership_type=None, sort_by='updated_on', use_cache=True, summary=False, provider=...)
1624
+ data.equity.ownership.insider_trading(symbol=..., limit=None, start_time=None, end_time=None, transaction_type=None, statistics=False, ownership_type=None, sort_by='updated_on', use_cache=True, summary=False)
1737
1625
  ```
1738
1626
 
1739
1627
  Summary: Insider Trading
@@ -1743,7 +1631,6 @@ Summary: Insider Trading
1743
1631
  | Endpoint ID | `equity.ownership.insider_trading` |
1744
1632
  | HTTP | `GET` |
1745
1633
  | Path | `/inner/v1/agent-data/equity/ownership/insider_trading` |
1746
- | Default provider | - |
1747
1634
  | SDK | `supported` |
1748
1635
  | Host | `supported` |
1749
1636
  | Notes | - |
@@ -1756,20 +1643,19 @@ Summary: Insider Trading
1756
1643
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1757
1644
  | `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. |
1758
1645
  | `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. |
1759
- | `transaction_type` | `no` | `string | null` | `-` | Type of the transaction. (provider: fmp) |
1760
- | `statistics` | `no` | `boolean` | `false` | Flag to return summary statistics for the given symbol. Setting as True will ignore other parameters except symbol. (provider: fmp) |
1761
- | `ownership_type` | `no` | `string | null` | `-` | Type of ownership. (provider: intrinio) |
1762
- | `sort_by` | `no` | `string | null` | `updated_on` | Field to sort by. (provider: intrinio) |
1763
- | `use_cache` | `no` | `boolean` | `true` | Persist the data locally for future use. Default is True. Each form submission is an individual download and the SEC limits the number of concurrent downloads. This prevents the same file from being downloaded multiple times. (provider: sec) |
1764
- | `summary` | `no` | `boolean` | `false` | Return a summary of the insider activity instead of the individuals. (provider: tmx) |
1765
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, sec, tmx |
1646
+ | `transaction_type` | `no` | `string | null` | `-` | Type of the transaction. |
1647
+ | `statistics` | `no` | `boolean` | `false` | Flag to return summary statistics for the given symbol. Setting as True will ignore other parameters except symbol. |
1648
+ | `ownership_type` | `no` | `string | null` | `-` | Type of ownership. |
1649
+ | `sort_by` | `no` | `string | null` | `updated_on` | Field to sort by. |
1650
+ | `use_cache` | `no` | `boolean` | `true` | Persist the data locally for future use. Default is True. Each form submission is an individual download and the SEC limits the number of concurrent downloads. This prevents the same file from being downloaded multiple times. |
1651
+ | `summary` | `no` | `boolean` | `false` | Return a summary of the insider activity instead of the individuals. |
1766
1652
 
1767
1653
  ---
1768
1654
 
1769
1655
  ### `equity.ownership.institutional`
1770
1656
 
1771
1657
  ```python
1772
- data.equity.ownership.institutional(symbol=..., year=None, quarter=None, provider='fmp')
1658
+ data.equity.ownership.institutional(symbol=..., year=None, quarter=None)
1773
1659
  ```
1774
1660
 
1775
1661
  Summary: Institutional
@@ -1779,7 +1665,6 @@ Summary: Institutional
1779
1665
  | Endpoint ID | `equity.ownership.institutional` |
1780
1666
  | HTTP | `GET` |
1781
1667
  | Path | `/inner/v1/agent-data/equity/ownership/institutional` |
1782
- | Default provider | `fmp` |
1783
1668
  | SDK | `supported` |
1784
1669
  | Host | `supported` |
1785
1670
  | Notes | - |
@@ -1788,17 +1673,16 @@ Summary: Institutional
1788
1673
 
1789
1674
  | Param | Required | Type | Default | Notes |
1790
1675
  |---|---|---|---|---|
1791
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
1792
- | `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. (provider: fmp) |
1793
- | `quarter` | `no` | `integer | null` | `-` | Calendar quarter for the data. Valid values are 1, 2, 3, or 4. If not provided, the quarter previous to the current quarter is used. (provider: fmp) |
1794
- | `provider` | `no` | `string` | `fmp` | - |
1676
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1677
+ | `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. |
1678
+ | `quarter` | `no` | `integer | null` | `-` | Calendar quarter for the data. Valid values are 1, 2, 3, or 4. If not provided, the quarter previous to the current quarter is used. |
1795
1679
 
1796
1680
  ---
1797
1681
 
1798
1682
  ### `equity.ownership.major_holders`
1799
1683
 
1800
1684
  ```python
1801
- data.equity.ownership.major_holders(symbol=..., year=None, quarter=None, page=None, limit=None, provider='fmp')
1685
+ data.equity.ownership.major_holders(symbol=..., year=None, quarter=None, page=None, limit=None)
1802
1686
  ```
1803
1687
 
1804
1688
  Summary: Major Holders
@@ -1808,7 +1692,6 @@ Summary: Major Holders
1808
1692
  | Endpoint ID | `equity.ownership.major_holders` |
1809
1693
  | HTTP | `GET` |
1810
1694
  | Path | `/inner/v1/agent-data/equity/ownership/major_holders` |
1811
- | Default provider | `fmp` |
1812
1695
  | SDK | `supported` |
1813
1696
  | Host | `supported` |
1814
1697
  | Notes | - |
@@ -1818,18 +1701,17 @@ Summary: Major Holders
1818
1701
  | Param | Required | Type | Default | Notes |
1819
1702
  |---|---|---|---|---|
1820
1703
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1821
- | `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. (provider: fmp) |
1822
- | `quarter` | `no` | `integer | null` | `-` | Calendar quarter for the data. Valid values are 1, 2, 3, or 4. If not provided, the quarter previous to the current quarter is used. (provider: fmp) |
1823
- | `page` | `no` | `integer | null` | `-` | Page number, used in conjunction with the limit. The default is 0. (provider: fmp) |
1824
- | `limit` | `no` | `integer | null` | `-` | Number of items to return per page. The default is 100, which is the maximum. (provider: fmp) |
1825
- | `provider` | `no` | `string` | `fmp` | - |
1704
+ | `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. |
1705
+ | `quarter` | `no` | `integer | null` | `-` | Calendar quarter for the data. Valid values are 1, 2, 3, or 4. If not provided, the quarter previous to the current quarter is used. |
1706
+ | `page` | `no` | `integer | null` | `-` | Page number, used in conjunction with the limit. The default is 0. |
1707
+ | `limit` | `no` | `integer | null` | `-` | Number of items to return per page. The default is 100, which is the maximum. |
1826
1708
 
1827
1709
  ---
1828
1710
 
1829
1711
  ### `equity.ownership.share_statistics`
1830
1712
 
1831
1713
  ```python
1832
- data.equity.ownership.share_statistics(symbol=..., provider=...)
1714
+ data.equity.ownership.share_statistics(symbol=...)
1833
1715
  ```
1834
1716
 
1835
1717
  Summary: Share Statistics
@@ -1839,7 +1721,6 @@ Summary: Share Statistics
1839
1721
  | Endpoint ID | `equity.ownership.share_statistics` |
1840
1722
  | HTTP | `GET` |
1841
1723
  | Path | `/inner/v1/agent-data/equity/ownership/share_statistics` |
1842
- | Default provider | - |
1843
1724
  | SDK | `supported` |
1844
1725
  | Host | `supported` |
1845
1726
  | Notes | - |
@@ -1848,15 +1729,14 @@ Summary: Share Statistics
1848
1729
 
1849
1730
  | Param | Required | Type | Default | Notes |
1850
1731
  |---|---|---|---|---|
1851
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, yfinance. |
1852
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio, yfinance |
1732
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1853
1733
 
1854
1734
  ---
1855
1735
 
1856
1736
  ### `equity.price.historical`
1857
1737
 
1858
1738
  ```python
1859
- data.equity.price.historical(symbol=..., start_time=None, end_time=None, interval='daily', market='a_share', adjust='qfq', 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=...)
1739
+ data.equity.price.historical(symbol=..., start_time=None, end_time=None, interval='daily', market='a_share', adjust='qfq', 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)
1860
1740
  ```
1861
1741
 
1862
1742
  Summary: Historical
@@ -1866,7 +1746,6 @@ Summary: Historical
1866
1746
  | Endpoint ID | `equity.price.historical` |
1867
1747
  | HTTP | `GET` |
1868
1748
  | Path | `/inner/v1/agent-data/equity/price/historical` |
1869
- | Default provider | - |
1870
1749
  | SDK | `supported` |
1871
1750
  | Host | `supported` |
1872
1751
  | Notes | - |
@@ -1875,28 +1754,27 @@ Summary: Historical
1875
1754
 
1876
1755
  | Param | Required | Type | Default | Notes |
1877
1756
  |---|---|---|---|---|
1878
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): akshare, alpha_vantage, cboe, fmp, tiingo, tmx, tradier, yfinance.; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). (provider: intrinio) |
1757
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). |
1879
1758
  | `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. |
1880
1759
  | `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. |
1881
- | `interval` | `no` | `string | integer` | `daily` | Data granularity: daily, weekly, or monthly. (provider: akshare); Time interval of the data to return. (provider: alpha_vantage); Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals. (provider: cboe); Time interval of the data to return. (provider: fmp); Time interval of the data to return. (provider: intrinio); Time interval of the data to return. (provider: tiingo); Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022. (provider: tmx); Time interval of the data to return. (provider: tradier); Time interval of the data to return. (provider: yfinance) |
1882
- | `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. (provider: akshare) |
1883
- | `adjust` | `no` | `string` | `qfq` | enum: , qfq, hfq Price adjustment method. '' for unadjusted, 'qfq' for forward-adjusted (前复权), 'hfq' for backward-adjusted (后复权). (provider: akshare) |
1884
- | `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) |
1885
- | `extended_hours` | `no` | `boolean` | `false` | Include Pre and Post market data. (provider: alpha_vantage,tradier, yfinance) |
1886
- | `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) |
1887
- | `start_clock_time` | `no` | `string | null` | `-` | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. (provider: intrinio) |
1888
- | `end_clock_time` | `no` | `string | null` | `-` | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. (provider: intrinio) |
1889
- | `timezone` | `no` | `string | null` | `America/New_York` | Timezone of the data, in the IANA format (Continent/City). (provider: intrinio) |
1890
- | `source` | `no` | `string` | `realtime` | enum: realtime, delayed, nasdaq_basic The source of the data. (provider: intrinio) |
1891
- | `include_actions` | `no` | `boolean` | `true` | Include dividends and stock splits in results. (provider: yfinance) |
1892
- | `provider` | `yes` | `string` | `-` | enum: akshare, alpha_vantage, cboe, finnhub, fmp, intrinio, tiingo, tmx, tradier, yfinance |
1760
+ | `interval` | `no` | `string | integer` | `daily` | Data granularity: daily, weekly, or monthly.; Time interval of the data to return.; Time interval of the data to return. The most recent trading day is not including in daily historical data. Intraday data is only available for the most recent trading day at 1 minute intervals.; Time interval of the data to return. Or, any integer (entered as a string) representing the number of minutes. Default is daily data. There is no extended hours data, and intraday data is limited to after April 12 2022. |
1761
+ | `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. |
1762
+ | `adjust` | `no` | `string` | `qfq` | enum: , qfq, hfq Price adjustment method. '' for unadjusted, 'qfq' for forward-adjusted (前复权), 'hfq' for backward-adjusted (后复权). |
1763
+ | `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. |
1764
+ | `extended_hours` | `no` | `boolean` | `false` | Include Pre and Post market data. |
1765
+ | `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. |
1766
+ | `start_clock_time` | `no` | `string | null` | `-` | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. |
1767
+ | `end_clock_time` | `no` | `string | null` | `-` | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. |
1768
+ | `timezone` | `no` | `string | null` | `America/New_York` | Timezone of the data, in the IANA format (Continent/City). |
1769
+ | `source` | `no` | `string` | `realtime` | enum: realtime, delayed, nasdaq_basic The source of the data. |
1770
+ | `include_actions` | `no` | `boolean` | `true` | Include dividends and stock splits in results. |
1893
1771
 
1894
1772
  ---
1895
1773
 
1896
1774
  ### `equity.price.performance`
1897
1775
 
1898
1776
  ```python
1899
- data.equity.price.performance(symbol=..., provider=...)
1777
+ data.equity.price.performance(symbol=...)
1900
1778
  ```
1901
1779
 
1902
1780
  Summary: Performance
@@ -1906,7 +1784,6 @@ Summary: Performance
1906
1784
  | Endpoint ID | `equity.price.performance` |
1907
1785
  | HTTP | `GET` |
1908
1786
  | Path | `/inner/v1/agent-data/equity/price/performance` |
1909
- | Default provider | - |
1910
1787
  | SDK | `supported` |
1911
1788
  | Host | `supported` |
1912
1789
  | Notes | - |
@@ -1915,15 +1792,14 @@ Summary: Performance
1915
1792
 
1916
1793
  | Param | Required | Type | Default | Notes |
1917
1794
  |---|---|---|---|---|
1918
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): finviz, fmp. |
1919
- | `provider` | `yes` | `string` | `-` | enum: finviz, fmp |
1795
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1920
1796
 
1921
1797
  ---
1922
1798
 
1923
1799
  ### `equity.price.quote`
1924
1800
 
1925
1801
  ```python
1926
- data.equity.price.quote(symbol=..., market='a_share', use_cache=True, source='iex', provider=...)
1802
+ data.equity.price.quote(symbol=..., market='a_share', use_cache=True, source='iex')
1927
1803
  ```
1928
1804
 
1929
1805
  Summary: Quote
@@ -1933,7 +1809,6 @@ Summary: Quote
1933
1809
  | Endpoint ID | `equity.price.quote` |
1934
1810
  | HTTP | `GET` |
1935
1811
  | Path | `/inner/v1/agent-data/equity/price/quote` |
1936
- | Default provider | - |
1937
1812
  | SDK | `supported` |
1938
1813
  | Host | `supported` |
1939
1814
  | Notes | - |
@@ -1942,18 +1817,17 @@ Summary: Quote
1942
1817
 
1943
1818
  | Param | Required | Type | Default | Notes |
1944
1819
  |---|---|---|---|---|
1945
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): akshare, cboe, fmp, intrinio, tmx, tradier, yfinance.; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). (provider: intrinio) |
1946
- | `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. (provider: akshare) |
1947
- | `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) |
1948
- | `source` | `no` | `string` | `iex` | enum: iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed, intrinio_mx, intrinio_mx_plus, delayed_sip Source of the data. (provider: intrinio) |
1949
- | `provider` | `yes` | `string` | `-` | enum: akshare, cboe, finnhub, fmp, intrinio, tmx, tradier, yfinance |
1820
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). |
1821
+ | `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. |
1822
+ | `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. |
1823
+ | `source` | `no` | `string` | `iex` | enum: iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed, intrinio_mx, intrinio_mx_plus, delayed_sip Source of the data. |
1950
1824
 
1951
1825
  ---
1952
1826
 
1953
1827
  ### `equity.profile`
1954
1828
 
1955
1829
  ```python
1956
- data.equity.profile(symbol=..., provider=...)
1830
+ data.equity.profile(symbol=...)
1957
1831
  ```
1958
1832
 
1959
1833
  Summary: Profile
@@ -1963,7 +1837,6 @@ Summary: Profile
1963
1837
  | Endpoint ID | `equity.profile` |
1964
1838
  | HTTP | `GET` |
1965
1839
  | Path | `/inner/v1/agent-data/equity/profile` |
1966
- | Default provider | - |
1967
1840
  | SDK | `supported` |
1968
1841
  | Host | `supported` |
1969
1842
  | Notes | - |
@@ -1972,15 +1845,14 @@ Summary: Profile
1972
1845
 
1973
1846
  | Param | Required | Type | Default | Notes |
1974
1847
  |---|---|---|---|---|
1975
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): akshare, finviz, fmp, intrinio, tmx, yfinance. |
1976
- | `provider` | `yes` | `string` | `-` | enum: akshare, finnhub, finviz, fmp, intrinio, tmx, yfinance |
1848
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1977
1849
 
1978
1850
  ---
1979
1851
 
1980
1852
  ### `equity.screener`
1981
1853
 
1982
1854
  ```python
1983
- data.equity.screener(metric='overview', exchange='all', index='all', sector='all', industry='all', mktcap='all', recommendation='all', signal=None, preset=None, limit=None, mktcap_min=None, mktcap_max=None, price_min=None, price_max=None, beta_min=None, beta_max=None, volume_min=None, volume_max=None, dividend_min=None, dividend_max=None, country=None, is_etf=None, is_active=None, is_fund=None, all_share_classes=None, exsubcategory='all', region='all', provider=..., body=...)
1855
+ data.equity.screener(metric='overview', exchange='all', index='all', sector='all', industry='all', mktcap='all', recommendation='all', signal=None, preset=None, limit=None, mktcap_min=None, mktcap_max=None, price_min=None, price_max=None, beta_min=None, beta_max=None, volume_min=None, volume_max=None, dividend_min=None, dividend_max=None, country=None, is_etf=None, is_active=None, is_fund=None, all_share_classes=None, exsubcategory='all', region='all', body=...)
1984
1856
  ```
1985
1857
 
1986
1858
  Summary: Screener
@@ -1990,7 +1862,6 @@ Summary: Screener
1990
1862
  | Endpoint ID | `equity.screener` |
1991
1863
  | HTTP | `GET` |
1992
1864
  | Path | `/inner/v1/agent-data/equity/screener` |
1993
- | Default provider | - |
1994
1865
  | SDK | `supported` |
1995
1866
  | Host | `supported` |
1996
1867
  | Notes | - |
@@ -1999,42 +1870,41 @@ Summary: Screener
1999
1870
 
2000
1871
  | Param | Required | Type | Default | Notes |
2001
1872
  |---|---|---|---|---|
2002
- | `metric` | `no` | `string` | `overview` | enum: overview, valuation, financial, ownership, performance, technical The data group to return, default is 'overview'. (provider: finviz) |
2003
- | `exchange` | `no` | `string | null` | `all` | Filter by exchange. (provider: finviz,fmp,nasdaq, yfinance) |
2004
- | `index` | `no` | `string` | `all` | enum: all, dow, nasdaq, sp500, russell Filter by index. (provider: finviz) |
2005
- | `sector` | `no` | `string | null` | `all` | Filter by sector. (provider: finviz,fmp,nasdaq, yfinance) |
2006
- | `industry` | `no` | `string | null` | `all` | Filter by industry. (provider: finviz,fmp, yfinance) |
2007
- | `mktcap` | `no` | `string` | `all` | Filter by market cap. Mega - > 200B Large - 10B - 200B Mid - 2B - 10B Small - 300M - 2B Micro - 50M - 300M Nano - < 50M (provider: finviz, nasdaq) |
2008
- | `recommendation` | `no` | `string` | `all` | Filter by analyst recommendation. (provider: finviz); Filter by consensus analyst action. Multiple comma separated items allowed. (provider: nasdaq) |
2009
- | `signal` | `no` | `string | null` | `-` | The Finviz screener signal to use. When no parameters are provided, the screener defaults to 'top_gainers'. Available signals are: channel: both support and resistance trendlines are horizontal channel_down: both support and resistance trendlines slope downward channel_up: both support and resistance trendlines slope upward double_bottom: stock with 'W' shape that indicates a bullish reversal in trend double_top: stock with 'M' shape that indicates a bearish reversal in trend downgrades: stocks downgraded by analysts today earnings_after: companies reporting earnings today, after market close earnings_before: companies reporting earnings today, before market open head_shoulders: chart formation that predicts a bullish-to-bearish trend reversal head_shoulders_inverse: chart formation that predicts a bearish-to-bullish trend reversal horizontal_sr: horizontal channel of price range between support and resistance trendlines major_news: stocks with the highest news coverage today most_active: stocks with the highest trading volume today most_volatile: stocks with the highest widest high/low trading range today multiple_bottom: same as double_bottom hitting more lows multiple_top: same as double_top hitting more highs new_high: stocks making 52-week high today new_low: stocks making 52-week low today overbought: stock is becoming overvalued and may experience a pullback. oversold: oversold stocks may represent a buying opportunity for investors recent_insider_buying: stocks with recent insider buying activity recent_insider_selling: stocks with recent insider selling activity tl_resistance: once a rising trendline is broken tl_support: once a falling trendline is broken top_gainers: stocks with the highest price gain percent today top_losers: stocks with the highest price percent loss today triangle_ascending: upward trendline support and horizontal trendline resistance triangle_descending: horizontal trendline support and downward trendline resistance unusual_volume: stocks with unusually high volume today - the highest relative volume ratio upgrades: stocks upgraded by analysts today wedge: upward trendline support, downward trendline resistance (continuation) wedge_down: downward trendline support and downward trendline resistance (reversal) wedge_up: upward trendline support and upward trendline resistance (reversal) (provider: finviz) |
2010
- | `preset` | `no` | `string | null` | `-` | A configured preset file to use for the query. This overrides all other query parameters except 'metric', and 'limit'. Presets (.ini text files) can be created and modified in the '~/OpenBBUserData/finviz/presets' directory. If the path does not exist, it will be created and populated with the default presets on the first run. Refer to the file, 'screener_template.ini', for the format and options. Note: Syntax of parameters in preset files must follow the template file exactly - i.e, Analyst Recom. = Strong Buy (1) (provider: finviz) |
2011
- | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. (provider: finviz); Limit the number of results to return. (provider: fmp); Limit the number of results to return. (provider: nasdaq); Limit the number of results returned. Default is, 200. Set to, 0, for all results. (provider: yfinance) |
2012
- | `mktcap_min` | `no` | `integer | null` | `-` | Filter by market cap greater than this value. (provider: fmp, yfinance) |
2013
- | `mktcap_max` | `no` | `integer | null` | `-` | Filter by market cap less than this value. (provider: fmp, yfinance) |
2014
- | `price_min` | `no` | `number | null` | `-` | Filter by price greater than this value. (provider: fmp, yfinance) |
2015
- | `price_max` | `no` | `number | null` | `-` | Filter by price less than this value. (provider: fmp, yfinance) |
2016
- | `beta_min` | `no` | `number | null` | `-` | Filter by a beta greater than this value. (provider: fmp, yfinance) |
2017
- | `beta_max` | `no` | `number | null` | `-` | Filter by a beta less than this value. (provider: fmp, yfinance) |
2018
- | `volume_min` | `no` | `integer | null` | `-` | Filter by volume greater than this value. (provider: fmp, yfinance) |
2019
- | `volume_max` | `no` | `integer | null` | `-` | Filter by volume less than this value. (provider: fmp, yfinance) |
2020
- | `dividend_min` | `no` | `number | null` | `-` | Filter by dividend amount greater than this value. (provider: fmp) |
2021
- | `dividend_max` | `no` | `number | null` | `-` | Filter by dividend amount less than this value. (provider: fmp) |
2022
- | `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,nasdaq, yfinance) |
2023
- | `is_etf` | `no` | `boolean | null` | `-` | If true, includes ETFs. (provider: fmp) |
2024
- | `is_active` | `no` | `boolean | null` | `-` | If false, returns only inactive tickers. (provider: fmp) |
2025
- | `is_fund` | `no` | `boolean | null` | `-` | If true, includes funds. (provider: fmp) |
2026
- | `all_share_classes` | `no` | `boolean | null` | `-` | If true, includes all share classes of a equity. (provider: fmp) |
2027
- | `exsubcategory` | `no` | `string` | `all` | Filter by exchange subcategory. - NGS - Nasdaq Global Select Market - NGM - Nasdaq Global Market - NCM - Nasdaq Capital Market - ADR - American Depository Receipt Multiple comma separated items allowed. (provider: nasdaq) |
2028
- | `region` | `no` | `string` | `all` | Filter by region. Multiple comma separated items allowed. (provider: nasdaq) |
2029
- | `provider` | `yes` | `string` | `-` | enum: finviz, fmp, nasdaq, yfinance |
2030
- | `body` | `no` | `object | string | null` | `-` | A formatted dictionary, or serialized JSON string, of additional filters to apply to the query. This parameter can be used as an alternative to preset files, and is ignored when a preset is supplied. Invalid entries will raise an error. Syntax should follow the 'screener_template.ini' file. (provider: finviz) |
1873
+ | `metric` | `no` | `string` | `overview` | enum: overview, valuation, financial, ownership, performance, technical The data group to return, default is 'overview'. |
1874
+ | `exchange` | `no` | `string | null` | `all` | Filter by exchange. |
1875
+ | `index` | `no` | `string` | `all` | enum: all, dow, nasdaq, sp500, russell Filter by index. |
1876
+ | `sector` | `no` | `string | null` | `all` | Filter by sector. |
1877
+ | `industry` | `no` | `string | null` | `all` | Filter by industry. |
1878
+ | `mktcap` | `no` | `string` | `all` | Filter by market cap. Mega - > 200B Large - 10B - 200B Mid - 2B - 10B Small - 300M - 2B Micro - 50M - 300M Nano - < 50M |
1879
+ | `recommendation` | `no` | `string` | `all` | Filter by analyst recommendation.; Filter by consensus analyst action. Multiple comma separated items allowed. |
1880
+ | `signal` | `no` | `string | null` | `-` | The Finviz screener signal to use. When no parameters are provided, the screener defaults to 'top_gainers'. Available signals are: channel: both support and resistance trendlines are horizontal channel_down: both support and resistance trendlines slope downward channel_up: both support and resistance trendlines slope upward double_bottom: stock with 'W' shape that indicates a bullish reversal in trend double_top: stock with 'M' shape that indicates a bearish reversal in trend downgrades: stocks downgraded by analysts today earnings_after: companies reporting earnings today, after market close earnings_before: companies reporting earnings today, before market open head_shoulders: chart formation that predicts a bullish-to-bearish trend reversal head_shoulders_inverse: chart formation that predicts a bearish-to-bullish trend reversal horizontal_sr: horizontal channel of price range between support and resistance trendlines major_news: stocks with the highest news coverage today most_active: stocks with the highest trading volume today most_volatile: stocks with the highest widest high/low trading range today multiple_bottom: same as double_bottom hitting more lows multiple_top: same as double_top hitting more highs new_high: stocks making 52-week high today new_low: stocks making 52-week low today overbought: stock is becoming overvalued and may experience a pullback. oversold: oversold stocks may represent a buying opportunity for investors recent_insider_buying: stocks with recent insider buying activity recent_insider_selling: stocks with recent insider selling activity tl_resistance: once a rising trendline is broken tl_support: once a falling trendline is broken top_gainers: stocks with the highest price gain percent today top_losers: stocks with the highest price percent loss today triangle_ascending: upward trendline support and horizontal trendline resistance triangle_descending: horizontal trendline support and downward trendline resistance unusual_volume: stocks with unusually high volume today - the highest relative volume ratio upgrades: stocks upgraded by analysts today wedge: upward trendline support, downward trendline resistance (continuation) wedge_down: downward trendline support and downward trendline resistance (reversal) wedge_up: upward trendline support and upward trendline resistance (reversal) |
1881
+ | `preset` | `no` | `string | null` | `-` | A configured preset file to use for the query. This overrides all other query parameters except 'metric', and 'limit'. Presets (.ini text files) can be created and modified in the '~/OpenBBUserData/finviz/presets' directory. If the path does not exist, it will be created and populated with the default presets on the first run. Refer to the file, 'screener_template.ini', for the format and options. Note: Syntax of parameters in preset files must follow the template file exactly - i.e, Analyst Recom. = Strong Buy (1) |
1882
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; Limit the number of results to return.; Limit the number of results returned. Default is, 200. Set to, 0, for all results. |
1883
+ | `mktcap_min` | `no` | `integer | null` | `-` | Filter by market cap greater than this value. |
1884
+ | `mktcap_max` | `no` | `integer | null` | `-` | Filter by market cap less than this value. |
1885
+ | `price_min` | `no` | `number | null` | `-` | Filter by price greater than this value. |
1886
+ | `price_max` | `no` | `number | null` | `-` | Filter by price less than this value. |
1887
+ | `beta_min` | `no` | `number | null` | `-` | Filter by a beta greater than this value. |
1888
+ | `beta_max` | `no` | `number | null` | `-` | Filter by a beta less than this value. |
1889
+ | `volume_min` | `no` | `integer | null` | `-` | Filter by volume greater than this value. |
1890
+ | `volume_max` | `no` | `integer | null` | `-` | Filter by volume less than this value. |
1891
+ | `dividend_min` | `no` | `number | null` | `-` | Filter by dividend amount greater than this value. |
1892
+ | `dividend_max` | `no` | `number | null` | `-` | Filter by dividend amount less than this value. |
1893
+ | `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'). |
1894
+ | `is_etf` | `no` | `boolean | null` | `-` | If true, includes ETFs. |
1895
+ | `is_active` | `no` | `boolean | null` | `-` | If false, returns only inactive tickers. |
1896
+ | `is_fund` | `no` | `boolean | null` | `-` | If true, includes funds. |
1897
+ | `all_share_classes` | `no` | `boolean | null` | `-` | If true, includes all share classes of a equity. |
1898
+ | `exsubcategory` | `no` | `string` | `all` | Filter by exchange subcategory. - NGS - Nasdaq Global Select Market - NGM - Nasdaq Global Market - NCM - Nasdaq Capital Market - ADR - American Depository Receipt Multiple comma separated items allowed. |
1899
+ | `region` | `no` | `string` | `all` | Filter by region. Multiple comma separated items allowed. |
1900
+ | `body` | `no` | `object | string | null` | `-` | A formatted dictionary, or serialized JSON string, of additional filters to apply to the query. This parameter can be used as an alternative to preset files, and is ignored when a preset is supplied. Invalid entries will raise an error. Syntax should follow the 'screener_template.ini' file. |
2031
1901
 
2032
1902
  ---
2033
1903
 
2034
1904
  ### `equity.search`
2035
1905
 
2036
1906
  ```python
2037
- data.equity.search(query='', is_symbol=False, use_cache=True, active=True, limit=10000, is_etf=False, is_fund=False, provider=...)
1907
+ data.equity.search(query='', is_symbol=False, use_cache=True, active=True, limit=10000, is_etf=False, is_fund=False)
2038
1908
  ```
2039
1909
 
2040
1910
  Summary: Search
@@ -2044,7 +1914,6 @@ Summary: Search
2044
1914
  | Endpoint ID | `equity.search` |
2045
1915
  | HTTP | `GET` |
2046
1916
  | Path | `/inner/v1/agent-data/equity/search` |
2047
- | Default provider | - |
2048
1917
  | SDK | `supported` |
2049
1918
  | Host | `supported` |
2050
1919
  | Notes | - |
@@ -2054,20 +1923,19 @@ Summary: Search
2054
1923
  | Param | Required | Type | Default | Notes |
2055
1924
  |---|---|---|---|---|
2056
1925
  | `query` | `no` | `string` | `` | Search query. |
2057
- | `is_symbol` | `no` | `boolean` | `false` | Whether to search by ticker symbol.; Whether the query is a symbol. Defaults to False. (provider: tradier) |
2058
- | `use_cache` | `no` | `boolean` | `true` | Whether to use the cache or not. (provider: cboe, sec); Whether to use a cached request. The list of companies is cached for two days. (provider: tmx) |
2059
- | `active` | `no` | `boolean` | `true` | When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. (provider: intrinio) |
2060
- | `limit` | `no` | `integer | null` | `10000` | The number of data entries to return. (provider: intrinio) |
2061
- | `is_etf` | `no` | `boolean` | `false` | If True, returns only ETFs. (provider: nasdaq) |
2062
- | `is_fund` | `no` | `boolean` | `false` | Whether to direct the search to the list of mutual funds and ETFs. (provider: sec) |
2063
- | `provider` | `yes` | `string` | `-` | enum: cboe, intrinio, nasdaq, sec, tmx, tradier |
1926
+ | `is_symbol` | `no` | `boolean` | `false` | Whether to search by ticker symbol.; Whether the query is a symbol. Defaults to False. |
1927
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use the cache or not.; Whether to use a cached request. The list of companies is cached for two days. |
1928
+ | `active` | `no` | `boolean` | `true` | When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. |
1929
+ | `limit` | `no` | `integer | null` | `10000` | The number of data entries to return. |
1930
+ | `is_etf` | `no` | `boolean` | `false` | If True, returns only ETFs. |
1931
+ | `is_fund` | `no` | `boolean` | `false` | Whether to direct the search to the list of mutual funds and ETFs. |
2064
1932
 
2065
1933
  ---
2066
1934
 
2067
1935
  ### `equity.shorts.fails_to_deliver`
2068
1936
 
2069
1937
  ```python
2070
- data.equity.shorts.fails_to_deliver(symbol=..., limit=24, skip_reports=0, use_cache=True, provider='sec')
1938
+ data.equity.shorts.fails_to_deliver(symbol=..., limit=24, skip_reports=0, use_cache=True)
2071
1939
  ```
2072
1940
 
2073
1941
  Summary: Fails To Deliver
@@ -2077,7 +1945,6 @@ Summary: Fails To Deliver
2077
1945
  | Endpoint ID | `equity.shorts.fails_to_deliver` |
2078
1946
  | HTTP | `GET` |
2079
1947
  | Path | `/inner/v1/agent-data/equity/shorts/fails_to_deliver` |
2080
- | Default provider | `sec` |
2081
1948
  | SDK | `supported` |
2082
1949
  | Host | `supported` |
2083
1950
  | Notes | - |
@@ -2087,17 +1954,16 @@ Summary: Fails To Deliver
2087
1954
  | Param | Required | Type | Default | Notes |
2088
1955
  |---|---|---|---|---|
2089
1956
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
2090
- | `limit` | `no` | `integer | null` | `24` | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. (provider: sec) |
2091
- | `skip_reports` | `no` | `integer | null` | `0` | Skip N number of reports from current. A value of 1 will skip the most recent report. (provider: sec) |
2092
- | `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache. (provider: sec) |
2093
- | `provider` | `no` | `string` | `sec` | - |
1957
+ | `limit` | `no` | `integer | null` | `24` | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. |
1958
+ | `skip_reports` | `no` | `integer | null` | `0` | Skip N number of reports from current. A value of 1 will skip the most recent report. |
1959
+ | `use_cache` | `no` | `boolean | null` | `true` | Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache. |
2094
1960
 
2095
1961
  ---
2096
1962
 
2097
1963
  ### `equity.shorts.short_interest`
2098
1964
 
2099
1965
  ```python
2100
- data.equity.shorts.short_interest(symbol=..., provider='finra')
1966
+ data.equity.shorts.short_interest(symbol=...)
2101
1967
  ```
2102
1968
 
2103
1969
  Summary: Short Interest
@@ -2107,7 +1973,6 @@ Summary: Short Interest
2107
1973
  | Endpoint ID | `equity.shorts.short_interest` |
2108
1974
  | HTTP | `GET` |
2109
1975
  | Path | `/inner/v1/agent-data/equity/shorts/short_interest` |
2110
- | Default provider | `finra` |
2111
1976
  | SDK | `supported` |
2112
1977
  | Host | `supported` |
2113
1978
  | Notes | - |
@@ -2117,4 +1982,3 @@ Summary: Short Interest
2117
1982
  | Param | Required | Type | Default | Notes |
2118
1983
  |---|---|---|---|---|
2119
1984
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
2120
- | `provider` | `no` | `string` | `finra` | - |