@bitget-ai/getagent-skill 0.2.1 → 0.3.0

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 (38) hide show
  1. package/.claude-plugin/marketplace.json +15 -4
  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 +169 -6
  6. package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
  7. package/skills/getagent/references/api/confirm.md +59 -0
  8. package/skills/getagent/references/api/index.md +9 -7
  9. package/skills/getagent/references/api/publish.md +13 -6
  10. package/skills/getagent/references/api/run.md +5 -5
  11. package/skills/getagent/references/api/upload.md +22 -4
  12. package/skills/getagent/references/backtest-engine.md +82 -152
  13. package/skills/getagent/references/package-schema.md +31 -8
  14. package/skills/getagent/references/sdk/backtest/catalog.md +17 -2
  15. package/skills/getagent/references/sdk/data/arxiv.md +8 -10
  16. package/skills/getagent/references/sdk/data/catalog.md +3 -8
  17. package/skills/getagent/references/sdk/data/commodity.md +71 -39
  18. package/skills/getagent/references/sdk/data/coverage.md +0 -3
  19. package/skills/getagent/references/sdk/data/crypto.md +1583 -402
  20. package/skills/getagent/references/sdk/data/currency.md +55 -15
  21. package/skills/getagent/references/sdk/data/derivatives.md +161 -50
  22. package/skills/getagent/references/sdk/data/economy.md +911 -259
  23. package/skills/getagent/references/sdk/data/equity.md +1719 -393
  24. package/skills/getagent/references/sdk/data/etf.md +550 -64
  25. package/skills/getagent/references/sdk/data/famafrench.md +38 -50
  26. package/skills/getagent/references/sdk/data/fixedincome.md +574 -139
  27. package/skills/getagent/references/sdk/data/imf_utils.md +0 -8
  28. package/skills/getagent/references/sdk/data/index.md +18 -32
  29. package/skills/getagent/references/sdk/data/news.md +128 -58
  30. package/skills/getagent/references/sdk/data/regulators.md +108 -43
  31. package/skills/getagent/references/sdk/data/sentiment.md +188 -34
  32. package/skills/getagent/references/sdk/data/uscongress.md +13 -21
  33. package/skills/getagent/references/sdk/data/web_search.md +3 -7
  34. package/skills/getagent/references/sdk/data/wikipedia.md +12 -18
  35. package/skills/getagent/references/sdk.md +14 -5
  36. package/skills/getagent/scripts/validate.py +109 -3
  37. package/skills/getagent/scripts/version_check.sh +13 -12
  38. package/skills/getagent/references/sdk/data/playbook-supported.md +0 -9871
@@ -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,29 @@ 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 |
102
+
103
+ #### Response fields
104
+
105
+ | Field | Type | Notes |
106
+ |---|---|---|
107
+ | `ex_dividend_date` | `string` | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. |
108
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
109
+ | `amount` | `number` | The dividend amount per share. |
110
+ | `name` | `string` | Name of the entity. |
111
+ | `record_date` | `string` | The record date of ownership for eligibility. |
112
+ | `payment_date` | `string` | The payment date of the dividend. |
113
+ | `declaration_date` | `string` | Declaration date of the dividend. |
114
+ | `annualized_amount` | `number` | The indicated annualized dividend amount. |
115
+ | `adjusted_amount` | `number` | The adjusted-dividend amount. |
116
+ | `dividend_yield` | `number` | Annualized dividend yield. |
117
+ | `frequency` | `string` | Frequency of the regular dividend payment. |
104
118
 
105
119
  ---
106
120
 
107
121
  ### `equity.calendar.earnings`
108
122
 
109
123
  ```python
110
- data.equity.calendar.earnings(start_time=None, end_time=None, symbol=None, country='us', provider=...)
124
+ data.equity.calendar.earnings(start_time=None, end_time=None, symbol=None, country='us')
111
125
  ```
112
126
 
113
127
  Summary: Earnings
@@ -117,7 +131,6 @@ Summary: Earnings
117
131
  | Endpoint ID | `equity.calendar.earnings` |
118
132
  | HTTP | `GET` |
119
133
  | Path | `/inner/v1/agent-data/equity/calendar/earnings` |
120
- | Default provider | - |
121
134
  | SDK | `supported` |
122
135
  | Host | `supported` |
123
136
  | Notes | - |
@@ -129,15 +142,37 @@ Summary: Earnings
129
142
  | `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
143
  | `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
144
  | `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 |
145
+ | `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'). |
146
+
147
+ #### Response fields
148
+
149
+ | Field | Type | Notes |
150
+ |---|---|---|
151
+ | `report_date` | `string` | The date of the earnings report. |
152
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
153
+ | `name` | `string` | Name of the entity. |
154
+ | `eps_previous` | `number` | The earnings-per-share from the same previously reported period. |
155
+ | `eps_consensus` | `number` | The analyst consensus earnings-per-share estimate. |
156
+ | `eps_actual` | `number` | The actual earnings per share announced. |
157
+ | `revenue_consensus` | `number` | The revenue forecast consensus. |
158
+ | `revenue_actual` | `number` | The actual reported revenue. |
159
+ | `last_updated` | `string` | The date the data was updated last. |
160
+ | `surprise_percent` | `number` | The earnings surprise as normalized percentage points. |
161
+ | `num_estimates` | `integer` | The number of analysts providing estimates for the consensus. |
162
+ | `period_ending` | `string` | The fiscal period end date. |
163
+ | `previous_report_date` | `string` | The previous report date for the same period last year. |
164
+ | `reporting_time` | `string` | The reporting time - e.g. after market close. |
165
+ | `market_cap` | `integer` | The market cap (USD) of the reporting entity. |
166
+ | `exchange` | `string` | The primary trading exchange. |
167
+ | `sector_id` | `integer` | The Seeking Alpha Sector ID. |
168
+ | `eps_surprise` | `number` | The EPS surprise in dollars. |
134
169
 
135
170
  ---
136
171
 
137
172
  ### `equity.calendar.events`
138
173
 
139
174
  ```python
140
- data.equity.calendar.events(start_time=None, end_time=None, country=None, provider='fmp')
175
+ data.equity.calendar.events(start_time=None, end_time=None, country=None)
141
176
  ```
142
177
 
143
178
  Summary: Events
@@ -147,7 +182,6 @@ Summary: Events
147
182
  | Endpoint ID | `equity.calendar.events` |
148
183
  | HTTP | `GET` |
149
184
  | Path | `/inner/v1/agent-data/equity/calendar/events` |
150
- | Default provider | `fmp` |
151
185
  | SDK | `supported` |
152
186
  | Host | `supported` |
153
187
  | Notes | - |
@@ -158,15 +192,31 @@ Summary: Events
158
192
  |---|---|---|---|---|
159
193
  | `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
194
  | `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` | - |
195
+ | `country` | `no` | `string | null` | `-` | Country code to filter economic events (e.g., 'US', 'JP', 'CN'). |
196
+
197
+ #### Response fields
198
+
199
+ | Field | Type | Notes |
200
+ |---|---|---|
201
+ | `date` | `string` | The date of the data. The date of the event. |
202
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
203
+ | `country` | `string` | Country code for the economic event. |
204
+ | `event` | `string` | Name of the economic event or data release. |
205
+ | `currency` | `string` | Currency associated with the economic data. |
206
+ | `previous` | `number` | Previous value of the economic indicator. |
207
+ | `estimate` | `number` | Estimated or forecasted value of the economic indicator. |
208
+ | `actual` | `number` | Actual released value of the economic indicator. |
209
+ | `change` | `number` | Change in value from the previous release. |
210
+ | `impact` | `string` | Expected market impact of the economic event. |
211
+ | `changePercentage` | `number` | Percentage change from the previous value. |
212
+ | `unit` | `string` | Unit of measurement for the economic indicator. |
163
213
 
164
214
  ---
165
215
 
166
216
  ### `equity.calendar.ipo`
167
217
 
168
218
  ```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=...)
219
+ 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
220
  ```
171
221
 
172
222
  Summary: Ipo
@@ -176,7 +226,6 @@ Summary: Ipo
176
226
  | Endpoint ID | `equity.calendar.ipo` |
177
227
  | HTTP | `GET` |
178
228
  | Path | `/inner/v1/agent-data/equity/calendar/ipo` |
179
- | Default provider | - |
180
229
  | SDK | `supported` |
181
230
  | Host | `supported` |
182
231
  | Notes | - |
@@ -189,18 +238,54 @@ Summary: Ipo
189
238
  | `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
239
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
191
240
  | `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 |
241
+ | `status` | `no` | `string | null` | `-` | Status of the IPO. [upcoming, priced, or withdrawn]; The status of the IPO. |
242
+ | `min_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount greater than the given amount. |
243
+ | `max_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount less than the given amount. |
244
+ | `is_spo` | `no` | `boolean` | `false` | If True, returns data for secondary public offerings (SPOs). |
245
+
246
+ #### Response fields
247
+
248
+ | Field | Type | Notes |
249
+ |---|---|---|
250
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
251
+ | `ipo_date` | `string` | The date of the IPO, when the stock first trades on a major exchange. |
252
+ | `name` | `string` | The name of the company. |
253
+ | `offer_amount` | `number` | The dollar value of the shares offered. |
254
+ | `share_count` | `integer` | The number of shares offered. |
255
+ | `expected_price_date` | `string` | The date the pricing is expected. |
256
+ | `filed_date` | `string` | The date the IPO was filed. |
257
+ | `withdraw_date` | `string` | The date the IPO was withdrawn. |
258
+ | `deal_status` | `string` | The status of the deal. |
259
+ | `exchange_date` | `string` | Timezone information for the exchange and date of the IPO. |
260
+ | `exchange` | `string` | The exchange where the IPO is listed. |
261
+ | `actions` | `string` | Actions related to the IPO, such as, Expected, Priced, Filed, Amended. |
262
+ | `shares` | `integer` | The number of shares being offered in the IPO. |
263
+ | `price_range` | `string` | The expected price range for the IPO shares. |
264
+ | `market_cap` | `integer` | The estimated market capitalization of the company at the time of the IPO. |
265
+ | `status` | `string` | The status of the IPO. |
266
+ | `share_price` | `number` | The price per share at which the IPO was offered. |
267
+ | `share_price_lowest` | `number` | The expected lowest price per share at which the IPO will be offered. |
268
+ | `share_price_highest` | `number` | The expected highest price per share at which the IPO will be offered. |
269
+ | `share_count_lowest` | `integer` | The expected lowest number of shares that will be offered in the IPO. |
270
+ | `share_count_highest` | `integer` | The expected highest number of shares that will be offered in the IPO. |
271
+ | `announcement_url` | `string` | The URL to the company's announcement of the IPO. |
272
+ | `sec_report_url` | `string` | The URL to the company's S-1, S-1/A, F-1, or F-1/A SEC filing. |
273
+ | `open_price` | `number` | The opening price at the beginning of the first trading day. |
274
+ | `close_price` | `number` | The closing price at the end of the first trading day. |
275
+ | `volume` | `integer` | The volume at the end of the first trading day. |
276
+ | `day_change` | `number` | The percentage change between the open price and the close price on the first trading day. |
277
+ | `week_change` | `number` | The percentage change between the open price on the first trading day and the close price approximately a week after. |
278
+ | `month_change` | `number` | The percentage change between the open price on the first trading day and the close price approximately a month after. |
279
+ | `id` | `string` | The Intrinio ID of the IPO. |
280
+ | `company` | `object` | The company that is going public via the IPO. |
281
+ | `security` | `object` | The primary Security for the Company that is going public via the IPO. |
197
282
 
198
283
  ---
199
284
 
200
285
  ### `equity.calendar.splits`
201
286
 
202
287
  ```python
203
- data.equity.calendar.splits(start_time=None, end_time=None, provider='fmp')
288
+ data.equity.calendar.splits(start_time=None, end_time=None)
204
289
  ```
205
290
 
206
291
  Summary: Splits
@@ -210,7 +295,6 @@ Summary: Splits
210
295
  | Endpoint ID | `equity.calendar.splits` |
211
296
  | HTTP | `GET` |
212
297
  | Path | `/inner/v1/agent-data/equity/calendar/splits` |
213
- | Default provider | `fmp` |
214
298
  | SDK | `supported` |
215
299
  | Host | `supported` |
216
300
  | Notes | - |
@@ -221,14 +305,22 @@ Summary: Splits
221
305
  |---|---|---|---|---|
222
306
  | `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
307
  | `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` | - |
308
+
309
+ #### Response fields
310
+
311
+ | Field | Type | Notes |
312
+ |---|---|---|
313
+ | `date` | `string` | The date of the data. |
314
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
315
+ | `numerator` | `number` | Numerator of the stock split. |
316
+ | `denominator` | `number` | Denominator of the stock split. |
225
317
 
226
318
  ---
227
319
 
228
320
  ### `equity.compare.company_facts`
229
321
 
230
322
  ```python
231
- data.equity.compare.company_facts(symbol=None, fact='', year=None, fiscal_period=None, instantaneous=False, use_cache=True, provider='sec')
323
+ data.equity.compare.company_facts(symbol=None, fact='', year=None, fiscal_period=None, instantaneous=False, use_cache=True)
232
324
  ```
233
325
 
234
326
  Summary: Company Facts
@@ -238,7 +330,6 @@ Summary: Company Facts
238
330
  | Endpoint ID | `equity.compare.company_facts` |
239
331
  | HTTP | `GET` |
240
332
  | Path | `/inner/v1/agent-data/equity/compare/company_facts` |
241
- | Default provider | `sec` |
242
333
  | SDK | `supported` |
243
334
  | Host | `supported` |
244
335
  | Notes | - |
@@ -247,20 +338,39 @@ Summary: Company Facts
247
338
 
248
339
  | Param | Required | Type | Default | Notes |
249
340
  |---|---|---|---|---|
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` | - |
341
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
342
+ | `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'. |
343
+ | `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. |
344
+ | `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. |
345
+ | `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. |
346
+ | `use_cache` | `no` | `boolean` | `true` | Whether to use cache for the request. Defaults to True. |
347
+
348
+ #### Response fields
349
+
350
+ | Field | Type | Notes |
351
+ |---|---|---|
352
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
353
+ | `name` | `string` | Name of the entity. |
354
+ | `value` | `number` | The reported value of the fact or concept. |
355
+ | `reported_date` | `string` | The date when the report was filed. |
356
+ | `period_beginning` | `string` | The start date of the reporting period. |
357
+ | `period_ending` | `string` | The end date of the reporting period. |
358
+ | `fiscal_year` | `integer` | The fiscal year. |
359
+ | `fiscal_period` | `string` | The fiscal period of the fiscal year. |
360
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
361
+ | `location` | `string` | Geographic location of the reporting entity. |
362
+ | `form` | `string` | The SEC form associated with the fact or concept. |
363
+ | `frame` | `string` | The frame ID associated with the fact or concept, if applicable. |
364
+ | `accession` | `string` | SEC filing accession number associated with the reported fact or concept. |
365
+ | `fact` | `string` | The display name of the fact or concept. |
366
+ | `unit` | `string` | The unit of measurement for the fact or concept. |
257
367
 
258
368
  ---
259
369
 
260
370
  ### `equity.compare.groups`
261
371
 
262
372
  ```python
263
- data.equity.compare.groups(group='sector', metric='performance', provider='finviz')
373
+ data.equity.compare.groups(group='sector', metric='performance')
264
374
  ```
265
375
 
266
376
  Summary: Groups
@@ -270,7 +380,6 @@ Summary: Groups
270
380
  | Endpoint ID | `equity.compare.groups` |
271
381
  | HTTP | `GET` |
272
382
  | Path | `/inner/v1/agent-data/equity/compare/groups` |
273
- | Default provider | `finviz` |
274
383
  | SDK | `supported` |
275
384
  | Host | `supported` |
276
385
  | Notes | - |
@@ -279,16 +388,42 @@ Summary: Groups
279
388
 
280
389
  | Param | Required | Type | Default | Notes |
281
390
  |---|---|---|---|---|
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` | - |
391
+ | `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'. |
392
+ | `metric` | `no` | `string` | `performance` | enum: performance, valuation, overview Statistical metric to return. Select from: ['performance', 'valuation', 'overview'] The default is 'performance'. |
393
+
394
+ #### Response fields
395
+
396
+ | Field | Type | Notes |
397
+ |---|---|---|
398
+ | `name` | `string` | Name or label of the group. |
399
+ | `stocks` | `integer` | The number of stocks in the group. |
400
+ | `market_cap` | `integer` | The market cap of the group. |
401
+ | `performance_1d` | `number` | The performance in the last day, as a normalized percent. |
402
+ | `performance_1w` | `number` | The performance in the last week, as a normalized percent. |
403
+ | `performance_1m` | `number` | The performance in the last month, as a normalized percent. |
404
+ | `performance_3m` | `number` | The performance in the last quarter, as a normalized percent. |
405
+ | `performance_6m` | `number` | The performance in the last half year, as a normalized percent. |
406
+ | `performance_1y` | `number` | The performance in the last year, as a normalized percent. |
407
+ | `performance_ytd` | `number` | The performance in the year to date, as a normalized percent. |
408
+ | `dividend_yield` | `number` | The dividend yield of the group, as a normalized percent. |
409
+ | `pe` | `number` | The P/E ratio of the group. |
410
+ | `forward_pe` | `number` | The forward P/E ratio of the group. |
411
+ | `peg` | `number` | The PEG ratio of the group. |
412
+ | `eps_growth_past_5y` | `number` | The EPS growth of the group for the past 5 years, as a normalized percent. |
413
+ | `eps_growth_next_5y` | `number` | The estimated EPS growth of the group for the next 5 years, as a normalized percent. |
414
+ | `sales_growth_past_5y` | `number` | The sales growth of the group for the past 5 years, as a normalized percent. |
415
+ | `float_short` | `number` | The percent of the float shorted for the group, as a normalized value. |
416
+ | `analyst_recommendation` | `number` | The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. |
417
+ | `volume` | `integer` | The trading volume. |
418
+ | `volume_average` | `integer` | The 3-month average volume of the group. |
419
+ | `volume_relative` | `number` | The relative volume compared to the 3-month average volume. |
285
420
 
286
421
  ---
287
422
 
288
423
  ### `equity.compare.peers`
289
424
 
290
425
  ```python
291
- data.equity.compare.peers(symbol=..., provider='fmp')
426
+ data.equity.compare.peers(symbol=...)
292
427
  ```
293
428
 
294
429
  Summary: Peers
@@ -298,7 +433,6 @@ Summary: Peers
298
433
  | Endpoint ID | `equity.compare.peers` |
299
434
  | HTTP | `GET` |
300
435
  | Path | `/inner/v1/agent-data/equity/compare/peers` |
301
- | Default provider | `fmp` |
302
436
  | SDK | `supported` |
303
437
  | Host | `supported` |
304
438
  | Notes | - |
@@ -308,14 +442,22 @@ Summary: Peers
308
442
  | Param | Required | Type | Default | Notes |
309
443
  |---|---|---|---|---|
310
444
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
311
- | `provider` | `no` | `string` | `fmp` | - |
445
+
446
+ #### Response fields
447
+
448
+ | Field | Type | Notes |
449
+ |---|---|---|
450
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
451
+ | `name` | `string` | The name of the company. |
452
+ | `price` | `number` | The current stock price of the company. |
453
+ | `market_cap` | `integer` | The market capitalization of the company. |
312
454
 
313
455
  ---
314
456
 
315
457
  ### `equity.darkpool.otc`
316
458
 
317
459
  ```python
318
- data.equity.darkpool.otc(symbol=None, tier='T1', is_ats=True, provider='finra')
460
+ data.equity.darkpool.otc(symbol=None, tier='T1', is_ats=True)
319
461
  ```
320
462
 
321
463
  Summary: Otc
@@ -325,7 +467,6 @@ Summary: Otc
325
467
  | Endpoint ID | `equity.darkpool.otc` |
326
468
  | HTTP | `GET` |
327
469
  | Path | `/inner/v1/agent-data/equity/darkpool/otc` |
328
- | Default provider | `finra` |
329
470
  | SDK | `supported` |
330
471
  | Host | `supported` |
331
472
  | Notes | - |
@@ -335,16 +476,23 @@ Summary: Otc
335
476
  | Param | Required | Type | Default | Notes |
336
477
  |---|---|---|---|---|
337
478
  | `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` | - |
479
+ | `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 |
480
+ | `is_ats` | `no` | `boolean` | `true` | ATS data if true, NON-ATS otherwise |
481
+
482
+ #### Response fields
483
+
484
+ | Field | Type | Notes |
485
+ |---|---|---|
486
+ | `update_date` | `string` | Most recent date on which total trades is updated based on data received from each ATS/OTC. |
487
+ | `share_quantity` | `number` | Aggregate weekly total number of shares reported by each ATS for the Symbol. |
488
+ | `trade_quantity` | `number` | Aggregate weekly total number of trades reported by each ATS for the Symbol. |
341
489
 
342
490
  ---
343
491
 
344
492
  ### `equity.discovery.active`
345
493
 
346
494
  ```python
347
- data.equity.discovery.active(sort='desc', limit=200, provider=...)
495
+ data.equity.discovery.active(sort='desc', limit=200)
348
496
  ```
349
497
 
350
498
  Summary: Active
@@ -354,7 +502,6 @@ Summary: Active
354
502
  | Endpoint ID | `equity.discovery.active` |
355
503
  | HTTP | `GET` |
356
504
  | Path | `/inner/v1/agent-data/equity/discovery/active` |
357
- | Default provider | - |
358
505
  | SDK | `supported` |
359
506
  | Host | `supported` |
360
507
  | Notes | - |
@@ -364,15 +511,45 @@ Summary: Active
364
511
  | Param | Required | Type | Default | Notes |
365
512
  |---|---|---|---|---|
366
513
  | `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 |
514
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
515
+
516
+ #### Response fields
517
+
518
+ | Field | Type | Notes |
519
+ |---|---|---|
520
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
521
+ | `name` | `string` | Name of the entity. |
522
+ | `price` | `number` | Last price. |
523
+ | `change` | `number` | Change in price. |
524
+ | `percent_change` | `number` | Percent change. |
525
+ | `volume` | `integer` | The trading volume. |
526
+ | `open` | `number` | Open price for the day. |
527
+ | `high` | `number` | High price for the day. |
528
+ | `low` | `number` | Low price for the day. |
529
+ | `previous_close` | `number` | Previous close price. |
530
+ | `ma_50` | `number` | 50-day moving average. |
531
+ | `ma_200` | `number` | 200-day moving average. |
532
+ | `year_high` | `number` | 52-week high. |
533
+ | `year_low` | `number` | 52-week low. |
534
+ | `market_cap` | `number` | Market Cap. |
535
+ | `shares_outstanding` | `number` | Shares outstanding. |
536
+ | `book_value` | `number` | Book value per share. |
537
+ | `price_to_book` | `number` | Price to book ratio. |
538
+ | `eps_ttm` | `number` | Earnings per share over the trailing twelve months. |
539
+ | `eps_forward` | `number` | Forward earnings per share. |
540
+ | `pe_forward` | `number` | Forward price-to-earnings ratio. |
541
+ | `dividend_yield` | `number` | Trailing twelve month dividend yield. |
542
+ | `exchange` | `string` | Exchange where the stock is listed. |
543
+ | `exchange_timezone` | `string` | Timezone of the exchange. |
544
+ | `earnings_date` | `string` | Most recent earnings date. |
545
+ | `currency` | `string` | Currency of the price data. |
369
546
 
370
547
  ---
371
548
 
372
549
  ### `equity.discovery.aggressive_small_caps`
373
550
 
374
551
  ```python
375
- data.equity.discovery.aggressive_small_caps(sort='desc', limit=None, provider='yfinance')
552
+ data.equity.discovery.aggressive_small_caps(sort='desc', limit=None)
376
553
  ```
377
554
 
378
555
  Summary: Aggressive Small Caps
@@ -382,7 +559,6 @@ Summary: Aggressive Small Caps
382
559
  | Endpoint ID | `equity.discovery.aggressive_small_caps` |
383
560
  | HTTP | `GET` |
384
561
  | Path | `/inner/v1/agent-data/equity/discovery/aggressive_small_caps` |
385
- | Default provider | `yfinance` |
386
562
  | SDK | `supported` |
387
563
  | Host | `supported` |
388
564
  | Notes | - |
@@ -392,15 +568,45 @@ Summary: Aggressive Small Caps
392
568
  | Param | Required | Type | Default | Notes |
393
569
  |---|---|---|---|---|
394
570
  | `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` | - |
571
+ | `limit` | `no` | `integer | null` | `-` | Limit the number of results. Default is all. |
572
+
573
+ #### Response fields
574
+
575
+ | Field | Type | Notes |
576
+ |---|---|---|
577
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
578
+ | `name` | `string` | Name of the entity. |
579
+ | `price` | `number` | Last price. |
580
+ | `change` | `number` | Change in price. |
581
+ | `percent_change` | `number` | Percent change. |
582
+ | `volume` | `integer` | The trading volume. |
583
+ | `open` | `number` | Open price for the day. |
584
+ | `high` | `number` | High price for the day. |
585
+ | `low` | `number` | Low price for the day. |
586
+ | `previous_close` | `number` | Previous close price. |
587
+ | `ma_50` | `number` | 50-day moving average. |
588
+ | `ma_200` | `number` | 200-day moving average. |
589
+ | `year_high` | `number` | 52-week high. |
590
+ | `year_low` | `number` | 52-week low. |
591
+ | `market_cap` | `number` | Market Cap. |
592
+ | `shares_outstanding` | `number` | Shares outstanding. |
593
+ | `book_value` | `number` | Book value per share. |
594
+ | `price_to_book` | `number` | Price to book ratio. |
595
+ | `eps_ttm` | `number` | Earnings per share over the trailing twelve months. |
596
+ | `eps_forward` | `number` | Forward earnings per share. |
597
+ | `pe_forward` | `number` | Forward price-to-earnings ratio. |
598
+ | `dividend_yield` | `number` | Trailing twelve month dividend yield. |
599
+ | `exchange` | `string` | Exchange where the stock is listed. |
600
+ | `exchange_timezone` | `string` | Timezone of the exchange. |
601
+ | `earnings_date` | `string` | Most recent earnings date. |
602
+ | `currency` | `string` | Currency of the price data. |
397
603
 
398
604
  ---
399
605
 
400
606
  ### `equity.discovery.filings`
401
607
 
402
608
  ```python
403
- data.equity.discovery.filings(start_time=None, end_time=None, form_type=None, limit=None, provider='fmp')
609
+ data.equity.discovery.filings(start_time=None, end_time=None, form_type=None, limit=None)
404
610
  ```
405
611
 
406
612
  Summary: Filings
@@ -410,7 +616,6 @@ Summary: Filings
410
616
  | Endpoint ID | `equity.discovery.filings` |
411
617
  | HTTP | `GET` |
412
618
  | Path | `/inner/v1/agent-data/equity/discovery/filings` |
413
- | Default provider | `fmp` |
414
619
  | SDK | `supported` |
415
620
  | Host | `supported` |
416
621
  | Notes | - |
@@ -422,15 +627,26 @@ Summary: Filings
422
627
  | `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
628
  | `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
629
  | `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` | - |
630
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; The maximum number of results to return. Default is 10000. |
631
+
632
+ #### Response fields
633
+
634
+ | Field | Type | Notes |
635
+ |---|---|---|
636
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
637
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
638
+ | `filing_date` | `string` | The date of the data. |
639
+ | `accepted_date` | `string` | accepted_date |
640
+ | `form_type` | `string` | The form type of the filing. |
641
+ | `link` | `string` | URL to the filing page on the SEC site. |
642
+ | `final_link` | `string` | Direct URL to the main document of the filing. |
427
643
 
428
644
  ---
429
645
 
430
646
  ### `equity.discovery.gainers`
431
647
 
432
648
  ```python
433
- data.equity.discovery.gainers(sort='desc', category='price_performer', limit=200, provider=...)
649
+ data.equity.discovery.gainers(sort='desc', category='price_performer', limit=200)
434
650
  ```
435
651
 
436
652
  Summary: Gainers
@@ -440,7 +656,6 @@ Summary: Gainers
440
656
  | Endpoint ID | `equity.discovery.gainers` |
441
657
  | HTTP | `GET` |
442
658
  | Path | `/inner/v1/agent-data/equity/discovery/gainers` |
443
- | Default provider | - |
444
659
  | SDK | `supported` |
445
660
  | Host | `supported` |
446
661
  | Notes | - |
@@ -450,16 +665,50 @@ Summary: Gainers
450
665
  | Param | Required | Type | Default | Notes |
451
666
  |---|---|---|---|---|
452
667
  | `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 |
668
+ | `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`. |
669
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
670
+
671
+ #### Response fields
672
+
673
+ | Field | Type | Notes |
674
+ |---|---|---|
675
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
676
+ | `name` | `string` | Name of the entity. |
677
+ | `price` | `number` | Last price. |
678
+ | `change` | `number` | Change in price. |
679
+ | `percent_change` | `number` | Percent change. |
680
+ | `volume` | `integer` | The trading volume. |
681
+ | `open` | `number` | Open price for the day. |
682
+ | `high` | `number` | High price for the day. |
683
+ | `low` | `number` | Low price for the day. |
684
+ | `previous_close` | `number` | Previous close price. |
685
+ | `ma_50` | `number` | 50-day moving average. |
686
+ | `ma_200` | `number` | 200-day moving average. |
687
+ | `year_high` | `number` | 52-week high. |
688
+ | `year_low` | `number` | 52-week low. |
689
+ | `market_cap` | `number` | Market Cap. |
690
+ | `shares_outstanding` | `number` | Shares outstanding. |
691
+ | `book_value` | `number` | Book value per share. |
692
+ | `price_to_book` | `number` | Price to book ratio. |
693
+ | `eps_ttm` | `number` | Earnings per share over the trailing twelve months. |
694
+ | `eps_forward` | `number` | Forward earnings per share. |
695
+ | `pe_forward` | `number` | Forward price-to-earnings ratio. |
696
+ | `dividend_yield` | `number` | Trailing twelve month dividend yield. |
697
+ | `exchange` | `string` | Exchange where the stock is listed. |
698
+ | `exchange_timezone` | `string` | Timezone of the exchange. |
699
+ | `earnings_date` | `string` | Most recent earnings date. |
700
+ | `currency` | `string` | Currency of the price data. |
701
+ | `thirty_day_price_change` | `number` | 30 Day Price Change. |
702
+ | `ninety_day_price_change` | `number` | 90 Day Price Change. |
703
+ | `avg_volume_10d` | `number` | 10 Day Avg. Volume. |
704
+ | `rank` | `integer` | The rank of the stock in the list. |
456
705
 
457
706
  ---
458
707
 
459
708
  ### `equity.discovery.growth_tech`
460
709
 
461
710
  ```python
462
- data.equity.discovery.growth_tech(sort='desc', limit=200, provider='yfinance')
711
+ data.equity.discovery.growth_tech(sort='desc', limit=200)
463
712
  ```
464
713
 
465
714
  Summary: Growth Tech
@@ -469,7 +718,6 @@ Summary: Growth Tech
469
718
  | Endpoint ID | `equity.discovery.growth_tech` |
470
719
  | HTTP | `GET` |
471
720
  | Path | `/inner/v1/agent-data/equity/discovery/growth_tech` |
472
- | Default provider | `yfinance` |
473
721
  | SDK | `supported` |
474
722
  | Host | `supported` |
475
723
  | Notes | - |
@@ -479,15 +727,45 @@ Summary: Growth Tech
479
727
  | Param | Required | Type | Default | Notes |
480
728
  |---|---|---|---|---|
481
729
  | `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` | - |
730
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
731
+
732
+ #### Response fields
733
+
734
+ | Field | Type | Notes |
735
+ |---|---|---|
736
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
737
+ | `name` | `string` | Name of the entity. |
738
+ | `price` | `number` | Last price. |
739
+ | `change` | `number` | Change in price. |
740
+ | `percent_change` | `number` | Percent change. |
741
+ | `volume` | `integer` | The trading volume. |
742
+ | `open` | `number` | Open price for the day. |
743
+ | `high` | `number` | High price for the day. |
744
+ | `low` | `number` | Low price for the day. |
745
+ | `previous_close` | `number` | Previous close price. |
746
+ | `ma_50` | `number` | 50-day moving average. |
747
+ | `ma_200` | `number` | 200-day moving average. |
748
+ | `year_high` | `number` | 52-week high. |
749
+ | `year_low` | `number` | 52-week low. |
750
+ | `market_cap` | `number` | Market Cap. |
751
+ | `shares_outstanding` | `number` | Shares outstanding. |
752
+ | `book_value` | `number` | Book value per share. |
753
+ | `price_to_book` | `number` | Price to book ratio. |
754
+ | `eps_ttm` | `number` | Earnings per share over the trailing twelve months. |
755
+ | `eps_forward` | `number` | Forward earnings per share. |
756
+ | `pe_forward` | `number` | Forward price-to-earnings ratio. |
757
+ | `dividend_yield` | `number` | Trailing twelve month dividend yield. |
758
+ | `exchange` | `string` | Exchange where the stock is listed. |
759
+ | `exchange_timezone` | `string` | Timezone of the exchange. |
760
+ | `earnings_date` | `string` | Most recent earnings date. |
761
+ | `currency` | `string` | Currency of the price data. |
484
762
 
485
763
  ---
486
764
 
487
765
  ### `equity.discovery.latest_financial_reports`
488
766
 
489
767
  ```python
490
- data.equity.discovery.latest_financial_reports(date=None, report_type=None, provider='sec')
768
+ data.equity.discovery.latest_financial_reports(date=None, report_type=None)
491
769
  ```
492
770
 
493
771
  Summary: Latest Financial Reports
@@ -497,7 +775,6 @@ Summary: Latest Financial Reports
497
775
  | Endpoint ID | `equity.discovery.latest_financial_reports` |
498
776
  | HTTP | `GET` |
499
777
  | Path | `/inner/v1/agent-data/equity/discovery/latest_financial_reports` |
500
- | Default provider | `sec` |
501
778
  | SDK | `supported` |
502
779
  | Host | `supported` |
503
780
  | Notes | - |
@@ -506,16 +783,34 @@ Summary: Latest Financial Reports
506
783
 
507
784
  | Param | Required | Type | Default | Notes |
508
785
  |---|---|---|---|---|
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` | - |
786
+ | `date` | `no` | `string | null` | `-` | A specific date to get data for. Defaults to today. |
787
+ | `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. |
788
+
789
+ #### Response fields
790
+
791
+ | Field | Type | Notes |
792
+ |---|---|---|
793
+ | `filing_date` | `string` | The date of the filing. |
794
+ | `period_ending` | `string` | Report for the period ending. |
795
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
796
+ | `name` | `string` | Name of the company. |
797
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
798
+ | `sic` | `string` | Standard Industrial Classification code. |
799
+ | `report_type` | `string` | Type of filing. |
800
+ | `description` | `string` | Description of the report. |
801
+ | `url` | `string` | URL to the filing page. |
802
+ | `items` | `string` | Item codes associated with the filing. |
803
+ | `index_headers` | `string` | URL to the index headers file. |
804
+ | `complete_submission` | `string` | URL to the complete submission text file. |
805
+ | `metadata` | `string` | URL to the MetaLinks.json file, if available. |
806
+ | `financial_report` | `string` | URL to the Financial_Report.xlsx file, if available. |
512
807
 
513
808
  ---
514
809
 
515
810
  ### `equity.discovery.losers`
516
811
 
517
812
  ```python
518
- data.equity.discovery.losers(sort='desc', limit=200, provider=...)
813
+ data.equity.discovery.losers(sort='desc', limit=200)
519
814
  ```
520
815
 
521
816
  Summary: Losers
@@ -525,7 +820,6 @@ Summary: Losers
525
820
  | Endpoint ID | `equity.discovery.losers` |
526
821
  | HTTP | `GET` |
527
822
  | Path | `/inner/v1/agent-data/equity/discovery/losers` |
528
- | Default provider | - |
529
823
  | SDK | `supported` |
530
824
  | Host | `supported` |
531
825
  | Notes | - |
@@ -535,15 +829,45 @@ Summary: Losers
535
829
  | Param | Required | Type | Default | Notes |
536
830
  |---|---|---|---|---|
537
831
  | `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 |
832
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
833
+
834
+ #### Response fields
835
+
836
+ | Field | Type | Notes |
837
+ |---|---|---|
838
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
839
+ | `name` | `string` | Name of the entity. |
840
+ | `price` | `number` | Last price. |
841
+ | `change` | `number` | Change in price. |
842
+ | `percent_change` | `number` | Percent change. |
843
+ | `volume` | `integer` | The trading volume. |
844
+ | `exchange` | `string` | Stock exchange where the security is listed. |
845
+ | `open` | `number` | Open price for the day. |
846
+ | `high` | `number` | High price for the day. |
847
+ | `low` | `number` | Low price for the day. |
848
+ | `previous_close` | `number` | Previous close price. |
849
+ | `ma_50` | `number` | 50-day moving average. |
850
+ | `ma_200` | `number` | 200-day moving average. |
851
+ | `year_high` | `number` | 52-week high. |
852
+ | `year_low` | `number` | 52-week low. |
853
+ | `market_cap` | `number` | Market Cap. |
854
+ | `shares_outstanding` | `number` | Shares outstanding. |
855
+ | `book_value` | `number` | Book value per share. |
856
+ | `price_to_book` | `number` | Price to book ratio. |
857
+ | `eps_ttm` | `number` | Earnings per share over the trailing twelve months. |
858
+ | `eps_forward` | `number` | Forward earnings per share. |
859
+ | `pe_forward` | `number` | Forward price-to-earnings ratio. |
860
+ | `dividend_yield` | `number` | Trailing twelve month dividend yield. |
861
+ | `exchange_timezone` | `string` | Timezone of the exchange. |
862
+ | `earnings_date` | `string` | Most recent earnings date. |
863
+ | `currency` | `string` | Currency of the price data. |
540
864
 
541
865
  ---
542
866
 
543
867
  ### `equity.discovery.top_retail`
544
868
 
545
869
  ```python
546
- data.equity.discovery.top_retail(limit=5, provider='nasdaq')
870
+ data.equity.discovery.top_retail(limit=5)
547
871
  ```
548
872
 
549
873
  Summary: Top Retail
@@ -553,7 +877,6 @@ Summary: Top Retail
553
877
  | Endpoint ID | `equity.discovery.top_retail` |
554
878
  | HTTP | `GET` |
555
879
  | Path | `/inner/v1/agent-data/equity/discovery/top_retail` |
556
- | Default provider | `nasdaq` |
557
880
  | SDK | `supported` |
558
881
  | Host | `supported` |
559
882
  | Notes | - |
@@ -563,14 +886,22 @@ Summary: Top Retail
563
886
  | Param | Required | Type | Default | Notes |
564
887
  |---|---|---|---|---|
565
888
  | `limit` | `no` | `integer` | `5` | The number of data entries to return. |
566
- | `provider` | `no` | `string` | `nasdaq` | - |
889
+
890
+ #### Response fields
891
+
892
+ | Field | Type | Notes |
893
+ |---|---|---|
894
+ | `date` | `string` | The date of the data. |
895
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
896
+ | `activity` | `number` | Activity of the symbol. |
897
+ | `sentiment` | `number` | Sentiment of the symbol. 1 is bullish, -1 is bearish. |
567
898
 
568
899
  ---
569
900
 
570
901
  ### `equity.discovery.undervalued_growth`
571
902
 
572
903
  ```python
573
- data.equity.discovery.undervalued_growth(sort='desc', limit=200, provider='yfinance')
904
+ data.equity.discovery.undervalued_growth(sort='desc', limit=200)
574
905
  ```
575
906
 
576
907
  Summary: Undervalued Growth
@@ -580,7 +911,6 @@ Summary: Undervalued Growth
580
911
  | Endpoint ID | `equity.discovery.undervalued_growth` |
581
912
  | HTTP | `GET` |
582
913
  | Path | `/inner/v1/agent-data/equity/discovery/undervalued_growth` |
583
- | Default provider | `yfinance` |
584
914
  | SDK | `supported` |
585
915
  | Host | `supported` |
586
916
  | Notes | - |
@@ -590,15 +920,45 @@ Summary: Undervalued Growth
590
920
  | Param | Required | Type | Default | Notes |
591
921
  |---|---|---|---|---|
592
922
  | `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` | - |
923
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
924
+
925
+ #### Response fields
926
+
927
+ | Field | Type | Notes |
928
+ |---|---|---|
929
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
930
+ | `name` | `string` | Name of the entity. |
931
+ | `price` | `number` | Last price. |
932
+ | `change` | `number` | Change in price. |
933
+ | `percent_change` | `number` | Percent change. |
934
+ | `volume` | `integer` | The trading volume. |
935
+ | `open` | `number` | Open price for the day. |
936
+ | `high` | `number` | High price for the day. |
937
+ | `low` | `number` | Low price for the day. |
938
+ | `previous_close` | `number` | Previous close price. |
939
+ | `ma_50` | `number` | 50-day moving average. |
940
+ | `ma_200` | `number` | 200-day moving average. |
941
+ | `year_high` | `number` | 52-week high. |
942
+ | `year_low` | `number` | 52-week low. |
943
+ | `market_cap` | `number` | Market Cap. |
944
+ | `shares_outstanding` | `number` | Shares outstanding. |
945
+ | `book_value` | `number` | Book value per share. |
946
+ | `price_to_book` | `number` | Price to book ratio. |
947
+ | `eps_ttm` | `number` | Earnings per share over the trailing twelve months. |
948
+ | `eps_forward` | `number` | Forward earnings per share. |
949
+ | `pe_forward` | `number` | Forward price-to-earnings ratio. |
950
+ | `dividend_yield` | `number` | Trailing twelve month dividend yield. |
951
+ | `exchange` | `string` | Exchange where the stock is listed. |
952
+ | `exchange_timezone` | `string` | Timezone of the exchange. |
953
+ | `earnings_date` | `string` | Most recent earnings date. |
954
+ | `currency` | `string` | Currency of the price data. |
595
955
 
596
956
  ---
597
957
 
598
958
  ### `equity.discovery.undervalued_large_caps`
599
959
 
600
960
  ```python
601
- data.equity.discovery.undervalued_large_caps(sort='desc', limit=200, provider='yfinance')
961
+ data.equity.discovery.undervalued_large_caps(sort='desc', limit=200)
602
962
  ```
603
963
 
604
964
  Summary: Undervalued Large Caps
@@ -608,7 +968,6 @@ Summary: Undervalued Large Caps
608
968
  | Endpoint ID | `equity.discovery.undervalued_large_caps` |
609
969
  | HTTP | `GET` |
610
970
  | Path | `/inner/v1/agent-data/equity/discovery/undervalued_large_caps` |
611
- | Default provider | `yfinance` |
612
971
  | SDK | `supported` |
613
972
  | Host | `supported` |
614
973
  | Notes | - |
@@ -618,15 +977,45 @@ Summary: Undervalued Large Caps
618
977
  | Param | Required | Type | Default | Notes |
619
978
  |---|---|---|---|---|
620
979
  | `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` | - |
980
+ | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
981
+
982
+ #### Response fields
983
+
984
+ | Field | Type | Notes |
985
+ |---|---|---|
986
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
987
+ | `name` | `string` | Name of the entity. |
988
+ | `price` | `number` | Last price. |
989
+ | `change` | `number` | Change in price. |
990
+ | `percent_change` | `number` | Percent change. |
991
+ | `volume` | `integer` | The trading volume. |
992
+ | `open` | `number` | Open price for the day. |
993
+ | `high` | `number` | High price for the day. |
994
+ | `low` | `number` | Low price for the day. |
995
+ | `previous_close` | `number` | Previous close price. |
996
+ | `ma_50` | `number` | 50-day moving average. |
997
+ | `ma_200` | `number` | 200-day moving average. |
998
+ | `year_high` | `number` | 52-week high. |
999
+ | `year_low` | `number` | 52-week low. |
1000
+ | `market_cap` | `number` | Market Cap. |
1001
+ | `shares_outstanding` | `number` | Shares outstanding. |
1002
+ | `book_value` | `number` | Book value per share. |
1003
+ | `price_to_book` | `number` | Price to book ratio. |
1004
+ | `eps_ttm` | `number` | Earnings per share over the trailing twelve months. |
1005
+ | `eps_forward` | `number` | Forward earnings per share. |
1006
+ | `pe_forward` | `number` | Forward price-to-earnings ratio. |
1007
+ | `dividend_yield` | `number` | Trailing twelve month dividend yield. |
1008
+ | `exchange` | `string` | Exchange where the stock is listed. |
1009
+ | `exchange_timezone` | `string` | Timezone of the exchange. |
1010
+ | `earnings_date` | `string` | Most recent earnings date. |
1011
+ | `currency` | `string` | Currency of the price data. |
623
1012
 
624
1013
  ---
625
1014
 
626
1015
  ### `equity.estimates.analyst_search`
627
1016
 
628
1017
  ```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')
1018
+ data.equity.estimates.analyst_search(analyst_name=None, firm_name=None, analyst_ids=None, firm_ids=None, limit=100, page=0, fields=None)
630
1019
  ```
631
1020
 
632
1021
  Summary: Analyst Search
@@ -636,7 +1025,6 @@ Summary: Analyst Search
636
1025
  | Endpoint ID | `equity.estimates.analyst_search` |
637
1026
  | HTTP | `GET` |
638
1027
  | Path | `/inner/v1/agent-data/equity/estimates/analyst_search` |
639
- | Default provider | `benzinga` |
640
1028
  | SDK | `supported` |
641
1029
  | Host | `supported` |
642
1030
  | Notes | - |
@@ -645,21 +1033,81 @@ Summary: Analyst Search
645
1033
 
646
1034
  | Param | Required | Type | Default | Notes |
647
1035
  |---|---|---|---|---|
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` | - |
1036
+ | `analyst_name` | `no` | `string | null` | `-` | Analyst names to return. Omitting will return all available analysts. Multiple comma separated items allowed |
1037
+ | `firm_name` | `no` | `string | null` | `-` | Firm names to return. Omitting will return all available firms. Multiple comma separated items allowed |
1038
+ | `analyst_ids` | `no` | `string | null` | `-` | List of analyst IDs to return. Multiple comma separated items allowed. |
1039
+ | `firm_ids` | `no` | `string | null` | `-` | Firm IDs to return. Multiple comma separated items allowed. |
1040
+ | `limit` | `no` | `integer | null` | `100` | Number of results returned. Limit 1000. |
1041
+ | `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. |
1042
+ | `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. |
1043
+
1044
+ #### Response fields
1045
+
1046
+ | Field | Type | Notes |
1047
+ |---|---|---|
1048
+ | `last_updated` | `string` | Date of the last update. |
1049
+ | `firm_name` | `string` | Firm name of the analyst. |
1050
+ | `name_first` | `string` | Analyst first name. |
1051
+ | `name_last` | `string` | Analyst last name. |
1052
+ | `name_full` | `string` | Analyst full name. |
1053
+ | `analyst_id` | `string` | ID of the analyst. |
1054
+ | `firm_id` | `string` | ID of the analyst firm. |
1055
+ | `smart_score` | `number` | A weighted average of the total_ratings_percentile, overall_avg_return_percentile, and overall_success_rate. |
1056
+ | `overall_success_rate` | `number` | The percentage (normalized) of gain/loss ratings that resulted in a gain overall. |
1057
+ | `overall_avg_return_percentile` | `number` | The percentile (normalized) of this analyst's overall average return per rating in comparison to other analysts. |
1058
+ | `total_ratings_percentile` | `number` | The percentile (normalized) of this analyst's total number of ratings in comparison to the total number published by all other analysts. |
1059
+ | `total_ratings` | `integer` | Number of recommendations made by this analyst. |
1060
+ | `overall_gain_count` | `integer` | The number of ratings that have gained value since the date of recommendation. |
1061
+ | `overall_loss_count` | `integer` | The number of ratings that have lost value since the date of recommendation. |
1062
+ | `overall_average_return` | `number` | The average percent (normalized) price difference per rating since the date of recommendation. |
1063
+ | `overall_std_dev` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings since the date of recommendation. |
1064
+ | `gain_count_1m` | `integer` | The number of ratings that have gained value over the last month. |
1065
+ | `loss_count_1m` | `integer` | The number of ratings that have lost value over the last month. |
1066
+ | `average_return_1m` | `number` | The average percent (normalized) price difference per rating over the last month. |
1067
+ | `std_dev_1m` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last month. |
1068
+ | `smart_score_1m` | `number` | A weighted average smart score over the last month. |
1069
+ | `success_rate_1m` | `number` | The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month. |
1070
+ | `gain_count_3m` | `integer` | The number of ratings that have gained value over the last 3 months. |
1071
+ | `loss_count_3m` | `integer` | The number of ratings that have lost value over the last 3 months. |
1072
+ | `average_return_3m` | `number` | The average percent (normalized) price difference per rating over the last 3 months. |
1073
+ | `std_dev_3m` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 months. |
1074
+ | `smart_score_3m` | `number` | A weighted average smart score over the last 3 months. |
1075
+ | `success_rate_3m` | `number` | The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months. |
1076
+ | `gain_count_6m` | `integer` | The number of ratings that have gained value over the last 6 months. |
1077
+ | `loss_count_6m` | `integer` | The number of ratings that have lost value over the last 6 months. |
1078
+ | `average_return_6m` | `number` | The average percent (normalized) price difference per rating over the last 6 months. |
1079
+ | `std_dev_6m` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 6 months. |
1080
+ | `gain_count_9m` | `integer` | The number of ratings that have gained value over the last 9 months. |
1081
+ | `loss_count_9m` | `integer` | The number of ratings that have lost value over the last 9 months. |
1082
+ | `average_return_9m` | `number` | The average percent (normalized) price difference per rating over the last 9 months. |
1083
+ | `std_dev_9m` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 9 months. |
1084
+ | `smart_score_9m` | `number` | A weighted average smart score over the last 9 months. |
1085
+ | `success_rate_9m` | `number` | The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months. |
1086
+ | `gain_count_1y` | `integer` | The number of ratings that have gained value over the last 1 year. |
1087
+ | `loss_count_1y` | `integer` | The number of ratings that have lost value over the last 1 year. |
1088
+ | `average_return_1y` | `number` | The average percent (normalized) price difference per rating over the last 1 year. |
1089
+ | `std_dev_1y` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 1 year. |
1090
+ | `smart_score_1y` | `number` | A weighted average smart score over the last 1 year. |
1091
+ | `success_rate_1y` | `number` | The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year. |
1092
+ | `gain_count_2y` | `integer` | The number of ratings that have gained value over the last 2 years. |
1093
+ | `loss_count_2y` | `integer` | The number of ratings that have lost value over the last 2 years. |
1094
+ | `average_return_2y` | `number` | The average percent (normalized) price difference per rating over the last 2 years. |
1095
+ | `std_dev_2y` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 2 years. |
1096
+ | `smart_score_2y` | `number` | A weighted average smart score over the last 2 years. |
1097
+ | `success_rate_2y` | `number` | The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years. |
1098
+ | `gain_count_3y` | `integer` | The number of ratings that have gained value over the last 3 years. |
1099
+ | `loss_count_3y` | `integer` | The number of ratings that have lost value over the last 3 years. |
1100
+ | `average_return_3y` | `number` | The average percent (normalized) price difference per rating over the last 3 years. |
1101
+ | `std_dev_3y` | `number` | The standard deviation in percent (normalized) price difference in the analyst's ratings over the last 3 years. |
1102
+ | `smart_score_3y` | `number` | A weighted average smart score over the last 3 years. |
1103
+ | `success_rate_3y` | `number` | The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years. |
656
1104
 
657
1105
  ---
658
1106
 
659
1107
  ### `equity.estimates.consensus`
660
1108
 
661
1109
  ```python
662
- data.equity.estimates.consensus(symbol=None, industry_group_number=None, provider=...)
1110
+ data.equity.estimates.consensus(symbol=None, industry_group_number=None)
663
1111
  ```
664
1112
 
665
1113
  Summary: Consensus
@@ -669,7 +1117,6 @@ Summary: Consensus
669
1117
  | Endpoint ID | `equity.estimates.consensus` |
670
1118
  | HTTP | `GET` |
671
1119
  | Path | `/inner/v1/agent-data/equity/estimates/consensus` |
672
- | Default provider | - |
673
1120
  | SDK | `supported` |
674
1121
  | Host | `supported` |
675
1122
  | Notes | - |
@@ -678,16 +1125,42 @@ Summary: Consensus
678
1125
 
679
1126
  | Param | Required | Type | Default | Notes |
680
1127
  |---|---|---|---|---|
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 |
1128
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1129
+ | `industry_group_number` | `no` | `integer | null` | `-` | The Zacks industry group number. |
1130
+
1131
+ #### Response fields
1132
+
1133
+ | Field | Type | Notes |
1134
+ |---|---|---|
1135
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1136
+ | `name` | `string` | The company name. |
1137
+ | `target_high` | `number` | High target of the price target consensus. |
1138
+ | `target_low` | `number` | Low target of the price target consensus. |
1139
+ | `target_consensus` | `number` | Consensus target of the price target consensus. |
1140
+ | `target_median` | `number` | Median target of the price target consensus. |
1141
+ | `recommendation` | `string` | Recommendation - buy, sell, etc. |
1142
+ | `recommendation_mean` | `number` | Mean recommendation score where 1 is strong buy and 5 is strong sell. |
1143
+ | `number_of_analysts` | `integer` | Number of analysts providing opinions. |
1144
+ | `current_price` | `number` | Current price of the stock. |
1145
+ | `currency` | `string` | Currency the stock is priced in. |
1146
+ | `target_upside` | `number` | Percent of upside, as a normalized percent. |
1147
+ | `total_analysts` | `integer` | Total number of analyst. |
1148
+ | `buy_ratings` | `integer` | Number of buy ratings. |
1149
+ | `sell_ratings` | `integer` | Number of sell ratings. |
1150
+ | `hold_ratings` | `integer` | Number of hold ratings. |
1151
+ | `consensus_action` | `string` | Consensus action. |
1152
+ | `standard_deviation` | `number` | The standard deviation of target price estimates. |
1153
+ | `raised` | `integer` | The number of analysts that have raised their target price estimates. |
1154
+ | `lowered` | `integer` | The number of analysts that have lowered their target price estimates. |
1155
+ | `most_recent_date` | `string` | The date of the most recent estimate. |
1156
+ | `industry_group_number` | `integer` | The Zacks industry group number. |
684
1157
 
685
1158
  ---
686
1159
 
687
1160
  ### `equity.estimates.forward_ebitda`
688
1161
 
689
1162
  ```python
690
- data.equity.estimates.forward_ebitda(symbol=None, fiscal_period='annual', limit=None, include_historical=False, estimate_type=None, provider=...)
1163
+ data.equity.estimates.forward_ebitda(symbol=None, fiscal_period='annual', limit=None, include_historical=False, estimate_type=None)
691
1164
  ```
692
1165
 
693
1166
  Summary: Forward Ebitda
@@ -697,7 +1170,6 @@ Summary: Forward Ebitda
697
1170
  | Endpoint ID | `equity.estimates.forward_ebitda` |
698
1171
  | HTTP | `GET` |
699
1172
  | Path | `/inner/v1/agent-data/equity/estimates/forward_ebitda` |
700
- | Default provider | - |
701
1173
  | SDK | `supported` |
702
1174
  | Host | `supported` |
703
1175
  | Notes | - |
@@ -706,19 +1178,38 @@ Summary: Forward Ebitda
706
1178
 
707
1179
  | Param | Required | Type | Default | Notes |
708
1180
  |---|---|---|---|---|
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 |
1181
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1182
+ | `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for.; Filter for only full-year or quarterly estimates. |
1183
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. |
1184
+ | `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. |
1185
+ | `estimate_type` | `no` | `string | null` | `-` | Limit the EBITDA estimates to this type. |
1186
+
1187
+ #### Response fields
1188
+
1189
+ | Field | Type | Notes |
1190
+ |---|---|---|
1191
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1192
+ | `name` | `string` | Name of the entity. |
1193
+ | `last_updated` | `string` | The date of the last update. |
1194
+ | `period_ending` | `string` | The end date of the reporting period. |
1195
+ | `fiscal_year` | `integer` | Fiscal year for the estimate. |
1196
+ | `fiscal_period` | `string` | Fiscal quarter for the estimate. |
1197
+ | `calendar_year` | `integer` | Calendar year for the estimate. |
1198
+ | `calendar_period` | `integer` | Calendar quarter for the estimate. |
1199
+ | `low_estimate` | `integer` | The EBITDA estimate low for the period. |
1200
+ | `high_estimate` | `integer` | The EBITDA estimate high for the period. |
1201
+ | `mean` | `integer` | The EBITDA estimate mean for the period. |
1202
+ | `median` | `integer` | The EBITDA estimate median for the period. |
1203
+ | `standard_deviation` | `integer` | The EBITDA estimate standard deviation for the period. |
1204
+ | `number_of_analysts` | `integer` | Number of analysts providing estimates for the period. |
1205
+ | `conensus_type` | `string` | The type of estimate. |
715
1206
 
716
1207
  ---
717
1208
 
718
1209
  ### `equity.estimates.forward_eps`
719
1210
 
720
1211
  ```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=...)
1212
+ 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
1213
  ```
723
1214
 
724
1215
  Summary: Forward Eps
@@ -728,7 +1219,6 @@ Summary: Forward Eps
728
1219
  | Endpoint ID | `equity.estimates.forward_eps` |
729
1220
  | HTTP | `GET` |
730
1221
  | Path | `/inner/v1/agent-data/equity/estimates/forward_eps` |
731
- | Default provider | - |
732
1222
  | SDK | `supported` |
733
1223
  | Host | `supported` |
734
1224
  | Notes | - |
@@ -737,21 +1227,43 @@ Summary: Forward Eps
737
1227
 
738
1228
  | Param | Required | Type | Default | Notes |
739
1229
  |---|---|---|---|---|
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 |
1230
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1231
+ | `fiscal_period` | `no` | `string | null` | `annual` | The future fiscal period to retrieve estimates for. |
1232
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. Number of historical periods. |
1233
+ | `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. |
1234
+ | `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. |
1235
+ | `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. |
1236
+ | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. |
1237
+
1238
+ #### Response fields
1239
+
1240
+ | Field | Type | Notes |
1241
+ |---|---|---|
1242
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1243
+ | `name` | `string` | Name of the entity. |
1244
+ | `date` | `string` | The date of the data. |
1245
+ | `fiscal_year` | `integer` | Fiscal year for the estimate. |
1246
+ | `fiscal_period` | `string` | Fiscal quarter for the estimate. |
1247
+ | `calendar_year` | `integer` | Calendar year for the estimate. |
1248
+ | `calendar_period` | `string` | Calendar quarter for the estimate. |
1249
+ | `low_estimate` | `number` | Estimated EPS low for the period. |
1250
+ | `high_estimate` | `number` | Estimated EPS high for the period. |
1251
+ | `mean` | `number` | Estimated EPS mean for the period. |
1252
+ | `median` | `number` | Estimated EPS median for the period. |
1253
+ | `standard_deviation` | `number` | Estimated EPS standard deviation for the period. |
1254
+ | `number_of_analysts` | `integer` | Number of analysts providing estimates for the period. |
1255
+ | `revisions_change_percent` | `number` | The earnings per share (EPS) percent change in estimate for the period. |
1256
+ | `mean_1w` | `number` | The mean estimate for the period one week ago. |
1257
+ | `mean_1m` | `number` | The mean estimate for the period one month ago. |
1258
+ | `mean_2m` | `number` | The mean estimate for the period two months ago. |
1259
+ | `mean_3m` | `number` | The mean estimate for the period three months ago. |
748
1260
 
749
1261
  ---
750
1262
 
751
1263
  ### `equity.estimates.forward_pe`
752
1264
 
753
1265
  ```python
754
- data.equity.estimates.forward_pe(symbol=None, provider='intrinio')
1266
+ data.equity.estimates.forward_pe(symbol=None)
755
1267
  ```
756
1268
 
757
1269
  Summary: Forward Pe
@@ -761,7 +1273,6 @@ Summary: Forward Pe
761
1273
  | Endpoint ID | `equity.estimates.forward_pe` |
762
1274
  | HTTP | `GET` |
763
1275
  | Path | `/inner/v1/agent-data/equity/estimates/forward_pe` |
764
- | Default provider | `intrinio` |
765
1276
  | SDK | `supported` |
766
1277
  | Host | `supported` |
767
1278
  | Notes | - |
@@ -770,15 +1281,29 @@ Summary: Forward Pe
770
1281
 
771
1282
  | Param | Required | Type | Default | Notes |
772
1283
  |---|---|---|---|---|
773
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): intrinio. |
774
- | `provider` | `no` | `string` | `intrinio` | - |
1284
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1285
+
1286
+ #### Response fields
1287
+
1288
+ | Field | Type | Notes |
1289
+ |---|---|---|
1290
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1291
+ | `name` | `string` | Name of the entity. |
1292
+ | `year_1` | `number` | Estimated PE ratio for the next fiscal year. |
1293
+ | `year_2` | `number` | Estimated PE ratio two fiscal years from now. |
1294
+ | `year_3` | `number` | Estimated PE ratio three fiscal years from now. |
1295
+ | `year_4` | `number` | Estimated PE ratio four fiscal years from now. |
1296
+ | `year_5` | `number` | Estimated PE ratio five fiscal years from now. |
1297
+ | `peg_ratio_year_1` | `number` | Estimated Forward PEG ratio for the next fiscal year. |
1298
+ | `eps_ttm` | `number` | The latest trailing twelve months earnings per share. |
1299
+ | `last_updated` | `string` | The date the data was last updated. |
775
1300
 
776
1301
  ---
777
1302
 
778
1303
  ### `equity.estimates.forward_sales`
779
1304
 
780
1305
  ```python
781
- data.equity.estimates.forward_sales(symbol=None, fiscal_year=None, fiscal_period=None, calendar_year=None, calendar_period=None, provider='intrinio')
1306
+ data.equity.estimates.forward_sales(symbol=None, fiscal_year=None, fiscal_period=None, calendar_year=None, calendar_period=None)
782
1307
  ```
783
1308
 
784
1309
  Summary: Forward Sales
@@ -788,7 +1313,6 @@ Summary: Forward Sales
788
1313
  | Endpoint ID | `equity.estimates.forward_sales` |
789
1314
  | HTTP | `GET` |
790
1315
  | Path | `/inner/v1/agent-data/equity/estimates/forward_sales` |
791
- | Default provider | `intrinio` |
792
1316
  | SDK | `supported` |
793
1317
  | Host | `supported` |
794
1318
  | Notes | - |
@@ -797,19 +1321,45 @@ Summary: Forward Sales
797
1321
 
798
1322
  | Param | Required | Type | Default | Notes |
799
1323
  |---|---|---|---|---|
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` | - |
1324
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1325
+ | `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. |
1326
+ | `fiscal_period` | `no` | `string | null` | `-` | The future fiscal period to retrieve estimates for. |
1327
+ | `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. |
1328
+ | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. |
1329
+
1330
+ #### Response fields
1331
+
1332
+ | Field | Type | Notes |
1333
+ |---|---|---|
1334
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1335
+ | `name` | `string` | Name of the entity. |
1336
+ | `date` | `string` | The date of the data. |
1337
+ | `fiscal_year` | `integer` | Fiscal year for the estimate. |
1338
+ | `fiscal_period` | `string` | Fiscal quarter for the estimate. |
1339
+ | `calendar_year` | `integer` | Calendar year for the estimate. |
1340
+ | `calendar_period` | `string` | Calendar quarter for the estimate. |
1341
+ | `low_estimate` | `integer` | The sales estimate low for the period. |
1342
+ | `high_estimate` | `integer` | The sales estimate high for the period. |
1343
+ | `mean` | `integer` | The sales estimate mean for the period. |
1344
+ | `median` | `integer` | The sales estimate median for the period. |
1345
+ | `standard_deviation` | `integer` | The sales estimate standard deviation for the period. |
1346
+ | `number_of_analysts` | `integer` | Number of analysts providing estimates for the period. |
1347
+ | `revisions_1w_up` | `integer` | Number of revisions up in the last week. |
1348
+ | `revisions_1w_down` | `integer` | Number of revisions down in the last week. |
1349
+ | `revisions_1w_change_percent` | `number` | The analyst revisions percent change in estimate for the period of 1 week. |
1350
+ | `revisions_1m_up` | `integer` | Number of revisions up in the last month. |
1351
+ | `revisions_1m_down` | `integer` | Number of revisions down in the last month. |
1352
+ | `revisions_1m_change_percent` | `number` | The analyst revisions percent change in estimate for the period of 1 month. |
1353
+ | `revisions_3m_up` | `integer` | Number of revisions up in the last 3 months. |
1354
+ | `revisions_3m_down` | `integer` | Number of revisions down in the last 3 months. |
1355
+ | `revisions_3m_change_percent` | `number` | The analyst revisions percent change in estimate for the period of 3 months. |
806
1356
 
807
1357
  ---
808
1358
 
809
1359
  ### `equity.estimates.historical`
810
1360
 
811
1361
  ```python
812
- data.equity.estimates.historical(symbol=..., freq='quarterly', period='annual', limit=None, page=None, provider=...)
1362
+ data.equity.estimates.historical(symbol=..., freq='quarterly', period='annual', limit=None, page=None)
813
1363
  ```
814
1364
 
815
1365
  Summary: Historical
@@ -819,7 +1369,6 @@ Summary: Historical
819
1369
  | Endpoint ID | `equity.estimates.historical` |
820
1370
  | HTTP | `GET` |
821
1371
  | Path | `/inner/v1/agent-data/equity/estimates/historical` |
822
- | Default provider | - |
823
1372
  | SDK | `supported` |
824
1373
  | Host | `supported` |
825
1374
  | Notes | - |
@@ -828,19 +1377,45 @@ Summary: Historical
828
1377
 
829
1378
  | Param | Required | Type | Default | Notes |
830
1379
  |---|---|---|---|---|
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 |
1380
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1381
+ | `freq` | `no` | `string` | `quarterly` | enum: annual, quarterly The frequency of the data. Can be 'annual' or 'quarterly'. |
1382
+ | `period` | `no` | `string` | `annual` | enum: quarter, annual Time period of the data to return. |
1383
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1384
+ | `page` | `no` | `integer | null` | `-` | Page number for paginated results. Used with limit. |
1385
+
1386
+ #### Response fields
1387
+
1388
+ | Field | Type | Notes |
1389
+ |---|---|---|
1390
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1391
+ | `date` | `string` | The date of the data. |
1392
+ | `estimated_revenue_low` | `integer` | Estimated revenue low. |
1393
+ | `estimated_revenue_high` | `integer` | Estimated revenue high. |
1394
+ | `estimated_revenue_avg` | `integer` | Estimated revenue average. |
1395
+ | `estimated_sga_expense_low` | `integer` | Estimated SGA expense low. |
1396
+ | `estimated_sga_expense_high` | `integer` | Estimated SGA expense high. |
1397
+ | `estimated_sga_expense_avg` | `integer` | Estimated SGA expense average. |
1398
+ | `estimated_ebitda_low` | `integer` | Estimated EBITDA low. |
1399
+ | `estimated_ebitda_high` | `integer` | Estimated EBITDA high. |
1400
+ | `estimated_ebitda_avg` | `integer` | Estimated EBITDA average. |
1401
+ | `estimated_ebit_low` | `integer` | Estimated EBIT low. |
1402
+ | `estimated_ebit_high` | `integer` | Estimated EBIT high. |
1403
+ | `estimated_ebit_avg` | `integer` | Estimated EBIT average. |
1404
+ | `estimated_net_income_low` | `integer` | Estimated net income low. |
1405
+ | `estimated_net_income_high` | `integer` | Estimated net income high. |
1406
+ | `estimated_net_income_avg` | `integer` | Estimated net income average. |
1407
+ | `estimated_eps_avg` | `number` | Estimated EPS average. |
1408
+ | `estimated_eps_high` | `number` | Estimated EPS high. |
1409
+ | `estimated_eps_low` | `number` | Estimated EPS low. |
1410
+ | `number_analyst_estimated_revenue` | `integer` | Number of analysts who estimated revenue. |
1411
+ | `number_analysts_estimated_eps` | `integer` | Number of analysts who estimated EPS. |
837
1412
 
838
1413
  ---
839
1414
 
840
1415
  ### `equity.estimates.price_target`
841
1416
 
842
1417
  ```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=...)
1418
+ 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
1419
  ```
845
1420
 
846
1421
  Summary: Price Target
@@ -850,7 +1425,6 @@ Summary: Price Target
850
1425
  | Endpoint ID | `equity.estimates.price_target` |
851
1426
  | HTTP | `GET` |
852
1427
  | Path | `/inner/v1/agent-data/equity/estimates/price_target` |
853
- | Default provider | - |
854
1428
  | SDK | `supported` |
855
1429
  | Host | `supported` |
856
1430
  | Notes | - |
@@ -859,26 +1433,58 @@ Summary: Price Target
859
1433
 
860
1434
  | Param | Required | Type | Default | Notes |
861
1435
  |---|---|---|---|---|
862
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): benzinga, finviz, fmp. |
1436
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
863
1437
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
864
1438
  | `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
1439
  | `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 |
1440
+ | `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. |
1441
+ | `date` | `no` | `string | null` | `-` | Date for calendar data, shorthand for date_from and date_to. |
1442
+ | `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. |
1443
+ | `importance` | `no` | `integer | null` | `-` | Importance level to filter by. Uses Greater Than or Equal To the importance indicated |
1444
+ | `action` | `no` | `string | null` | `-` | Filter by a specific action_company. |
1445
+ | `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. |
1446
+ | `firm_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of firm IDs. Multiple comma separated items allowed. |
1447
+ | `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. |
1448
+
1449
+ #### Response fields
1450
+
1451
+ | Field | Type | Notes |
1452
+ |---|---|---|
1453
+ | `published_date` | `string` | Published date of the price target. |
1454
+ | `published_time` | `string` | Time of the original rating, UTC. |
1455
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1456
+ | `exchange` | `string` | Exchange where the company is traded. |
1457
+ | `company_name` | `string` | Name of company that is the subject of rating. |
1458
+ | `analyst_name` | `string` | Analyst name. |
1459
+ | `analyst_firm` | `string` | Name of the analyst firm that published the price target. |
1460
+ | `currency` | `string` | Currency the data is denominated in. |
1461
+ | `price_target` | `number` | The current price target. |
1462
+ | `adj_price_target` | `number` | Adjusted price target for splits and stock dividends. |
1463
+ | `price_target_previous` | `number` | Previous price target. |
1464
+ | `previous_adj_price_target` | `number` | Previous adjusted price target. |
1465
+ | `price_when_posted` | `number` | Price when posted. |
1466
+ | `rating_current` | `string` | The analyst's rating for the company. |
1467
+ | `rating_previous` | `string` | Previous analyst rating for the company. |
1468
+ | `action` | `string` | Description of the change in rating from firm's last rating. |
1469
+ | `status` | `string` | The action taken by the firm. |
1470
+ | `rating_change` | `string` | The rating given by the analyst. |
1471
+ | `news_title` | `string` | News title of the price target. |
1472
+ | `news_url` | `string` | News URL of the price target. |
1473
+ | `action_change` | `string` | Description of the change in price target from firm's last price target. |
1474
+ | `importance` | `integer` | Subjective Basis of How Important Event is to Market. 5 = High. |
1475
+ | `notes` | `string` | Notes of the price target. |
1476
+ | `analyst_id` | `string` | Id of the analyst. |
1477
+ | `url_news` | `string` | URL for analyst ratings news articles for this ticker on Benzinga.com. |
1478
+ | `url_analyst` | `string` | URL for analyst ratings page for this ticker on Benzinga.com. |
1479
+ | `id` | `string` | Unique ID of this entry. |
1480
+ | `last_updated` | `string` | Last updated timestamp, UTC. |
875
1481
 
876
1482
  ---
877
1483
 
878
1484
  ### `equity.fundamental.balance`
879
1485
 
880
1486
  ```python
881
- data.equity.fundamental.balance(symbol=..., limit=None, period='annual', fiscal_year=None, provider=...)
1487
+ data.equity.fundamental.balance(symbol=..., limit=None, period='annual', fiscal_year=None)
882
1488
  ```
883
1489
 
884
1490
  Summary: Balance
@@ -888,7 +1494,6 @@ Summary: Balance
888
1494
  | Endpoint ID | `equity.fundamental.balance` |
889
1495
  | HTTP | `GET` |
890
1496
  | Path | `/inner/v1/agent-data/equity/fundamental/balance` |
891
- | Default provider | - |
892
1497
  | SDK | `supported` |
893
1498
  | Host | `supported` |
894
1499
  | Notes | - |
@@ -899,16 +1504,77 @@ Summary: Balance
899
1504
  |---|---|---|---|---|
900
1505
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
901
1506
  | `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 |
1507
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1508
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1509
+
1510
+ #### Response fields
1511
+
1512
+ | Field | Type | Notes |
1513
+ |---|---|---|
1514
+ | `period_ending` | `string` | The end date of the reporting period. |
1515
+ | `fiscal_period` | `string` | The fiscal period of the report. |
1516
+ | `fiscal_year` | `integer` | The fiscal year of the fiscal period. |
1517
+ | `filing_date` | `string` | The date when the filing was made. |
1518
+ | `accepted_date` | `string` | The date and time when the filing was accepted. |
1519
+ | `cik` | `string` | The Central Index Key (CIK) assigned by the SEC, if applicable. |
1520
+ | `symbol` | `string` | The stock ticker symbol. |
1521
+ | `reported_currency` | `string` | The currency in which the balance sheet was reported. |
1522
+ | `cash_and_cash_equivalents` | `integer` | Cash and cash equivalents. |
1523
+ | `short_term_investments` | `integer` | Short term investments. |
1524
+ | `cash_and_short_term_investments` | `integer` | Cash and short term investments. |
1525
+ | `accounts_receivables` | `integer` | Accounts receivables. |
1526
+ | `other_receivables` | `integer` | Other receivables. |
1527
+ | `net_receivables` | `integer` | Net receivables. |
1528
+ | `inventory` | `integer` | Inventory. |
1529
+ | `other_current_assets` | `integer` | Other current assets. |
1530
+ | `total_current_assets` | `integer` | Total current assets. |
1531
+ | `plant_property_equipment_net` | `integer` | Plant property equipment net. |
1532
+ | `goodwill` | `integer` | Goodwill. |
1533
+ | `intangible_assets` | `integer` | Intangible assets. |
1534
+ | `goodwill_and_intangible_assets` | `integer` | Goodwill and intangible assets. |
1535
+ | `long_term_investments` | `integer` | Long term investments. |
1536
+ | `tax_assets` | `integer` | Tax assets. |
1537
+ | `other_non_current_assets` | `integer` | Other non current assets. |
1538
+ | `non_current_assets` | `integer` | Total non current assets. |
1539
+ | `other_assets` | `integer` | Other assets. |
1540
+ | `total_assets` | `integer` | Total assets. |
1541
+ | `accounts_payable` | `integer` | Accounts payable. |
1542
+ | `prepaid_expenses` | `integer` | Prepaid expenses. |
1543
+ | `accrued_expenses` | `integer` | Accrued expenses. |
1544
+ | `short_term_debt` | `integer` | Short term debt. |
1545
+ | `tax_payables` | `integer` | Tax payables. |
1546
+ | `current_deferred_revenue` | `integer` | Current deferred revenue. |
1547
+ | `other_current_liabilities` | `integer` | Other current liabilities. |
1548
+ | `other_payables` | `integer` | Other payables. |
1549
+ | `total_current_liabilities` | `integer` | Total current liabilities. |
1550
+ | `total_payables` | `integer` | Total payables. |
1551
+ | `long_term_debt` | `integer` | Long term debt. |
1552
+ | `deferred_revenue_non_current` | `integer` | Non current deferred revenue. |
1553
+ | `deferred_tax_liabilities_non_current` | `integer` | Deferred tax liabilities non current. |
1554
+ | `other_non_current_liabilities` | `integer` | Other non current liabilities. |
1555
+ | `total_non_current_liabilities` | `integer` | Total non current liabilities. |
1556
+ | `capital_lease_obligations` | `integer` | Capital lease obligations. |
1557
+ | `other_liabilities` | `integer` | Other liabilities. |
1558
+ | `total_liabilities` | `integer` | Total liabilities. |
1559
+ | `preferred_stock` | `integer` | Preferred stock. |
1560
+ | `common_stock` | `integer` | Common stock. |
1561
+ | `retained_earnings` | `integer` | Retained earnings. |
1562
+ | `additional_paid_in_capital` | `integer` | Additional paid in capital. |
1563
+ | `accumulated_other_comprehensive_income` | `integer` | Accumulated other comprehensive income (loss). |
1564
+ | `total_common_equity` | `integer` | Total common equity. |
1565
+ | `total_liabilities_and_shareholders_equity` | `integer` | Total liabilities and shareholders equity. |
1566
+ | `minority_interest` | `integer` | Minority interest. |
1567
+ | `total_liabilities_and_total_equity` | `integer` | Total liabilities and total equity. |
1568
+ | `total_investments` | `integer` | Total investments. |
1569
+ | `total_debt` | `integer` | Total debt. |
1570
+ | `net_debt` | `integer` | Net debt. |
905
1571
 
906
1572
  ---
907
1573
 
908
1574
  ### `equity.fundamental.balance_growth`
909
1575
 
910
1576
  ```python
911
- data.equity.fundamental.balance_growth(symbol=..., limit=None, period='annual', provider='fmp')
1577
+ data.equity.fundamental.balance_growth(symbol=..., limit=None, period='annual')
912
1578
  ```
913
1579
 
914
1580
  Summary: Balance Growth
@@ -918,7 +1584,6 @@ Summary: Balance Growth
918
1584
  | Endpoint ID | `equity.fundamental.balance_growth` |
919
1585
  | HTTP | `GET` |
920
1586
  | Path | `/inner/v1/agent-data/equity/fundamental/balance_growth` |
921
- | Default provider | `fmp` |
922
1587
  | SDK | `supported` |
923
1588
  | Host | `supported` |
924
1589
  | Notes | - |
@@ -928,16 +1593,40 @@ Summary: Balance Growth
928
1593
  | Param | Required | Type | Default | Notes |
929
1594
  |---|---|---|---|---|
930
1595
  | `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` | - |
1596
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1597
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1598
+
1599
+ #### Response fields
1600
+
1601
+ | Field | Type | Notes |
1602
+ |---|---|---|
1603
+ | `period_ending` | `string` | The end date of the reporting period. |
1604
+ | `fiscal_period` | `string` | The fiscal period of the report. |
1605
+ | `fiscal_year` | `integer` | The fiscal year of the fiscal period. |
1606
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1607
+ | `reported_currency` | `string` | The currency in which the financial data is reported. |
1608
+ | `growth_cash_and_cash_equivalents` | `number` | Growth rate of cash and cash equivalents. |
1609
+ | `growth_short_term_investments` | `number` | Growth rate of short-term investments. |
1610
+ | `growth_cash_and_short_term_investments` | `number` | Growth rate of cash and short-term investments. |
1611
+ | `growth_accounts_receivables` | `number` | Growth rate of accounts receivable. |
1612
+ | `growth_net_receivables` | `number` | Growth rate of net receivables. |
1613
+ | `growth_inventory` | `number` | Growth rate of inventory. |
1614
+ | `growth_total_current_assets` | `number` | Growth rate of total current assets. |
1615
+ | `growth_property_plant_equipment_net` | `number` | Growth rate of net property, plant, and equipment. |
1616
+ | `growth_goodwill` | `number` | Growth rate of goodwill. |
1617
+ | `growth_intangible_assets` | `number` | Growth rate of intangible assets. |
1618
+ | `growth_total_assets` | `number` | Growth rate of total assets. |
1619
+ | `growth_total_liabilities` | `number` | Growth rate of total liabilities. |
1620
+ | `growth_total_shareholders_equity` | `number` | Growth rate of total stockholders' equity. |
1621
+ | `growth_total_debt` | `number` | Growth rate of total debt. |
1622
+ | `growth_net_debt` | `number` | Growth rate of net debt. |
934
1623
 
935
1624
  ---
936
1625
 
937
1626
  ### `equity.fundamental.cash`
938
1627
 
939
1628
  ```python
940
- data.equity.fundamental.cash(symbol=..., limit=5, period='annual', fiscal_year=None, provider=...)
1629
+ data.equity.fundamental.cash(symbol=..., limit=5, period='annual', fiscal_year=None)
941
1630
  ```
942
1631
 
943
1632
  Summary: Cash
@@ -947,7 +1636,6 @@ Summary: Cash
947
1636
  | Endpoint ID | `equity.fundamental.cash` |
948
1637
  | HTTP | `GET` |
949
1638
  | Path | `/inner/v1/agent-data/equity/fundamental/cash` |
950
- | Default provider | - |
951
1639
  | SDK | `supported` |
952
1640
  | Host | `supported` |
953
1641
  | Notes | - |
@@ -958,16 +1646,45 @@ Summary: Cash
958
1646
  |---|---|---|---|---|
959
1647
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
960
1648
  | `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 |
1649
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1650
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1651
+
1652
+ #### Response fields
1653
+
1654
+ | Field | Type | Notes |
1655
+ |---|---|---|
1656
+ | `period_ending` | `string` | The end date of the reporting period. |
1657
+ | `fiscal_period` | `string` | The fiscal period of the report. |
1658
+ | `fiscal_year` | `integer` | The fiscal year of the fiscal period. |
1659
+ | `filing_date` | `string` | The date of the filing. |
1660
+ | `accepted_date` | `string` | The date the filing was accepted. |
1661
+ | `cik` | `string` | The Central Index Key (CIK) assigned by the SEC, if applicable. |
1662
+ | `symbol` | `string` | The stock ticker symbol. |
1663
+ | `reported_currency` | `string` | The currency in which the cash flow statement was reported. |
1664
+ | `net_income` | `integer` | Net income. |
1665
+ | `depreciation_and_amortization` | `integer` | Depreciation and amortization. |
1666
+ | `stock_based_compensation` | `integer` | Stock-based compensation. |
1667
+ | `change_in_working_capital` | `integer` | Change in working capital. |
1668
+ | `net_cash_from_operating_activities` | `integer` | Net cash from operating activities. |
1669
+ | `purchase_of_property_plant_and_equipment` | `integer` | Purchase of property, plant and equipment. |
1670
+ | `acquisitions` | `integer` | Acquisitions. |
1671
+ | `net_cash_from_investing_activities` | `integer` | Net cash from investing activities. |
1672
+ | `repayment_of_debt` | `integer` | Repayment of debt. |
1673
+ | `common_dividends_paid` | `integer` | Payment of common dividends. |
1674
+ | `net_cash_from_financing_activities` | `integer` | Net cash from financing activities. |
1675
+ | `net_change_in_cash_and_equivalents` | `integer` | Net change in cash and equivalents. |
1676
+ | `cash_at_beginning_of_period` | `integer` | Cash at beginning of period. |
1677
+ | `cash_at_end_of_period` | `integer` | Cash at end of period. |
1678
+ | `operating_cash_flow` | `integer` | Operating cash flow. |
1679
+ | `capital_expenditure` | `integer` | Capital expenditure. |
1680
+ | `free_cash_flow` | `integer` | Free Cash Flow. |
964
1681
 
965
1682
  ---
966
1683
 
967
1684
  ### `equity.fundamental.cash_growth`
968
1685
 
969
1686
  ```python
970
- data.equity.fundamental.cash_growth(symbol=..., limit=None, period='annual', provider='fmp')
1687
+ data.equity.fundamental.cash_growth(symbol=..., limit=None, period='annual')
971
1688
  ```
972
1689
 
973
1690
  Summary: Cash Growth
@@ -977,7 +1694,6 @@ Summary: Cash Growth
977
1694
  | Endpoint ID | `equity.fundamental.cash_growth` |
978
1695
  | HTTP | `GET` |
979
1696
  | Path | `/inner/v1/agent-data/equity/fundamental/cash_growth` |
980
- | Default provider | `fmp` |
981
1697
  | SDK | `supported` |
982
1698
  | Host | `supported` |
983
1699
  | Notes | - |
@@ -988,15 +1704,39 @@ Summary: Cash Growth
988
1704
  |---|---|---|---|---|
989
1705
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
990
1706
  | `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` | - |
1707
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1708
+
1709
+ #### Response fields
1710
+
1711
+ | Field | Type | Notes |
1712
+ |---|---|---|
1713
+ | `period_ending` | `string` | The end date of the reporting period. |
1714
+ | `fiscal_period` | `string` | The fiscal period of the report. |
1715
+ | `fiscal_year` | `integer` | The fiscal year of the fiscal period. |
1716
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1717
+ | `reported_currency` | `string` | The currency in which the financial data is reported. |
1718
+ | `growth_net_income` | `number` | Growth rate of net income. |
1719
+ | `growth_depreciation_and_amortization` | `number` | Growth rate of depreciation and amortization. |
1720
+ | `growth_stock_based_compensation` | `number` | Growth rate of stock-based compensation. |
1721
+ | `growth_change_in_working_capital` | `number` | Growth rate of change in working capital. |
1722
+ | `growth_net_cash_from_operating_activities` | `number` | Growth rate of net cash provided by operating activities. |
1723
+ | `growth_purchase_of_property_plant_and_equipment` | `number` | Growth rate of investments in property, plant, and equipment. |
1724
+ | `growth_acquisitions` | `number` | Growth rate of net acquisitions. |
1725
+ | `growth_net_cash_from_investing_activities` | `number` | Growth rate of net cash used for investing activities. |
1726
+ | `growth_net_debt_issuance` | `number` | Growth rate of net debt issuance. |
1727
+ | `growth_repayment_of_debt` | `number` | Growth rate of debt repayment. |
1728
+ | `growth_net_cash_from_financing_activities` | `number` | Growth rate of net cash used/provided by financing activities. |
1729
+ | `growth_net_change_in_cash_and_equivalents` | `number` | Growth rate of net change in cash. |
1730
+ | `growth_operating_cash_flow` | `number` | Growth rate of operating cash flow. |
1731
+ | `growth_capital_expenditure` | `number` | Growth rate of capital expenditure. |
1732
+ | `growth_free_cash_flow` | `number` | Growth rate of free cash flow. |
993
1733
 
994
1734
  ---
995
1735
 
996
1736
  ### `equity.fundamental.dividends`
997
1737
 
998
1738
  ```python
999
- data.equity.fundamental.dividends(symbol=..., start_time=None, end_time=None, limit=None, provider=...)
1739
+ data.equity.fundamental.dividends(symbol=..., start_time=None, end_time=None, limit=None)
1000
1740
  ```
1001
1741
 
1002
1742
  Summary: Dividends
@@ -1006,7 +1746,6 @@ Summary: Dividends
1006
1746
  | Endpoint ID | `equity.fundamental.dividends` |
1007
1747
  | HTTP | `GET` |
1008
1748
  | Path | `/inner/v1/agent-data/equity/fundamental/dividends` |
1009
- | Default provider | - |
1010
1749
  | SDK | `supported` |
1011
1750
  | Host | `supported` |
1012
1751
  | Notes | - |
@@ -1015,18 +1754,35 @@ Summary: Dividends
1015
1754
 
1016
1755
  | Param | Required | Type | Default | Notes |
1017
1756
  |---|---|---|---|---|
1018
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, nasdaq. |
1757
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1019
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. |
1020
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. |
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 |
1760
+ | `limit` | `no` | `integer | null` | `-` | Return N most recent payments.; The number of data entries to return. |
1761
+
1762
+ #### Response fields
1763
+
1764
+ | Field | Type | Notes |
1765
+ |---|---|---|
1766
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1767
+ | `ex_dividend_date` | `string` | The ex-dividend date - the date on which the stock begins trading without rights to the dividend. |
1768
+ | `amount` | `number` | The dividend amount per share. |
1769
+ | `factor` | `number` | Factor by which to multiply stock prices before this date, in order to calculate historically-adjusted stock prices. |
1770
+ | `currency` | `string` | The currency in which the dividend is paid. |
1771
+ | `split_ratio` | `number` | The ratio of the stock split, if a stock split occurred. |
1772
+ | `dividend_type` | `string` | The type of dividend - i.e., cash, stock. |
1773
+ | `record_date` | `string` | The record date of ownership for eligibility. |
1774
+ | `payment_date` | `string` | The payment date of the dividend. |
1775
+ | `declaration_date` | `string` | Declaration date of the dividend. |
1776
+ | `adjusted_amount` | `number` | Split-adjusted dividend amount. |
1777
+ | `dividend_yield` | `number` | Dividend yield represented by the payment. |
1778
+ | `frequency` | `string` | Frequency of the payment. |
1023
1779
 
1024
1780
  ---
1025
1781
 
1026
1782
  ### `equity.fundamental.employee_count`
1027
1783
 
1028
1784
  ```python
1029
- data.equity.fundamental.employee_count(symbol=..., start_time=None, end_time=None, limit=None, provider='fmp')
1785
+ data.equity.fundamental.employee_count(symbol=..., start_time=None, end_time=None, limit=None)
1030
1786
  ```
1031
1787
 
1032
1788
  Summary: Employee Count
@@ -1036,7 +1792,6 @@ Summary: Employee Count
1036
1792
  | Endpoint ID | `equity.fundamental.employee_count` |
1037
1793
  | HTTP | `GET` |
1038
1794
  | Path | `/inner/v1/agent-data/equity/fundamental/employee_count` |
1039
- | Default provider | `fmp` |
1040
1795
  | SDK | `supported` |
1041
1796
  | Host | `supported` |
1042
1797
  | Notes | - |
@@ -1045,18 +1800,28 @@ Summary: Employee Count
1045
1800
 
1046
1801
  | Param | Required | Type | Default | Notes |
1047
1802
  |---|---|---|---|---|
1048
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
1803
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1049
1804
  | `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
1805
  | `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` | - |
1806
+ | `limit` | `no` | `integer | null` | `-` | Number of records to return. Default is all. |
1807
+
1808
+ #### Response fields
1809
+
1810
+ | Field | Type | Notes |
1811
+ |---|---|---|
1812
+ | `date` | `string` | The date of the data. |
1813
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1814
+ | `employees` | `integer` | Reported number of employees. |
1815
+ | `company_name` | `string` | Company name associated with the data. |
1816
+ | `source` | `string` | Source reference for the data. |
1817
+ | `url` | `string` | URL link to the source of the data. |
1053
1818
 
1054
1819
  ---
1055
1820
 
1056
1821
  ### `equity.fundamental.esg_score`
1057
1822
 
1058
1823
  ```python
1059
- data.equity.fundamental.esg_score(symbol=..., provider='fmp')
1824
+ data.equity.fundamental.esg_score(symbol=...)
1060
1825
  ```
1061
1826
 
1062
1827
  Summary: Esg Score
@@ -1066,7 +1831,6 @@ Summary: Esg Score
1066
1831
  | Endpoint ID | `equity.fundamental.esg_score` |
1067
1832
  | HTTP | `GET` |
1068
1833
  | Path | `/inner/v1/agent-data/equity/fundamental/esg_score` |
1069
- | Default provider | `fmp` |
1070
1834
  | SDK | `supported` |
1071
1835
  | Host | `supported` |
1072
1836
  | Notes | - |
@@ -1075,15 +1839,30 @@ Summary: Esg Score
1075
1839
 
1076
1840
  | Param | Required | Type | Default | Notes |
1077
1841
  |---|---|---|---|---|
1078
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
1079
- | `provider` | `no` | `string` | `fmp` | - |
1842
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1843
+
1844
+ #### Response fields
1845
+
1846
+ | Field | Type | Notes |
1847
+ |---|---|---|
1848
+ | `period_ending` | `string` | Period ending date of the report. |
1849
+ | `disclosure_date` | `string` | Date when the report was submitted. |
1850
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1851
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
1852
+ | `company_name` | `string` | Company name of the company. |
1853
+ | `form_type` | `string` | Form type where the disclosure was made. |
1854
+ | `environmental_score` | `number` | Environmental score of the company. |
1855
+ | `social_score` | `number` | Social score of the company. |
1856
+ | `governance_score` | `number` | Governance score of the company. |
1857
+ | `esg_score` | `number` | ESG score of the company. |
1858
+ | `url` | `string` | URL to the report or filing. |
1080
1859
 
1081
1860
  ---
1082
1861
 
1083
1862
  ### `equity.fundamental.filings`
1084
1863
 
1085
1864
  ```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=...)
1865
+ 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
1866
  ```
1088
1867
 
1089
1868
  Summary: Filings
@@ -1093,7 +1872,6 @@ Summary: Filings
1093
1872
  | Endpoint ID | `equity.fundamental.filings` |
1094
1873
  | HTTP | `GET` |
1095
1874
  | Path | `/inner/v1/agent-data/equity/fundamental/filings` |
1096
- | Default provider | - |
1097
1875
  | SDK | `supported` |
1098
1876
  | Host | `supported` |
1099
1877
  | Notes | - |
@@ -1105,22 +1883,52 @@ Summary: Filings
1105
1883
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
1106
1884
  | `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
1885
  | `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 |
1886
+ | `cik` | `no` | `string | integer | null` | `-` | CIK number to look up. Overrides symbol.; Lookup filings by Central Index Key (CIK) instead of by symbol. |
1887
+ | `limit` | `no` | `integer | null` | `1000` | Number of results to return. Max results is 1000.; The number of data entries to return. |
1888
+ | `page` | `no` | `integer` | `0` | Page number for paginated results. Max page is 100. |
1889
+ | `form_type` | `no` | `string | null` | `-` | SEC form type to filter by. |
1890
+ | `thea_enabled` | `no` | `boolean | null` | `-` | Return filings that have been read by Intrinio's Thea NLP. |
1891
+ | `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. |
1892
+ | `form_group` | `no` | `string` | `8k` | enum: annual, quarterly, proxy, insider, 8k, registration, comment The form group to fetch, default is 8k. |
1893
+ | `use_cache` | `no` | `boolean` | `true` | Whether or not to use cache. If True, cache will store for one day. |
1894
+
1895
+ #### Response fields
1896
+
1897
+ | Field | Type | Notes |
1898
+ |---|---|---|
1899
+ | `filing_date` | `string` | The date of the filing. |
1900
+ | `report_type` | `string` | Type of filing. |
1901
+ | `report_url` | `string` | URL to the actual report. |
1902
+ | `period_ending` | `string` | The ending date for the reporting period, if available. |
1903
+ | `name` | `string` | The name of the company, if available. |
1904
+ | `reporting_owner` | `string` | The name of the reporting owner, if applicable. |
1905
+ | `report_date` | `string` | The date of the filing. |
1906
+ | `act` | `string` | The SEC Act number. |
1907
+ | `items` | `string` | The SEC Item numbers. |
1908
+ | `primary_doc_description` | `string` | The description of the primary document. |
1909
+ | `primary_doc` | `string` | The filename of the primary document. |
1910
+ | `accession_number` | `string` | The accession number. |
1911
+ | `file_number` | `string` | The file number. |
1912
+ | `is_inline_xbrl` | `string` | Whether the filing is an inline XBRL filing. |
1913
+ | `is_xbrl` | `string` | Whether the filing is an XBRL filing. |
1914
+ | `size` | `string` | The size of the filing. |
1915
+ | `complete_submission_url` | `string` | The URL to the complete filing submission. |
1916
+ | `filing_detail_url` | `string` | The URL to the filing details. |
1917
+ | `filing_url` | `string` | URL to the filing page. |
1918
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1919
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
1920
+ | `accepted_date` | `string` | Accepted date of the filing. |
1921
+ | `description` | `string` | The description of the filing. |
1922
+ | `id` | `string` | Intrinio ID of the filing. |
1923
+ | `period_end_date` | `string` | Ending date of the fiscal period for the filing. |
1924
+ | `word_count` | `integer` | Number of words in the filing, if available. |
1117
1925
 
1118
1926
  ---
1119
1927
 
1120
1928
  ### `equity.fundamental.historical_attributes`
1121
1929
 
1122
1930
  ```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')
1931
+ data.equity.fundamental.historical_attributes(symbol=..., tag=..., start_time=None, end_time=None, frequency='yearly', limit=1000, tag_type=None, sort='desc')
1124
1932
  ```
1125
1933
 
1126
1934
  Summary: Historical Attributes
@@ -1130,7 +1938,6 @@ Summary: Historical Attributes
1130
1938
  | Endpoint ID | `equity.fundamental.historical_attributes` |
1131
1939
  | HTTP | `GET` |
1132
1940
  | Path | `/inner/v1/agent-data/equity/fundamental/historical_attributes` |
1133
- | Default provider | `intrinio` |
1134
1941
  | SDK | `supported` |
1135
1942
  | Host | `supported` |
1136
1943
  | Notes | - |
@@ -1139,22 +1946,30 @@ Summary: Historical Attributes
1139
1946
 
1140
1947
  | Param | Required | Type | Default | Notes |
1141
1948
  |---|---|---|---|---|
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. |
1949
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1950
+ | `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed |
1144
1951
  | `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
1952
  | `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
1953
  | `frequency` | `no` | `string | null` | `yearly` | The frequency of the data. |
1147
1954
  | `limit` | `no` | `integer | null` | `1000` | The number of data entries to return. |
1148
1955
  | `tag_type` | `no` | `string | null` | `-` | Filter by type, when applicable. |
1149
1956
  | `sort` | `no` | `string | null` | `desc` | Sort order. |
1150
- | `provider` | `no` | `string` | `intrinio` | - |
1957
+
1958
+ #### Response fields
1959
+
1960
+ | Field | Type | Notes |
1961
+ |---|---|---|
1962
+ | `date` | `string` | The date of the data. |
1963
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1964
+ | `tag` | `string` | Tag name for the fetched data. |
1965
+ | `value` | `number` | The value of the data. |
1151
1966
 
1152
1967
  ---
1153
1968
 
1154
1969
  ### `equity.fundamental.historical_eps`
1155
1970
 
1156
1971
  ```python
1157
- data.equity.fundamental.historical_eps(symbol=..., period='quarter', limit=None, provider=...)
1972
+ data.equity.fundamental.historical_eps(symbol=..., period='quarter', limit=None)
1158
1973
  ```
1159
1974
 
1160
1975
  Summary: Historical Eps
@@ -1164,7 +1979,6 @@ Summary: Historical Eps
1164
1979
  | Endpoint ID | `equity.fundamental.historical_eps` |
1165
1980
  | HTTP | `GET` |
1166
1981
  | Path | `/inner/v1/agent-data/equity/fundamental/historical_eps` |
1167
- | Default provider | - |
1168
1982
  | SDK | `supported` |
1169
1983
  | Host | `supported` |
1170
1984
  | Notes | - |
@@ -1173,17 +1987,32 @@ Summary: Historical Eps
1173
1987
 
1174
1988
  | Param | Required | Type | Default | Notes |
1175
1989
  |---|---|---|---|---|
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 |
1990
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1991
+ | `period` | `no` | `string` | `quarter` | enum: annual, quarter Time period of the data to return. |
1992
+ | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1993
+
1994
+ #### Response fields
1995
+
1996
+ | Field | Type | Notes |
1997
+ |---|---|---|
1998
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
1999
+ | `date` | `string` | The date of the data. |
2000
+ | `eps_actual` | `integer` | Actual EPS from the earnings date. |
2001
+ | `eps_estimated` | `integer` | Estimated EPS for the earnings date. |
2002
+ | `surprise` | `number` | Surprise in EPS (Actual - Estimated). |
2003
+ | `surprise_percent` | `number` | EPS surprise as a normalized percent. |
2004
+ | `reported_date` | `string` | Date of the earnings report. |
2005
+ | `report_time` | `string` | Time of day when the earnings report was released. |
2006
+ | `revenue_estimated` | `integer` | Estimated consensus revenue for the reporting period. |
2007
+ | `revenue_actual` | `integer` | The actual reported revenue. |
2008
+ | `updated` | `string` | The date when the data was last updated. |
1180
2009
 
1181
2010
  ---
1182
2011
 
1183
2012
  ### `equity.fundamental.historical_splits`
1184
2013
 
1185
2014
  ```python
1186
- data.equity.fundamental.historical_splits(symbol=..., provider='fmp')
2015
+ data.equity.fundamental.historical_splits(symbol=...)
1187
2016
  ```
1188
2017
 
1189
2018
  Summary: Historical Splits
@@ -1193,7 +2022,6 @@ Summary: Historical Splits
1193
2022
  | Endpoint ID | `equity.fundamental.historical_splits` |
1194
2023
  | HTTP | `GET` |
1195
2024
  | Path | `/inner/v1/agent-data/equity/fundamental/historical_splits` |
1196
- | Default provider | `fmp` |
1197
2025
  | SDK | `supported` |
1198
2026
  | Host | `supported` |
1199
2027
  | Notes | - |
@@ -1203,14 +2031,22 @@ Summary: Historical Splits
1203
2031
  | Param | Required | Type | Default | Notes |
1204
2032
  |---|---|---|---|---|
1205
2033
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1206
- | `provider` | `no` | `string` | `fmp` | - |
2034
+
2035
+ #### Response fields
2036
+
2037
+ | Field | Type | Notes |
2038
+ |---|---|---|
2039
+ | `date` | `string` | The date of the data. |
2040
+ | `numerator` | `number` | Numerator of the split. |
2041
+ | `denominator` | `number` | Denominator of the split. |
2042
+ | `split_ratio` | `string` | Split ratio. |
1207
2043
 
1208
2044
  ---
1209
2045
 
1210
2046
  ### `equity.fundamental.income`
1211
2047
 
1212
2048
  ```python
1213
- data.equity.fundamental.income(symbol=..., limit=None, period='annual', fiscal_year=None, provider=...)
2049
+ data.equity.fundamental.income(symbol=..., limit=None, period='annual', fiscal_year=None)
1214
2050
  ```
1215
2051
 
1216
2052
  Summary: Income
@@ -1220,7 +2056,6 @@ Summary: Income
1220
2056
  | Endpoint ID | `equity.fundamental.income` |
1221
2057
  | HTTP | `GET` |
1222
2058
  | Path | `/inner/v1/agent-data/equity/fundamental/income` |
1223
- | Default provider | - |
1224
2059
  | SDK | `supported` |
1225
2060
  | Host | `supported` |
1226
2061
  | Notes | - |
@@ -1231,16 +2066,41 @@ Summary: Income
1231
2066
  |---|---|---|---|---|
1232
2067
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1233
2068
  | `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 |
2069
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
2070
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
2071
+
2072
+ #### Response fields
2073
+
2074
+ | Field | Type | Notes |
2075
+ |---|---|---|
2076
+ | `period_ending` | `string` | The end date of the reporting period. |
2077
+ | `fiscal_period` | `string` | The fiscal period of the report. |
2078
+ | `fiscal_year` | `integer` | The fiscal year of the fiscal period. |
2079
+ | `reported_currency` | `string` | The currency in which the balance sheet is reported. |
2080
+ | `revenue` | `number` | Total revenue. |
2081
+ | `cost_of_revenue` | `number` | Total cost of revenue. |
2082
+ | `gross_profit` | `number` | Total gross profit. |
2083
+ | `research_and_development_expense` | `number` | Research and development expense. |
2084
+ | `selling_general_and_admin_expense` | `number` | Selling, general, and admin expense. |
2085
+ | `total_operating_expenses` | `number` | Total operating expenses. |
2086
+ | `total_operating_income` | `number` | Total operating income. |
2087
+ | `ebitda` | `number` | Earnings Before Interest, Taxes, Depreciation and Amortization. |
2088
+ | `ebit` | `number` | Earnings Before Interest and Taxes. |
2089
+ | `income_tax_expense` | `number` | Income tax expense. |
2090
+ | `net_income_attributable_to_common_shareholders` | `number` | Net income attributable to common shareholders. |
2091
+ | `basic_earnings_per_share` | `number` | Basic earnings per share. |
2092
+ | `diluted_earnings_per_share` | `number` | Diluted earnings per share. |
2093
+ | `filing_date` | `string` | The date when the filing was made. |
2094
+ | `accepted_date` | `string` | The date and time when the filing was accepted. |
2095
+ | `cik` | `string` | The Central Index Key (CIK) assigned by the SEC, if applicable. |
2096
+ | `symbol` | `string` | The stock ticker symbol. |
1237
2097
 
1238
2098
  ---
1239
2099
 
1240
2100
  ### `equity.fundamental.income_growth`
1241
2101
 
1242
2102
  ```python
1243
- data.equity.fundamental.income_growth(symbol=..., limit=None, period='annual', provider='fmp')
2103
+ data.equity.fundamental.income_growth(symbol=..., limit=None, period='annual')
1244
2104
  ```
1245
2105
 
1246
2106
  Summary: Income Growth
@@ -1250,7 +2110,6 @@ Summary: Income Growth
1250
2110
  | Endpoint ID | `equity.fundamental.income_growth` |
1251
2111
  | HTTP | `GET` |
1252
2112
  | Path | `/inner/v1/agent-data/equity/fundamental/income_growth` |
1253
- | Default provider | `fmp` |
1254
2113
  | SDK | `supported` |
1255
2114
  | Host | `supported` |
1256
2115
  | Notes | - |
@@ -1261,15 +2120,39 @@ Summary: Income Growth
1261
2120
  |---|---|---|---|---|
1262
2121
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1263
2122
  | `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` | - |
2123
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
2124
+
2125
+ #### Response fields
2126
+
2127
+ | Field | Type | Notes |
2128
+ |---|---|---|
2129
+ | `period_ending` | `string` | The end date of the reporting period. |
2130
+ | `fiscal_period` | `string` | The fiscal period of the report. |
2131
+ | `fiscal_year` | `integer` | The fiscal year of the fiscal period. |
2132
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2133
+ | `reported_currency` | `string` | The currency in which the financial data is reported. |
2134
+ | `growth_revenue` | `number` | Growth rate of total revenue. |
2135
+ | `growth_cost_of_revenue` | `number` | Growth rate of cost of goods sold. |
2136
+ | `growth_gross_profit` | `number` | Growth rate of gross profit. |
2137
+ | `growth_research_and_development_expense` | `number` | Growth rate of expenses on research and development. |
2138
+ | `growth_selling_and_marketing_expense` | `number` | Growth rate of expenses on selling and marketing activities. |
2139
+ | `growth_operating_expenses` | `number` | Growth rate of total operating expenses. |
2140
+ | `growth_ebit` | `number` | Growth rate of Earnings Before Interest and Taxes (EBIT). |
2141
+ | `growth_ebitda` | `number` | Growth rate of Earnings Before Interest, Taxes, Depreciation, and Amortization. |
2142
+ | `growth_operating_income` | `number` | Growth rate of operating income. |
2143
+ | `growth_income_before_tax` | `number` | Growth rate of income before taxes. |
2144
+ | `growth_income_tax_expense` | `number` | Growth rate of income tax expenses. |
2145
+ | `growth_net_income_from_continuing_operations` | `number` | Growth rate of net income from continuing operations. |
2146
+ | `growth_consolidated_net_income` | `number` | Growth rate of net income. |
2147
+ | `growth_basic_earings_per_share` | `number` | Growth rate of Earnings Per Share (EPS). |
2148
+ | `growth_diluted_earnings_per_share` | `number` | Growth rate of diluted Earnings Per Share (EPS). |
1266
2149
 
1267
2150
  ---
1268
2151
 
1269
2152
  ### `equity.fundamental.latest_attributes`
1270
2153
 
1271
2154
  ```python
1272
- data.equity.fundamental.latest_attributes(symbol=..., tag=..., provider='intrinio')
2155
+ data.equity.fundamental.latest_attributes(symbol=..., tag=...)
1273
2156
  ```
1274
2157
 
1275
2158
  Summary: Latest Attributes
@@ -1279,7 +2162,6 @@ Summary: Latest Attributes
1279
2162
  | Endpoint ID | `equity.fundamental.latest_attributes` |
1280
2163
  | HTTP | `GET` |
1281
2164
  | Path | `/inner/v1/agent-data/equity/fundamental/latest_attributes` |
1282
- | Default provider | `intrinio` |
1283
2165
  | SDK | `supported` |
1284
2166
  | Host | `supported` |
1285
2167
  | Notes | - |
@@ -1288,16 +2170,23 @@ Summary: Latest Attributes
1288
2170
 
1289
2171
  | Param | Required | Type | Default | Notes |
1290
2172
  |---|---|---|---|---|
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` | - |
2173
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
2174
+ | `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed |
2175
+
2176
+ #### Response fields
2177
+
2178
+ | Field | Type | Notes |
2179
+ |---|---|---|
2180
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2181
+ | `tag` | `string` | Tag name for the fetched data. |
2182
+ | `value` | `string` | The value of the data. |
1294
2183
 
1295
2184
  ---
1296
2185
 
1297
2186
  ### `equity.fundamental.management`
1298
2187
 
1299
2188
  ```python
1300
- data.equity.fundamental.management(symbol=..., provider=...)
2189
+ data.equity.fundamental.management(symbol=...)
1301
2190
  ```
1302
2191
 
1303
2192
  Summary: Management
@@ -1307,7 +2196,6 @@ Summary: Management
1307
2196
  | Endpoint ID | `equity.fundamental.management` |
1308
2197
  | HTTP | `GET` |
1309
2198
  | Path | `/inner/v1/agent-data/equity/fundamental/management` |
1310
- | Default provider | - |
1311
2199
  | SDK | `supported` |
1312
2200
  | Host | `supported` |
1313
2201
  | Notes | - |
@@ -1317,14 +2205,27 @@ Summary: Management
1317
2205
  | Param | Required | Type | Default | Notes |
1318
2206
  |---|---|---|---|---|
1319
2207
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1320
- | `provider` | `yes` | `string` | `-` | enum: fmp, yfinance |
2208
+
2209
+ #### Response fields
2210
+
2211
+ | Field | Type | Notes |
2212
+ |---|---|---|
2213
+ | `title` | `string` | Designation of the key executive. |
2214
+ | `name` | `string` | Name of the key executive. |
2215
+ | `pay` | `integer` | Pay of the key executive. |
2216
+ | `currency_pay` | `string` | Currency of the pay. |
2217
+ | `gender` | `string` | Gender of the key executive. |
2218
+ | `year_born` | `integer` | Birth year of the key executive. |
2219
+ | `exercised_value` | `integer` | Value of shares exercised. |
2220
+ | `unexercised_value` | `integer` | Value of shares not exercised. |
2221
+ | `fiscal_year` | `integer` | Fiscal year of the pay. |
1321
2222
 
1322
2223
  ---
1323
2224
 
1324
2225
  ### `equity.fundamental.management_compensation`
1325
2226
 
1326
2227
  ```python
1327
- data.equity.fundamental.management_compensation(symbol=..., year=-1, provider='fmp')
2228
+ data.equity.fundamental.management_compensation(symbol=..., year=-1)
1328
2229
  ```
1329
2230
 
1330
2231
  Summary: Management Compensation
@@ -1334,7 +2235,6 @@ Summary: Management Compensation
1334
2235
  | Endpoint ID | `equity.fundamental.management_compensation` |
1335
2236
  | HTTP | `GET` |
1336
2237
  | Path | `/inner/v1/agent-data/equity/fundamental/management_compensation` |
1337
- | Default provider | `fmp` |
1338
2238
  | SDK | `supported` |
1339
2239
  | Host | `supported` |
1340
2240
  | Notes | - |
@@ -1343,16 +2243,35 @@ Summary: Management Compensation
1343
2243
 
1344
2244
  | Param | Required | Type | Default | Notes |
1345
2245
  |---|---|---|---|---|
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` | - |
2246
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
2247
+ | `year` | `no` | `integer` | `-1` | Filters results by year, enter 0 for all data available. Default is the most recent year in the dataset, -1. |
2248
+
2249
+ #### Response fields
2250
+
2251
+ | Field | Type | Notes |
2252
+ |---|---|---|
2253
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2254
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
2255
+ | `report_date` | `string` | Date of reported compensation. |
2256
+ | `company_name` | `string` | The name of the company. |
2257
+ | `executive` | `string` | Name and position. |
2258
+ | `year` | `integer` | Year of the compensation. |
2259
+ | `salary` | `integer` | Base salary. |
2260
+ | `bonus` | `integer` | Bonus payments. |
2261
+ | `stock_award` | `integer` | Stock awards. |
2262
+ | `option_award` | `integer` | Option awards. |
2263
+ | `incentive_plan_compensation` | `integer` | Incentive plan compensation. |
2264
+ | `all_other_compensation` | `integer` | All other compensation. |
2265
+ | `total` | `integer` | Total compensation. |
2266
+ | `accepted_date` | `string` | Date the filing was accepted. |
2267
+ | `url` | `string` | URL to the filing data. |
1349
2268
 
1350
2269
  ---
1351
2270
 
1352
2271
  ### `equity.fundamental.management_discussion_analysis`
1353
2272
 
1354
2273
  ```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')
2274
+ data.equity.fundamental.management_discussion_analysis(symbol=..., calendar_year=None, calendar_period=None, include_tables=True, use_cache=True, raw_html=False)
1356
2275
  ```
1357
2276
 
1358
2277
  Summary: Management Discussion Analysis
@@ -1362,7 +2281,6 @@ Summary: Management Discussion Analysis
1362
2281
  | Endpoint ID | `equity.fundamental.management_discussion_analysis` |
1363
2282
  | HTTP | `GET` |
1364
2283
  | Path | `/inner/v1/agent-data/equity/fundamental/management_discussion_analysis` |
1365
- | Default provider | `sec` |
1366
2284
  | SDK | `supported` |
1367
2285
  | Host | `supported` |
1368
2286
  | Notes | - |
@@ -1374,17 +2292,16 @@ Summary: Management Discussion Analysis
1374
2292
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1375
2293
  | `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
2294
  | `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` | - |
2295
+ | `include_tables` | `no` | `boolean` | `true` | Return tables formatted as markdown in the text. Default is True. |
2296
+ | `use_cache` | `no` | `boolean` | `true` | When True, the file will be cached for use later. Default is True. |
2297
+ | `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
2298
 
1382
2299
  ---
1383
2300
 
1384
2301
  ### `equity.fundamental.metrics`
1385
2302
 
1386
2303
  ```python
1387
- data.equity.fundamental.metrics(symbol=..., ttm='only', period='annual', limit=None, provider=...)
2304
+ data.equity.fundamental.metrics(symbol=..., ttm='only', period='annual', limit=None)
1388
2305
  ```
1389
2306
 
1390
2307
  Summary: Metrics
@@ -1394,7 +2311,6 @@ Summary: Metrics
1394
2311
  | Endpoint ID | `equity.fundamental.metrics` |
1395
2312
  | HTTP | `GET` |
1396
2313
  | Path | `/inner/v1/agent-data/equity/fundamental/metrics` |
1397
- | Default provider | - |
1398
2314
  | SDK | `supported` |
1399
2315
  | Host | `supported` |
1400
2316
  | Notes | - |
@@ -1403,18 +2319,52 @@ Summary: Metrics
1403
2319
 
1404
2320
  | Param | Required | Type | Default | Notes |
1405
2321
  |---|---|---|---|---|
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 |
2322
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
2323
+ | `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'. |
2324
+ | `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'. |
2325
+ | `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. |
2326
+
2327
+ #### Response fields
2328
+
2329
+ | Field | Type | Notes |
2330
+ |---|---|---|
2331
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2332
+ | `period_ending` | `string` | End date of the reporting period. |
2333
+ | `fiscal_year` | `integer` | Fiscal year for the fiscal period, if available. |
2334
+ | `fiscal_period` | `string` | Fiscal period for the data, if available. |
2335
+ | `currency` | `string` | Currency in which the data is reported. |
2336
+ | `market_cap` | `integer` | Market capitalization. |
2337
+ | `enterprise_value` | `integer` | Enterprise Value. |
2338
+ | `ev_to_sales` | `number` | Enterprise Value to Sales ratio. |
2339
+ | `current_ratio` | `number` | Current Ratio. |
2340
+ | `return_on_assets` | `number` | Return on Assets. |
2341
+ | `return_on_equity` | `number` | Return on Equity. |
2342
+ | `return_on_invested_capital` | `number` | Return on Invested Capital. |
2343
+ | `pe_ratio` | `number` | Price-to-earnings ratio (TTM). |
2344
+ | `price_to_book` | `number` | Price to book ratio. |
2345
+ | `price_to_revenue` | `number` | Price to revenue ratio. |
2346
+ | `quick_ratio` | `number` | Quick ratio. |
2347
+ | `gross_margin` | `number` | Gross margin, as a normalized percent. |
2348
+ | `profit_margin` | `number` | Profit margin, as a normalized percent. |
2349
+ | `eps` | `number` | Basic earnings per share. |
2350
+ | `ebitda` | `integer` | Earnings before interest, taxes, depreciation, and amortization. |
2351
+ | `ebit` | `integer` | Earnings before interest and taxes. |
2352
+ | `total_debt` | `integer` | Total debt. |
2353
+ | `altman_z_score` | `number` | Altman Z-score. |
2354
+ | `beta` | `number` | Beta relative to the broad market (rolling three-year). |
2355
+ | `dividend_yield` | `number` | Dividend yield, as a normalized percent. |
2356
+ | `last_price` | `number` | Last price of the stock. |
2357
+ | `year_high` | `number` | 52 week high. |
2358
+ | `year_low` | `number` | 52 week low. |
2359
+ | `forward_pe` | `number` | Forward price-to-earnings ratio. |
2360
+ | `peg_ratio` | `number` | PEG ratio (5-year expected). |
1411
2361
 
1412
2362
  ---
1413
2363
 
1414
2364
  ### `equity.fundamental.ratios`
1415
2365
 
1416
2366
  ```python
1417
- data.equity.fundamental.ratios(symbol=..., limit=None, ttm='only', period='annual', fiscal_year=None, provider=...)
2367
+ data.equity.fundamental.ratios(symbol=..., limit=None, ttm='only', period='annual', fiscal_year=None)
1418
2368
  ```
1419
2369
 
1420
2370
  Summary: Ratios
@@ -1424,7 +2374,6 @@ Summary: Ratios
1424
2374
  | Endpoint ID | `equity.fundamental.ratios` |
1425
2375
  | HTTP | `GET` |
1426
2376
  | Path | `/inner/v1/agent-data/equity/fundamental/ratios` |
1427
- | Default provider | - |
1428
2377
  | SDK | `supported` |
1429
2378
  | Host | `supported` |
1430
2379
  | Notes | - |
@@ -1433,19 +2382,43 @@ Summary: Ratios
1433
2382
 
1434
2383
  | Param | Required | Type | Default | Notes |
1435
2384
  |---|---|---|---|---|
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 |
2385
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
2386
+ | `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. |
2387
+ | `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'. |
2388
+ | `period` | `no` | `string` | `annual` | Specify the fiscal period for the data.; Time period of the data to return. |
2389
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
2390
+
2391
+ #### Response fields
2392
+
2393
+ | Field | Type | Notes |
2394
+ |---|---|---|
2395
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2396
+ | `period_ending` | `string` | The date of the data. |
2397
+ | `fiscal_period` | `string` | Period of the financial ratios. |
2398
+ | `fiscal_year` | `integer` | Fiscal year. |
2399
+ | `currency` | `string` | Currency in which the company reports financials. |
2400
+ | `grossProfitMarginTTM` | `number` | Gross profit margin. |
2401
+ | `ebitMarginTTM` | `number` | Earnings before interest and taxes (EBIT) margin. |
2402
+ | `ebitdaMarginTTM` | `number` | Earnings before interest, taxes, depreciation, and amortization (EBITDA) margin. |
2403
+ | `operatingProfitMarginTTM` | `number` | Operating profit margin. |
2404
+ | `netProfitMarginTTM` | `number` | Net profit margin. |
2405
+ | `priceToEarningsRatioTTM` | `number` | Price to earnings (P/E) ratio. |
2406
+ | `priceToBookRatioTTM` | `number` | Price to book (P/B) ratio. |
2407
+ | `priceToSalesRatioTTM` | `number` | Price to sales (P/S) ratio. |
2408
+ | `debtToEquityRatioTTM` | `number` | Debt to equity ratio. |
2409
+ | `currentRatioTTM` | `number` | Current ratio. |
2410
+ | `dividendYieldTTM` | `number` | Dividend yield. |
2411
+ | `dividendPerShareTTM` | `number` | Dividend per share. |
2412
+ | `revenuePerShareTTM` | `number` | Revenue per share. |
2413
+ | `bookValuePerShareTTM` | `number` | Book value per share. |
2414
+ | `freeCashFlowPerShareTTM` | `number` | Free cash flow per share. |
1442
2415
 
1443
2416
  ---
1444
2417
 
1445
2418
  ### `equity.fundamental.reported_financials`
1446
2419
 
1447
2420
  ```python
1448
- data.equity.fundamental.reported_financials(symbol=..., period='annual', statement_type='balance', limit=100, fiscal_year=None, provider='intrinio')
2421
+ data.equity.fundamental.reported_financials(symbol=..., period='annual', statement_type='balance', limit=100, fiscal_year=None)
1449
2422
  ```
1450
2423
 
1451
2424
  Summary: Reported Financials
@@ -1455,7 +2428,6 @@ Summary: Reported Financials
1455
2428
  | Endpoint ID | `equity.fundamental.reported_financials` |
1456
2429
  | HTTP | `GET` |
1457
2430
  | Path | `/inner/v1/agent-data/equity/fundamental/reported_financials` |
1458
- | Default provider | `intrinio` |
1459
2431
  | SDK | `supported` |
1460
2432
  | Host | `supported` |
1461
2433
  | Notes | - |
@@ -1466,17 +2438,24 @@ Summary: Reported Financials
1466
2438
  |---|---|---|---|---|
1467
2439
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1468
2440
  | `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) |
2441
+ | `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
2442
  | `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` | - |
2443
+ | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
2444
+
2445
+ #### Response fields
2446
+
2447
+ | Field | Type | Notes |
2448
+ |---|---|---|
2449
+ | `period_ending` | `string` | The ending date of the reporting period. |
2450
+ | `fiscal_period` | `string` | The fiscal period of the report (e.g. FY, Q1, etc.). |
2451
+ | `fiscal_year` | `integer` | The fiscal year of the fiscal period. |
1473
2452
 
1474
2453
  ---
1475
2454
 
1476
2455
  ### `equity.fundamental.revenue_per_geography`
1477
2456
 
1478
2457
  ```python
1479
- data.equity.fundamental.revenue_per_geography(symbol=..., period='annual', provider='fmp')
2458
+ data.equity.fundamental.revenue_per_geography(symbol=..., period='annual')
1480
2459
  ```
1481
2460
 
1482
2461
  Summary: Revenue Per Geography
@@ -1486,7 +2465,6 @@ Summary: Revenue Per Geography
1486
2465
  | Endpoint ID | `equity.fundamental.revenue_per_geography` |
1487
2466
  | HTTP | `GET` |
1488
2467
  | Path | `/inner/v1/agent-data/equity/fundamental/revenue_per_geography` |
1489
- | Default provider | `fmp` |
1490
2468
  | SDK | `supported` |
1491
2469
  | Host | `supported` |
1492
2470
  | Notes | - |
@@ -1496,15 +2474,25 @@ Summary: Revenue Per Geography
1496
2474
  | Param | Required | Type | Default | Notes |
1497
2475
  |---|---|---|---|---|
1498
2476
  | `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` | - |
2477
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
2478
+
2479
+ #### Response fields
2480
+
2481
+ | Field | Type | Notes |
2482
+ |---|---|---|
2483
+ | `period_ending` | `string` | The end date of the reporting period. |
2484
+ | `fiscal_period` | `string` | The fiscal period of the reporting period. |
2485
+ | `fiscal_year` | `integer` | The fiscal year of the reporting period. |
2486
+ | `filing_date` | `string` | The filing date of the report. |
2487
+ | `region` | `string` | The region represented by the revenue data. |
2488
+ | `revenue` | `integer` | The total revenue attributed to the region. |
1501
2489
 
1502
2490
  ---
1503
2491
 
1504
2492
  ### `equity.fundamental.revenue_per_segment`
1505
2493
 
1506
2494
  ```python
1507
- data.equity.fundamental.revenue_per_segment(symbol=..., period='annual', provider='fmp')
2495
+ data.equity.fundamental.revenue_per_segment(symbol=..., period='annual')
1508
2496
  ```
1509
2497
 
1510
2498
  Summary: Revenue Per Segment
@@ -1514,7 +2502,6 @@ Summary: Revenue Per Segment
1514
2502
  | Endpoint ID | `equity.fundamental.revenue_per_segment` |
1515
2503
  | HTTP | `GET` |
1516
2504
  | Path | `/inner/v1/agent-data/equity/fundamental/revenue_per_segment` |
1517
- | Default provider | `fmp` |
1518
2505
  | SDK | `supported` |
1519
2506
  | Host | `supported` |
1520
2507
  | Notes | - |
@@ -1524,15 +2511,25 @@ Summary: Revenue Per Segment
1524
2511
  | Param | Required | Type | Default | Notes |
1525
2512
  |---|---|---|---|---|
1526
2513
  | `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` | - |
2514
+ | `period` | `no` | `string` | `annual` | Time period of the data to return. |
2515
+
2516
+ #### Response fields
2517
+
2518
+ | Field | Type | Notes |
2519
+ |---|---|---|
2520
+ | `period_ending` | `string` | The end date of the reporting period. |
2521
+ | `fiscal_period` | `string` | The fiscal period of the reporting period. |
2522
+ | `fiscal_year` | `integer` | The fiscal year of the reporting period. |
2523
+ | `filing_date` | `string` | The filing date of the report. |
2524
+ | `business_line` | `string` | The business line represented by the revenue data. |
2525
+ | `revenue` | `integer` | The total revenue attributed to the business line. |
1529
2526
 
1530
2527
  ---
1531
2528
 
1532
2529
  ### `equity.fundamental.search_attributes`
1533
2530
 
1534
2531
  ```python
1535
- data.equity.fundamental.search_attributes(query=..., limit=1000, provider='intrinio')
2532
+ data.equity.fundamental.search_attributes(query=..., limit=1000)
1536
2533
  ```
1537
2534
 
1538
2535
  Summary: Search Attributes
@@ -1542,7 +2539,6 @@ Summary: Search Attributes
1542
2539
  | Endpoint ID | `equity.fundamental.search_attributes` |
1543
2540
  | HTTP | `GET` |
1544
2541
  | Path | `/inner/v1/agent-data/equity/fundamental/search_attributes` |
1545
- | Default provider | `intrinio` |
1546
2542
  | SDK | `supported` |
1547
2543
  | Host | `supported` |
1548
2544
  | Notes | - |
@@ -1553,14 +2549,29 @@ Summary: Search Attributes
1553
2549
  |---|---|---|---|---|
1554
2550
  | `query` | `yes` | `string` | `-` | Query to search for. |
1555
2551
  | `limit` | `no` | `integer | null` | `1000` | The number of data entries to return. |
1556
- | `provider` | `no` | `string` | `intrinio` | - |
2552
+
2553
+ #### Response fields
2554
+
2555
+ | Field | Type | Notes |
2556
+ |---|---|---|
2557
+ | `id` | `string` | ID of the financial attribute. |
2558
+ | `name` | `string` | Name of the financial attribute. |
2559
+ | `tag` | `string` | Tag of the financial attribute. |
2560
+ | `statement_code` | `string` | Code of the financial statement. |
2561
+ | `statement_type` | `string` | Type of the financial statement. |
2562
+ | `parent_name` | `string` | Parent's name of the financial attribute. |
2563
+ | `sequence` | `integer` | Sequence of the financial statement. |
2564
+ | `factor` | `string` | Unit of the financial attribute. |
2565
+ | `transaction` | `string` | Transaction type (credit/debit) of the financial attribute. |
2566
+ | `type` | `string` | Type of the financial attribute. |
2567
+ | `unit` | `string` | Unit of the financial attribute. |
1557
2568
 
1558
2569
  ---
1559
2570
 
1560
2571
  ### `equity.fundamental.trailing_dividend_yield`
1561
2572
 
1562
2573
  ```python
1563
- data.equity.fundamental.trailing_dividend_yield(symbol=..., limit=252, provider='tiingo')
2574
+ data.equity.fundamental.trailing_dividend_yield(symbol=..., limit=252)
1564
2575
  ```
1565
2576
 
1566
2577
  Summary: Trailing Dividend Yield
@@ -1570,7 +2581,6 @@ Summary: Trailing Dividend Yield
1570
2581
  | Endpoint ID | `equity.fundamental.trailing_dividend_yield` |
1571
2582
  | HTTP | `GET` |
1572
2583
  | Path | `/inner/v1/agent-data/equity/fundamental/trailing_dividend_yield` |
1573
- | Default provider | `tiingo` |
1574
2584
  | SDK | `supported` |
1575
2585
  | Host | `supported` |
1576
2586
  | Notes | - |
@@ -1581,14 +2591,20 @@ Summary: Trailing Dividend Yield
1581
2591
  |---|---|---|---|---|
1582
2592
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1583
2593
  | `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` | - |
2594
+
2595
+ #### Response fields
2596
+
2597
+ | Field | Type | Notes |
2598
+ |---|---|---|
2599
+ | `date` | `string` | The date of the data. |
2600
+ | `trailing_dividend_yield` | `number` | Trailing dividend yield. |
1585
2601
 
1586
2602
  ---
1587
2603
 
1588
2604
  ### `equity.fundamental.transcript`
1589
2605
 
1590
2606
  ```python
1591
- data.equity.fundamental.transcript(symbol=..., year=None, quarter=None, provider='fmp')
2607
+ data.equity.fundamental.transcript(symbol=..., year=None, quarter=None)
1592
2608
  ```
1593
2609
 
1594
2610
  Summary: Transcript
@@ -1598,7 +2614,6 @@ Summary: Transcript
1598
2614
  | Endpoint ID | `equity.fundamental.transcript` |
1599
2615
  | HTTP | `GET` |
1600
2616
  | Path | `/inner/v1/agent-data/equity/fundamental/transcript` |
1601
- | Default provider | `fmp` |
1602
2617
  | SDK | `supported` |
1603
2618
  | Host | `supported` |
1604
2619
  | Notes | - |
@@ -1610,14 +2625,13 @@ Summary: Transcript
1610
2625
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1611
2626
  | `year` | `no` | `integer | null` | `-` | Year of the earnings call transcript. |
1612
2627
  | `quarter` | `no` | `integer | null` | `-` | Quarterly period of the earnings call transcript. |
1613
- | `provider` | `no` | `string` | `fmp` | - |
1614
2628
 
1615
2629
  ---
1616
2630
 
1617
2631
  ### `equity.historical_market_cap`
1618
2632
 
1619
2633
  ```python
1620
- data.equity.historical_market_cap(symbol=..., start_time=None, end_time=None, interval='day', provider=...)
2634
+ data.equity.historical_market_cap(symbol=..., start_time=None, end_time=None, interval='day')
1621
2635
  ```
1622
2636
 
1623
2637
  Summary: Historical Market Cap
@@ -1627,7 +2641,6 @@ Summary: Historical Market Cap
1627
2641
  | Endpoint ID | `equity.historical_market_cap` |
1628
2642
  | HTTP | `GET` |
1629
2643
  | Path | `/inner/v1/agent-data/equity/historical_market_cap` |
1630
- | Default provider | - |
1631
2644
  | SDK | `supported` |
1632
2645
  | Host | `supported` |
1633
2646
  | Notes | - |
@@ -1636,18 +2649,25 @@ Summary: Historical Market Cap
1636
2649
 
1637
2650
  | Param | Required | Type | Default | Notes |
1638
2651
  |---|---|---|---|---|
1639
- | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp, intrinio. |
2652
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1640
2653
  | `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
2654
  | `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
2655
  | `interval` | `no` | `string` | `day` | enum: day, week, month, quarter, year None |
1643
- | `provider` | `yes` | `string` | `-` | enum: fmp, intrinio |
2656
+
2657
+ #### Response fields
2658
+
2659
+ | Field | Type | Notes |
2660
+ |---|---|---|
2661
+ | `date` | `string` | The date of the data. |
2662
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2663
+ | `market_cap` | `integer` | Market capitalization of the security. |
1644
2664
 
1645
2665
  ---
1646
2666
 
1647
2667
  ### `equity.market_snapshots`
1648
2668
 
1649
2669
  ```python
1650
- data.equity.market_snapshots(market='nasdaq', date=None, provider=...)
2670
+ data.equity.market_snapshots(market='nasdaq', date=None)
1651
2671
  ```
1652
2672
 
1653
2673
  Summary: Market Snapshots
@@ -1657,7 +2677,6 @@ Summary: Market Snapshots
1657
2677
  | Endpoint ID | `equity.market_snapshots` |
1658
2678
  | HTTP | `GET` |
1659
2679
  | Path | `/inner/v1/agent-data/equity/market_snapshots` |
1660
- | Default provider | - |
1661
2680
  | SDK | `supported` |
1662
2681
  | Host | `supported` |
1663
2682
  | Notes | - |
@@ -1666,16 +2685,45 @@ Summary: Market Snapshots
1666
2685
 
1667
2686
  | Param | Required | Type | Default | Notes |
1668
2687
  |---|---|---|---|---|
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 |
2688
+ | `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. |
2689
+ | `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' |
2690
+
2691
+ #### Response fields
2692
+
2693
+ | Field | Type | Notes |
2694
+ |---|---|---|
2695
+ | `exchange` | `string` | Exchange the security is listed on. |
2696
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2697
+ | `name` | `string` | Name of the company, fund, or security. |
2698
+ | `open` | `number` | The open price. |
2699
+ | `high` | `number` | The high price. |
2700
+ | `low` | `number` | The low price. |
2701
+ | `close` | `number` | The close price. |
2702
+ | `volume` | `integer` | The trading volume. |
2703
+ | `prev_close` | `number` | The previous close price. |
2704
+ | `change` | `number` | The change in price from the previous close. |
2705
+ | `change_percent` | `number` | The change in price from the previous close, as a normalized percent. |
2706
+ | `last_price` | `number` | The last trade price. |
2707
+ | `last_size` | `integer` | The last trade size. |
2708
+ | `last_volume` | `integer` | The last trade volume. |
2709
+ | `last_trade_timestamp` | `string` | The timestamp of the last trade. |
2710
+ | `bid_size` | `integer` | The size of the last bid price. |
2711
+ | `bid_price` | `number` | The last bid price. |
2712
+ | `ask_price` | `number` | The last ask price. |
2713
+ | `ask_size` | `integer` | The size of the last ask price. |
2714
+ | `ma_50` | `number` | The 50-day moving average. |
2715
+ | `ma_200` | `number` | The 200-day moving average. |
2716
+ | `year_high` | `number` | The 52-week high. |
2717
+ | `year_low` | `number` | The 52-week low. |
2718
+ | `market_cap` | `integer` | Market cap of the stock. |
2719
+ | `last_price_timestamp` | `string` | The timestamp of the last price. |
1672
2720
 
1673
2721
  ---
1674
2722
 
1675
2723
  ### `equity.ownership.form_13f`
1676
2724
 
1677
2725
  ```python
1678
- data.equity.ownership.form_13f(symbol=..., date=None, limit=1, provider='sec')
2726
+ data.equity.ownership.form_13f(symbol=..., date=None, limit=1)
1679
2727
  ```
1680
2728
 
1681
2729
  Summary: Form 13F
@@ -1685,7 +2733,6 @@ Summary: Form 13F
1685
2733
  | Endpoint ID | `equity.ownership.form_13f` |
1686
2734
  | HTTP | `GET` |
1687
2735
  | Path | `/inner/v1/agent-data/equity/ownership/form_13f` |
1688
- | Default provider | `sec` |
1689
2736
  | SDK | `supported` |
1690
2737
  | Host | `supported` |
1691
2738
  | Notes | - |
@@ -1697,14 +2744,31 @@ Summary: Form 13F
1697
2744
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. A CIK can be used. |
1698
2745
  | `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
2746
  | `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` | - |
2747
+
2748
+ #### Response fields
2749
+
2750
+ | Field | Type | Notes |
2751
+ |---|---|---|
2752
+ | `period_ending` | `string` | The end-of-quarter date of the filing. |
2753
+ | `issuer` | `string` | The name of the issuer. |
2754
+ | `cusip` | `string` | The CUSIP of the security. |
2755
+ | `asset_class` | `string` | The title of the asset class for the security. |
2756
+ | `security_type` | `string` | Whether the principal amount represents the number of shares or the principal amount of such class. |
2757
+ | `option_type` | `string` | Defined when the holdings being reported are put or call options. |
2758
+ | `investment_discretion` | `string` | The investment discretion held by the Manager. |
2759
+ | `voting_authority_sole` | `integer` | The number of shares for which the Manager exercises sole voting authority. |
2760
+ | `voting_authority_shared` | `integer` | The number of shares for which the Manager exercises a defined shared voting authority. |
2761
+ | `voting_authority_none` | `integer` | The number of shares for which the Manager exercises no voting authority. |
2762
+ | `principal_amount` | `integer` | The total number of shares of the class of security or the principal amount of such class. |
2763
+ | `value` | `integer` | The fair market value of the holding of the particular class of security. |
2764
+ | `weight` | `number` | The weight of the security relative to the market value of all securities in the filing, as a normalized percent. |
1701
2765
 
1702
2766
  ---
1703
2767
 
1704
2768
  ### `equity.ownership.government_trades`
1705
2769
 
1706
2770
  ```python
1707
- data.equity.ownership.government_trades(symbol=None, chamber='all', limit=None, provider='fmp')
2771
+ data.equity.ownership.government_trades(symbol=None, chamber='all', limit=None)
1708
2772
  ```
1709
2773
 
1710
2774
  Summary: Government Trades
@@ -1714,7 +2778,6 @@ Summary: Government Trades
1714
2778
  | Endpoint ID | `equity.ownership.government_trades` |
1715
2779
  | HTTP | `GET` |
1716
2780
  | Path | `/inner/v1/agent-data/equity/ownership/government_trades` |
1717
- | Default provider | `fmp` |
1718
2781
  | SDK | `supported` |
1719
2782
  | Host | `supported` |
1720
2783
  | Notes | - |
@@ -1723,17 +2786,33 @@ Summary: Government Trades
1723
2786
 
1724
2787
  | Param | Required | Type | Default | Notes |
1725
2788
  |---|---|---|---|---|
1726
- | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed for provider(s): fmp. |
2789
+ | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1727
2790
  | `chamber` | `no` | `string` | `all` | Government Chamber. |
1728
2791
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1729
- | `provider` | `no` | `string` | `fmp` | - |
2792
+
2793
+ #### Response fields
2794
+
2795
+ | Field | Type | Notes |
2796
+ |---|---|---|
2797
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2798
+ | `date` | `string` | The date of the data. |
2799
+ | `transaction_date` | `string` | Date of Transaction. |
2800
+ | `representative` | `string` | Name of Representative. |
2801
+ | `chamber` | `string` | Government Chamber - House or Senate. |
2802
+ | `owner` | `string` | Ownership status (e.g., Spouse, Joint). |
2803
+ | `asset_type` | `string` | Type of asset involved in the transaction. |
2804
+ | `asset_description` | `string` | Description of the asset. |
2805
+ | `transaction_type` | `string` | Type of transaction (e.g., Sale, Purchase). |
2806
+ | `amount` | `string` | Transaction amount range. |
2807
+ | `comment` | `string` | Additional comments on the transaction. |
2808
+ | `url` | `string` | Link to the transaction document. |
1730
2809
 
1731
2810
  ---
1732
2811
 
1733
2812
  ### `equity.ownership.insider_trading`
1734
2813
 
1735
2814
  ```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=...)
2815
+ 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
2816
  ```
1738
2817
 
1739
2818
  Summary: Insider Trading
@@ -1743,7 +2822,6 @@ Summary: Insider Trading
1743
2822
  | Endpoint ID | `equity.ownership.insider_trading` |
1744
2823
  | HTTP | `GET` |
1745
2824
  | Path | `/inner/v1/agent-data/equity/ownership/insider_trading` |
1746
- | Default provider | - |
1747
2825
  | SDK | `supported` |
1748
2826
  | Host | `supported` |
1749
2827
  | Notes | - |
@@ -1756,20 +2834,42 @@ Summary: Insider Trading
1756
2834
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1757
2835
  | `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
2836
  | `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 |
2837
+ | `transaction_type` | `no` | `string | null` | `-` | Type of the transaction. |
2838
+ | `statistics` | `no` | `boolean` | `false` | Flag to return summary statistics for the given symbol. Setting as True will ignore other parameters except symbol. |
2839
+ | `ownership_type` | `no` | `string | null` | `-` | Type of ownership. |
2840
+ | `sort_by` | `no` | `string | null` | `updated_on` | Field to sort by. |
2841
+ | `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. |
2842
+ | `summary` | `no` | `boolean` | `false` | Return a summary of the insider activity instead of the individuals. |
2843
+
2844
+ #### Response fields
2845
+
2846
+ | Field | Type | Notes |
2847
+ |---|---|---|
2848
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2849
+ | `company_cik` | `string` | CIK number of the company. |
2850
+ | `filing_date` | `string` | Filing date of the trade. |
2851
+ | `transaction_date` | `string` | Date of the transaction. |
2852
+ | `owner_cik` | `integer` | Reporting individual's CIK. |
2853
+ | `owner_name` | `string` | Name of the reporting individual. |
2854
+ | `owner_title` | `string` | The title held by the reporting individual. |
2855
+ | `ownership_type` | `string` | Type of ownership, direct or indirect. |
2856
+ | `transaction_type` | `string` | Type of transaction being reported. |
2857
+ | `acquisition_or_disposition` | `string` | Acquisition or disposition of the shares. |
2858
+ | `security_type` | `string` | The type of security transacted. |
2859
+ | `securities_owned` | `number` | Number of securities owned by the reporting individual. |
2860
+ | `securities_transacted` | `number` | Number of securities transacted by the reporting individual. |
2861
+ | `transaction_price` | `number` | The price of the transaction. |
2862
+ | `filing_url` | `string` | Link to the filing. |
2863
+ | `company_name` | `string` | Name of the company. |
2864
+ | `form` | `string` | Form type. |
2865
+ | `transaction_value` | `number` | Total value of the transaction. |
1766
2866
 
1767
2867
  ---
1768
2868
 
1769
2869
  ### `equity.ownership.institutional`
1770
2870
 
1771
2871
  ```python
1772
- data.equity.ownership.institutional(symbol=..., year=None, quarter=None, provider='fmp')
2872
+ data.equity.ownership.institutional(symbol=..., year=None, quarter=None)
1773
2873
  ```
1774
2874
 
1775
2875
  Summary: Institutional
@@ -1779,7 +2879,6 @@ Summary: Institutional
1779
2879
  | Endpoint ID | `equity.ownership.institutional` |
1780
2880
  | HTTP | `GET` |
1781
2881
  | Path | `/inner/v1/agent-data/equity/ownership/institutional` |
1782
- | Default provider | `fmp` |
1783
2882
  | SDK | `supported` |
1784
2883
  | Host | `supported` |
1785
2884
  | Notes | - |
@@ -1788,17 +2887,35 @@ Summary: Institutional
1788
2887
 
1789
2888
  | Param | Required | Type | Default | Notes |
1790
2889
  |---|---|---|---|---|
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` | - |
2890
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
2891
+ | `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. |
2892
+ | `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. |
2893
+
2894
+ #### Response fields
2895
+
2896
+ | Field | Type | Notes |
2897
+ |---|---|---|
2898
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2899
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
2900
+ | `date` | `string` | The date of the data. |
2901
+ | `investors_holding` | `integer` | Number of investors holding the stock. |
2902
+ | `last_investors_holding` | `integer` | Number of investors holding the stock in the last quarter. |
2903
+ | `investors_holding_change` | `integer` | Change in the number of investors holding the stock. |
2904
+ | `number_of_13f_shares` | `integer` | Number of 13F shares. |
2905
+ | `total_invested` | `number` | Total amount invested. |
2906
+ | `ownership_percent` | `number` | Ownership percent. |
2907
+ | `new_positions` | `integer` | Number of new positions. |
2908
+ | `increased_positions` | `integer` | Number of increased positions. |
2909
+ | `closed_positions` | `integer` | Number of closed positions. |
2910
+ | `reduced_positions` | `integer` | Number of reduced positions. |
2911
+ | `put_call_ratio` | `number` | Put-call ratio. |
1795
2912
 
1796
2913
  ---
1797
2914
 
1798
2915
  ### `equity.ownership.major_holders`
1799
2916
 
1800
2917
  ```python
1801
- data.equity.ownership.major_holders(symbol=..., year=None, quarter=None, page=None, limit=None, provider='fmp')
2918
+ data.equity.ownership.major_holders(symbol=..., year=None, quarter=None, page=None, limit=None)
1802
2919
  ```
1803
2920
 
1804
2921
  Summary: Major Holders
@@ -1808,7 +2925,6 @@ Summary: Major Holders
1808
2925
  | Endpoint ID | `equity.ownership.major_holders` |
1809
2926
  | HTTP | `GET` |
1810
2927
  | Path | `/inner/v1/agent-data/equity/ownership/major_holders` |
1811
- | Default provider | `fmp` |
1812
2928
  | SDK | `supported` |
1813
2929
  | Host | `supported` |
1814
2930
  | Notes | - |
@@ -1818,18 +2934,41 @@ Summary: Major Holders
1818
2934
  | Param | Required | Type | Default | Notes |
1819
2935
  |---|---|---|---|---|
1820
2936
  | `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` | - |
2937
+ | `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. |
2938
+ | `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. |
2939
+ | `page` | `no` | `integer | null` | `-` | Page number, used in conjunction with the limit. The default is 0. |
2940
+ | `limit` | `no` | `integer | null` | `-` | Number of items to return per page. The default is 100, which is the maximum. |
2941
+
2942
+ #### Response fields
2943
+
2944
+ | Field | Type | Notes |
2945
+ |---|---|---|
2946
+ | `investor_name` | `string` | Investing entity's name. |
2947
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
2948
+ | `date` | `string` | The date of the data. For the period ending. |
2949
+ | `filing_date` | `string` | Date when reported. |
2950
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2951
+ | `security_name` | `string` | Security name. |
2952
+ | `security_type` | `string` | Type or class of security. |
2953
+ | `security_cusip` | `string` | CUSIP of the security. |
2954
+ | `weight` | `number` | Weight relative to the total reported portfolio. |
2955
+ | `market_value` | `integer` | Market value of the stock ownership. |
2956
+ | `shares_number` | `integer` | Number of controlled shares. |
2957
+ | `shares_change` | `number` | Change in shares number from the previous quarter. |
2958
+ | `is_new` | `boolean` | If the security was newly added this quarter. |
2959
+ | `is_sold_out` | `boolean` | If the security was sold out this quarter. |
2960
+ | `ownership` | `number` | Ownership stake in the security, as a percent. |
2961
+ | `avg_price_paid` | `number` | Average price paid for the shares. |
2962
+ | `holding_period` | `integer` | Holding period of the security. |
2963
+ | `first_added` | `string` | When the security was first reported as held. |
2964
+ | `performance` | `number` | Performance value of the security holding. |
1826
2965
 
1827
2966
  ---
1828
2967
 
1829
2968
  ### `equity.ownership.share_statistics`
1830
2969
 
1831
2970
  ```python
1832
- data.equity.ownership.share_statistics(symbol=..., provider=...)
2971
+ data.equity.ownership.share_statistics(symbol=...)
1833
2972
  ```
1834
2973
 
1835
2974
  Summary: Share Statistics
@@ -1839,7 +2978,6 @@ Summary: Share Statistics
1839
2978
  | Endpoint ID | `equity.ownership.share_statistics` |
1840
2979
  | HTTP | `GET` |
1841
2980
  | Path | `/inner/v1/agent-data/equity/ownership/share_statistics` |
1842
- | Default provider | - |
1843
2981
  | SDK | `supported` |
1844
2982
  | Host | `supported` |
1845
2983
  | Notes | - |
@@ -1848,15 +2986,34 @@ Summary: Share Statistics
1848
2986
 
1849
2987
  | Param | Required | Type | Default | Notes |
1850
2988
  |---|---|---|---|---|
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 |
2989
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
2990
+
2991
+ #### Response fields
2992
+
2993
+ | Field | Type | Notes |
2994
+ |---|---|---|
2995
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
2996
+ | `date` | `string` | The date of the data. |
2997
+ | `free_float` | `number` | Percentage of unrestricted shares of a publicly-traded company. |
2998
+ | `float_shares` | `integer` | Number of shares available for trading by the general public. |
2999
+ | `outstanding_shares` | `integer` | Total number of shares of a publicly-traded company. |
3000
+ | `adjusted_outstanding_shares` | `number` | Total number of shares of a publicly-traded company, adjusted for splits. |
3001
+ | `public_float` | `number` | Aggregate market value of the shares of a publicly-traded company. |
3002
+ | `url` | `string` | URL to the source document, if available. |
3003
+ | `implied_shares_outstanding` | `integer` | Implied Shares Outstanding of common equity. |
3004
+ | `short_interest` | `integer` | Number of shares that are reported short. |
3005
+ | `short_percent_of_float` | `number` | Percentage of shares that are reported short, as a normalized percent. |
3006
+ | `days_to_cover` | `number` | Number of days to repurchase the shares as a ratio of average daily volume. |
3007
+ | `insider_ownership` | `number` | Percentage of shares held by insiders, as a normalized percent. |
3008
+ | `institution_ownership` | `number` | Percentage of shares held by institutions, as a normalized percent. |
3009
+ | `institutions_count` | `integer` | Number of institutions holding shares. |
1853
3010
 
1854
3011
  ---
1855
3012
 
1856
3013
  ### `equity.price.historical`
1857
3014
 
1858
3015
  ```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=...)
3016
+ 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
3017
  ```
1861
3018
 
1862
3019
  Summary: Historical
@@ -1866,7 +3023,6 @@ Summary: Historical
1866
3023
  | Endpoint ID | `equity.price.historical` |
1867
3024
  | HTTP | `GET` |
1868
3025
  | Path | `/inner/v1/agent-data/equity/price/historical` |
1869
- | Default provider | - |
1870
3026
  | SDK | `supported` |
1871
3027
  | Host | `supported` |
1872
3028
  | Notes | - |
@@ -1875,28 +3031,48 @@ Summary: Historical
1875
3031
 
1876
3032
  | Param | Required | Type | Default | Notes |
1877
3033
  |---|---|---|---|---|
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) |
3034
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). |
1879
3035
  | `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
3036
  | `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 |
3037
+ | `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. |
3038
+ | `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. |
3039
+ | `adjust` | `no` | `string` | `qfq` | enum: , qfq, hfq Price adjustment method. '' for unadjusted, 'qfq' for forward-adjusted (前复权), 'hfq' for backward-adjusted (后复权). |
3040
+ | `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. |
3041
+ | `extended_hours` | `no` | `boolean` | `false` | Include Pre and Post market data. |
3042
+ | `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. |
3043
+ | `start_clock_time` | `no` | `string | null` | `-` | Return intervals starting at the specified time on the `start_date` formatted as 'HH:MM:SS'. |
3044
+ | `end_clock_time` | `no` | `string | null` | `-` | Return intervals stopping at the specified time on the `end_date` formatted as 'HH:MM:SS'. |
3045
+ | `timezone` | `no` | `string | null` | `America/New_York` | Timezone of the data, in the IANA format (Continent/City). |
3046
+ | `source` | `no` | `string` | `realtime` | enum: realtime, delayed, nasdaq_basic The source of the data. |
3047
+ | `include_actions` | `no` | `boolean` | `true` | Include dividends and stock splits in results. |
3048
+
3049
+ #### Response fields
3050
+
3051
+ | Field | Type | Notes |
3052
+ |---|---|---|
3053
+ | `date` | `string` | The date of the data. |
3054
+ | `open` | `number` | The open price. |
3055
+ | `high` | `number` | The high price. |
3056
+ | `low` | `number` | The low price. |
3057
+ | `close` | `number` | The close price. |
3058
+ | `volume` | `number` | The trading volume. |
3059
+ | `vwap` | `number` | Volume Weighted Average Price over the period. |
3060
+ | `adj_open` | `number` | The adjusted open price. |
3061
+ | `adj_high` | `number` | The adjusted high price. |
3062
+ | `adj_low` | `number` | The adjusted low price. |
3063
+ | `adj_close` | `number` | The adjusted close price. |
3064
+ | `adj_volume` | `number` | The adjusted volume. |
3065
+ | `split_ratio` | `number` | Ratio of the equity split, if a split occurred. |
3066
+ | `dividend` | `number` | Dividend amount, if a dividend was paid. |
3067
+ | `change` | `number` | Change in the price from the previous close. |
3068
+ | `change_percent` | `number` | Change in the price from the previous close, as a normalized percent. |
1893
3069
 
1894
3070
  ---
1895
3071
 
1896
3072
  ### `equity.price.performance`
1897
3073
 
1898
3074
  ```python
1899
- data.equity.price.performance(symbol=..., provider=...)
3075
+ data.equity.price.performance(symbol=...)
1900
3076
  ```
1901
3077
 
1902
3078
  Summary: Performance
@@ -1906,7 +3082,6 @@ Summary: Performance
1906
3082
  | Endpoint ID | `equity.price.performance` |
1907
3083
  | HTTP | `GET` |
1908
3084
  | Path | `/inner/v1/agent-data/equity/price/performance` |
1909
- | Default provider | - |
1910
3085
  | SDK | `supported` |
1911
3086
  | Host | `supported` |
1912
3087
  | Notes | - |
@@ -1915,15 +3090,41 @@ Summary: Performance
1915
3090
 
1916
3091
  | Param | Required | Type | Default | Notes |
1917
3092
  |---|---|---|---|---|
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 |
3093
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
3094
+
3095
+ #### Response fields
3096
+
3097
+ | Field | Type | Notes |
3098
+ |---|---|---|
3099
+ | `symbol` | `string` | The ticker symbol. |
3100
+ | `one_day` | `number` | One-day return. |
3101
+ | `wtd` | `number` | Week to date return. |
3102
+ | `one_week` | `number` | One-week return. |
3103
+ | `mtd` | `number` | Month to date return. |
3104
+ | `one_month` | `number` | One-month return. |
3105
+ | `qtd` | `number` | Quarter to date return. |
3106
+ | `three_month` | `number` | Three-month return. |
3107
+ | `six_month` | `number` | Six-month return. |
3108
+ | `ytd` | `number` | Year to date return. |
3109
+ | `one_year` | `number` | One-year return. |
3110
+ | `two_year` | `number` | Two-year return. |
3111
+ | `three_year` | `number` | Three-year return. |
3112
+ | `five_year` | `number` | Five-year return. |
3113
+ | `ten_year` | `number` | Ten-year return. |
3114
+ | `max` | `number` | Return from the beginning of the time series. |
3115
+ | `volatility_week` | `number` | One-week realized volatility, as a normalized percent. |
3116
+ | `volatility_month` | `number` | One-month realized volatility, as a normalized percent. |
3117
+ | `price` | `number` | Last Price. |
3118
+ | `volume` | `number` | Current volume. |
3119
+ | `average_volume` | `number` | Average daily volume. |
3120
+ | `analyst_recommendation` | `number` | The analyst consensus, on a scale of 1-5 where 1 is a buy and 5 is a sell. |
1920
3121
 
1921
3122
  ---
1922
3123
 
1923
3124
  ### `equity.price.quote`
1924
3125
 
1925
3126
  ```python
1926
- data.equity.price.quote(symbol=..., market='a_share', use_cache=True, source='iex', provider=...)
3127
+ data.equity.price.quote(symbol=..., market='a_share', use_cache=True, source='iex')
1927
3128
  ```
1928
3129
 
1929
3130
  Summary: Quote
@@ -1933,7 +3134,6 @@ Summary: Quote
1933
3134
  | Endpoint ID | `equity.price.quote` |
1934
3135
  | HTTP | `GET` |
1935
3136
  | Path | `/inner/v1/agent-data/equity/price/quote` |
1936
- | Default provider | - |
1937
3137
  | SDK | `supported` |
1938
3138
  | Host | `supported` |
1939
3139
  | Notes | - |
@@ -1942,18 +3142,44 @@ Summary: Quote
1942
3142
 
1943
3143
  | Param | Required | Type | Default | Notes |
1944
3144
  |---|---|---|---|---|
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 |
3145
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed; A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID). |
3146
+ | `market` | `no` | `string` | `a_share` | enum: a_share, hk Market selection. 'a_share' for mainland China A-shares, 'hk' for Hong Kong stocks. |
3147
+ | `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. |
3148
+ | `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. |
3149
+
3150
+ #### Response fields
3151
+
3152
+ | Field | Type | Notes |
3153
+ |---|---|---|
3154
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
3155
+ | `asset_type` | `string` | Type of asset - i.e, stock, ETF, etc. |
3156
+ | `name` | `string` | Name of the company or asset. |
3157
+ | `exchange` | `string` | The name or symbol of the venue where the data is from. |
3158
+ | `bid` | `number` | Price of the top bid order. |
3159
+ | `bid_size` | `integer` | This represents the number of round lot orders at the given price. |
3160
+ | `ask` | `number` | Price of the top ask order. |
3161
+ | `ask_size` | `integer` | This represents the number of round lot orders at the given price. |
3162
+ | `last_price` | `number` | Price of the last trade. |
3163
+ | `last_size` | `integer` | Size of the last trade. |
3164
+ | `last_timestamp` | `string` | Date and Time when the last price was recorded. |
3165
+ | `open` | `number` | The open price. |
3166
+ | `high` | `number` | The high price. |
3167
+ | `low` | `number` | The low price. |
3168
+ | `close` | `number` | The close price. |
3169
+ | `volume` | `integer` | The trading volume. |
3170
+ | `prev_close` | `number` | The previous close price. |
3171
+ | `change` | `number` | Change in price from previous close. |
3172
+ | `change_percent` | `number` | Change in price as a normalized percentage. |
3173
+ | `year_high` | `number` | The one year high (52W High). |
3174
+ | `year_low` | `number` | The one year low (52W Low). |
3175
+ | `updated_on` | `string` | Date and Time when the data was last updated. |
1950
3176
 
1951
3177
  ---
1952
3178
 
1953
3179
  ### `equity.profile`
1954
3180
 
1955
3181
  ```python
1956
- data.equity.profile(symbol=..., provider=...)
3182
+ data.equity.profile(symbol=...)
1957
3183
  ```
1958
3184
 
1959
3185
  Summary: Profile
@@ -1963,7 +3189,6 @@ Summary: Profile
1963
3189
  | Endpoint ID | `equity.profile` |
1964
3190
  | HTTP | `GET` |
1965
3191
  | Path | `/inner/v1/agent-data/equity/profile` |
1966
- | Default provider | - |
1967
3192
  | SDK | `supported` |
1968
3193
  | Host | `supported` |
1969
3194
  | Notes | - |
@@ -1972,15 +3197,47 @@ Summary: Profile
1972
3197
 
1973
3198
  | Param | Required | Type | Default | Notes |
1974
3199
  |---|---|---|---|---|
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 |
3200
+ | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
3201
+
3202
+ #### Response fields
3203
+
3204
+ | Field | Type | Notes |
3205
+ |---|---|---|
3206
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
3207
+ | `name` | `string` | Common name of the company. |
3208
+ | `cik` | `string` | Central Index Key (CIK) for the requested entity. |
3209
+ | `isin` | `string` | International Securities Identification Number. |
3210
+ | `lei` | `string` | Legal Entity Identifier assigned to the company. |
3211
+ | `stock_exchange` | `string` | Stock exchange where the company is traded. |
3212
+ | `sic` | `integer` | Standard Industrial Classification code for the company. |
3213
+ | `short_description` | `string` | Short description of the company. |
3214
+ | `long_description` | `string` | Long description of the company. |
3215
+ | `ceo` | `string` | Chief Executive Officer of the company. |
3216
+ | `company_url` | `string` | URL of the company's website. |
3217
+ | `hq_address_city` | `string` | City of the company's headquarters. |
3218
+ | `hq_country` | `string` | Country of the company's headquarters. |
3219
+ | `employees` | `integer` | Number of employees working for the company. |
3220
+ | `sector` | `string` | Sector in which the company operates. |
3221
+ | `industry_category` | `string` | Category of industry in which the company operates. |
3222
+ | `industry_group` | `string` | Group of industry in which the company operates. |
3223
+ | `is_etf` | `boolean` | If the symbol is an ETF. |
3224
+ | `is_actively_trading` | `boolean` | If the company is actively trading. |
3225
+ | `currency` | `string` | Currency in which the stock is traded. |
3226
+ | `market_cap` | `integer` | Market capitalization of the company. |
3227
+ | `last_price` | `number` | The last traded price. |
3228
+ | `year_high` | `number` | The one-year high of the price. |
3229
+ | `year_low` | `number` | The one-year low of the price. |
3230
+ | `volume_avg` | `integer` | Average daily trading volume. |
3231
+ | `annualized_dividend_amount` | `number` | The annualized dividend payment based on the most recent regular dividend payment. |
3232
+ | `beta` | `number` | Beta of the stock relative to the market. |
3233
+ | `shares_outstanding` | `integer` | The number of listed shares outstanding. |
1977
3234
 
1978
3235
  ---
1979
3236
 
1980
3237
  ### `equity.screener`
1981
3238
 
1982
3239
  ```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=...)
3240
+ 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
3241
  ```
1985
3242
 
1986
3243
  Summary: Screener
@@ -1990,7 +3247,6 @@ Summary: Screener
1990
3247
  | Endpoint ID | `equity.screener` |
1991
3248
  | HTTP | `GET` |
1992
3249
  | Path | `/inner/v1/agent-data/equity/screener` |
1993
- | Default provider | - |
1994
3250
  | SDK | `supported` |
1995
3251
  | Host | `supported` |
1996
3252
  | Notes | - |
@@ -1999,42 +3255,73 @@ Summary: Screener
1999
3255
 
2000
3256
  | Param | Required | Type | Default | Notes |
2001
3257
  |---|---|---|---|---|
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) |
3258
+ | `metric` | `no` | `string` | `overview` | enum: overview, valuation, financial, ownership, performance, technical The data group to return, default is 'overview'. |
3259
+ | `exchange` | `no` | `string | null` | `all` | Filter by exchange. |
3260
+ | `index` | `no` | `string` | `all` | enum: all, dow, nasdaq, sp500, russell Filter by index. |
3261
+ | `sector` | `no` | `string | null` | `all` | Filter by sector. |
3262
+ | `industry` | `no` | `string | null` | `all` | Filter by industry. |
3263
+ | `mktcap` | `no` | `string` | `all` | Filter by market cap. Mega - > 200B Large - 10B - 200B Mid - 2B - 10B Small - 300M - 2B Micro - 50M - 300M Nano - < 50M |
3264
+ | `recommendation` | `no` | `string` | `all` | Filter by analyst recommendation.; Filter by consensus analyst action. Multiple comma separated items allowed. |
3265
+ | `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) |
3266
+ | `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) |
3267
+ | `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. |
3268
+ | `mktcap_min` | `no` | `integer | null` | `-` | Filter by market cap greater than this value. |
3269
+ | `mktcap_max` | `no` | `integer | null` | `-` | Filter by market cap less than this value. |
3270
+ | `price_min` | `no` | `number | null` | `-` | Filter by price greater than this value. |
3271
+ | `price_max` | `no` | `number | null` | `-` | Filter by price less than this value. |
3272
+ | `beta_min` | `no` | `number | null` | `-` | Filter by a beta greater than this value. |
3273
+ | `beta_max` | `no` | `number | null` | `-` | Filter by a beta less than this value. |
3274
+ | `volume_min` | `no` | `integer | null` | `-` | Filter by volume greater than this value. |
3275
+ | `volume_max` | `no` | `integer | null` | `-` | Filter by volume less than this value. |
3276
+ | `dividend_min` | `no` | `number | null` | `-` | Filter by dividend amount greater than this value. |
3277
+ | `dividend_max` | `no` | `number | null` | `-` | Filter by dividend amount less than this value. |
3278
+ | `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'). |
3279
+ | `is_etf` | `no` | `boolean | null` | `-` | If true, includes ETFs. |
3280
+ | `is_active` | `no` | `boolean | null` | `-` | If false, returns only inactive tickers. |
3281
+ | `is_fund` | `no` | `boolean | null` | `-` | If true, includes funds. |
3282
+ | `all_share_classes` | `no` | `boolean | null` | `-` | If true, includes all share classes of a equity. |
3283
+ | `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. |
3284
+ | `region` | `no` | `string` | `all` | Filter by region. Multiple comma separated items allowed. |
3285
+ | `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. |
3286
+
3287
+ #### Response fields
3288
+
3289
+ | Field | Type | Notes |
3290
+ |---|---|---|
3291
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
3292
+ | `name` | `string` | Name of the company. |
3293
+ | `last_price` | `number` | Last sale price. |
3294
+ | `change` | `number` | 1-day change in price. |
3295
+ | `change_percent` | `number` | 1-day percent change in price. |
3296
+ | `market_cap` | `integer` | Market cap. |
3297
+ | `earnings_date` | `string` | Earnings date. |
3298
+ | `country` | `string` | Country of the company. |
3299
+ | `sector` | `string` | Sector of the company. |
3300
+ | `industry` | `string` | Industry of the company. |
3301
+ | `beta` | `number` | Beta of the stock. |
3302
+ | `analyst_recommendation` | `number` | Analyst's mean recommendation. (1=Buy 5=Sell). |
3303
+ | `volume` | `integer` | The trading volume. |
3304
+ | `volume_avg` | `integer` | 3-month average daily volume. |
3305
+ | `price_change_1w` | `number` | One-week price return. |
3306
+ | `price_change_1m` | `number` | One-month price return. |
3307
+ | `price_change_1y` | `number` | One-year price return. |
3308
+ | `dividend_yield` | `number` | Annualized dividend yield. |
3309
+ | `return_on_assets` | `number` | Return on assets. |
3310
+ | `return_on_equity` | `number` | Return on equity. |
3311
+ | `gross_margin` | `number` | Gross margin. |
3312
+ | `operating_margin` | `number` | Operating margin. |
3313
+ | `profit_margin` | `number` | Profit margin. |
3314
+ | `price_to_earnings` | `number` | Price to earnings ratio. |
3315
+ | `price_to_book` | `number` | Price to book ratio. |
3316
+ | `exchange` | `string` | The exchange code the asset trades on. |
3317
+ | `is_etf` | `boolean` | Whether the ticker is an ETF. |
2031
3318
 
2032
3319
  ---
2033
3320
 
2034
3321
  ### `equity.search`
2035
3322
 
2036
3323
  ```python
2037
- data.equity.search(query='', is_symbol=False, use_cache=True, active=True, limit=10000, is_etf=False, is_fund=False, provider=...)
3324
+ data.equity.search(query='', is_symbol=False, use_cache=True, active=True, limit=10000, is_etf=False, is_fund=False)
2038
3325
  ```
2039
3326
 
2040
3327
  Summary: Search
@@ -2044,7 +3331,6 @@ Summary: Search
2044
3331
  | Endpoint ID | `equity.search` |
2045
3332
  | HTTP | `GET` |
2046
3333
  | Path | `/inner/v1/agent-data/equity/search` |
2047
- | Default provider | - |
2048
3334
  | SDK | `supported` |
2049
3335
  | Host | `supported` |
2050
3336
  | Notes | - |
@@ -2054,20 +3340,38 @@ Summary: Search
2054
3340
  | Param | Required | Type | Default | Notes |
2055
3341
  |---|---|---|---|---|
2056
3342
  | `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 |
3343
+ | `is_symbol` | `no` | `boolean` | `false` | Whether to search by ticker symbol.; Whether the query is a symbol. Defaults to False. |
3344
+ | `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. |
3345
+ | `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. |
3346
+ | `limit` | `no` | `integer | null` | `10000` | The number of data entries to return. |
3347
+ | `is_etf` | `no` | `boolean` | `false` | If True, returns only ETFs. |
3348
+ | `is_fund` | `no` | `boolean` | `false` | Whether to direct the search to the list of mutual funds and ETFs. |
3349
+
3350
+ #### Response fields
3351
+
3352
+ | Field | Type | Notes |
3353
+ |---|---|---|
3354
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
3355
+ | `name` | `string` | Name of the company. |
3356
+ | `dpm_name` | `string` | Name of the primary market maker. |
3357
+ | `post_station` | `string` | Post and station location on the CBOE trading floor. |
3358
+ | `nasdaq_traded` | `string` | Is Nasdaq traded? |
3359
+ | `exchange` | `string` | Primary Exchange. |
3360
+ | `market_category` | `string` | Market Category. |
3361
+ | `etf` | `string` | Is ETF? |
3362
+ | `round_lot_size` | `number` | Round Lot Size. |
3363
+ | `financial_status` | `string` | Financial Status. |
3364
+ | `cik` | `string` | Central Index Key. |
3365
+ | `lei` | `string` | The Legal Entity Identifier (LEI) of the company. |
3366
+ | `intrinio_id` | `string` | The Intrinio ID of the company. |
3367
+ | `security_type` | `string` | Type of security. |
2064
3368
 
2065
3369
  ---
2066
3370
 
2067
3371
  ### `equity.shorts.fails_to_deliver`
2068
3372
 
2069
3373
  ```python
2070
- data.equity.shorts.fails_to_deliver(symbol=..., limit=24, skip_reports=0, use_cache=True, provider='sec')
3374
+ data.equity.shorts.fails_to_deliver(symbol=..., limit=24, skip_reports=0, use_cache=True)
2071
3375
  ```
2072
3376
 
2073
3377
  Summary: Fails To Deliver
@@ -2077,7 +3381,6 @@ Summary: Fails To Deliver
2077
3381
  | Endpoint ID | `equity.shorts.fails_to_deliver` |
2078
3382
  | HTTP | `GET` |
2079
3383
  | Path | `/inner/v1/agent-data/equity/shorts/fails_to_deliver` |
2080
- | Default provider | `sec` |
2081
3384
  | SDK | `supported` |
2082
3385
  | Host | `supported` |
2083
3386
  | Notes | - |
@@ -2087,17 +3390,27 @@ Summary: Fails To Deliver
2087
3390
  | Param | Required | Type | Default | Notes |
2088
3391
  |---|---|---|---|---|
2089
3392
  | `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` | - |
3393
+ | `limit` | `no` | `integer | null` | `24` | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. |
3394
+ | `skip_reports` | `no` | `integer | null` | `0` | Skip N number of reports from current. A value of 1 will skip the most recent report. |
3395
+ | `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. |
3396
+
3397
+ #### Response fields
3398
+
3399
+ | Field | Type | Notes |
3400
+ |---|---|---|
3401
+ | `settlement_date` | `string` | The settlement date of the fail. |
3402
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
3403
+ | `cusip` | `string` | CUSIP of the Security. |
3404
+ | `quantity` | `integer` | The number of fails on that settlement date. |
3405
+ | `price` | `number` | The price at the previous closing price from the settlement date. |
3406
+ | `description` | `string` | The description of the Security. |
2094
3407
 
2095
3408
  ---
2096
3409
 
2097
3410
  ### `equity.shorts.short_interest`
2098
3411
 
2099
3412
  ```python
2100
- data.equity.shorts.short_interest(symbol=..., provider='finra')
3413
+ data.equity.shorts.short_interest(symbol=...)
2101
3414
  ```
2102
3415
 
2103
3416
  Summary: Short Interest
@@ -2107,7 +3420,6 @@ Summary: Short Interest
2107
3420
  | Endpoint ID | `equity.shorts.short_interest` |
2108
3421
  | HTTP | `GET` |
2109
3422
  | Path | `/inner/v1/agent-data/equity/shorts/short_interest` |
2110
- | Default provider | `finra` |
2111
3423
  | SDK | `supported` |
2112
3424
  | Host | `supported` |
2113
3425
  | Notes | - |
@@ -2117,4 +3429,18 @@ Summary: Short Interest
2117
3429
  | Param | Required | Type | Default | Notes |
2118
3430
  |---|---|---|---|---|
2119
3431
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
2120
- | `provider` | `no` | `string` | `finra` | - |
3432
+
3433
+ #### Response fields
3434
+
3435
+ | Field | Type | Notes |
3436
+ |---|---|---|
3437
+ | `settlement_date` | `string` | The settlement date of the short interest report. |
3438
+ | `symbol` | `string` | Symbol representing the entity requested in the data. |
3439
+ | `issue_name` | `string` | Unique identifier of the issue. |
3440
+ | `market_class` | `string` | Primary listing market. |
3441
+ | `current_short_position` | `number` | The total number of shares in the issue reported as short as of the current cycle's designated settlement date. |
3442
+ | `previous_short_position` | `number` | The total number of shares in the issue reported as short as of the previous cycle's designated settlement date. |
3443
+ | `avg_daily_volume` | `number` | Average daily volume. |
3444
+ | `days_to_cover` | `number` | The number of days of average share volume it would require to buy all of the shares that were sold short. |
3445
+ | `change` | `number` | Change in Shares Short from Previous Cycle. |
3446
+ | `change_pct` | `number` | Change in Shares Short from Previous Cycle as a percent. |