@bitget-ai/getagent-skill 0.2.2 → 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 (29) 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 +145 -10
  6. package/skills/getagent/references/api/confirm.md +59 -0
  7. package/skills/getagent/references/api/index.md +9 -7
  8. package/skills/getagent/references/api/publish.md +13 -10
  9. package/skills/getagent/references/api/run.md +5 -5
  10. package/skills/getagent/references/api/upload.md +22 -4
  11. package/skills/getagent/references/backtest-engine.md +11 -10
  12. package/skills/getagent/references/package-schema.md +8 -7
  13. package/skills/getagent/references/sdk/backtest/catalog.md +5 -3
  14. package/skills/getagent/references/sdk/data/catalog.md +2 -4
  15. package/skills/getagent/references/sdk/data/commodity.md +46 -0
  16. package/skills/getagent/references/sdk/data/crypto.md +1468 -88
  17. package/skills/getagent/references/sdk/data/currency.md +48 -0
  18. package/skills/getagent/references/sdk/data/derivatives.md +126 -0
  19. package/skills/getagent/references/sdk/data/economy.md +736 -0
  20. package/skills/getagent/references/sdk/data/equity.md +1462 -0
  21. package/skills/getagent/references/sdk/data/etf.md +510 -0
  22. package/skills/getagent/references/sdk/data/fixedincome.md +485 -0
  23. package/skills/getagent/references/sdk/data/news.md +76 -0
  24. package/skills/getagent/references/sdk/data/regulators.md +85 -0
  25. package/skills/getagent/references/sdk/data/sentiment.md +176 -0
  26. package/skills/getagent/references/sdk.md +14 -5
  27. package/skills/getagent/scripts/validate.py +9 -29
  28. package/skills/getagent/scripts/version_check.sh +13 -12
  29. package/skills/getagent/references/sdk/data/playbook-supported.md +0 -9236
@@ -100,6 +100,22 @@ Summary: Dividend
100
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. |
101
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. |
102
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. |
118
+
103
119
  ---
104
120
 
105
121
  ### `equity.calendar.earnings`
@@ -128,6 +144,29 @@ Summary: Earnings
128
144
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. |
129
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'). |
130
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. |
169
+
131
170
  ---
132
171
 
133
172
  ### `equity.calendar.events`
@@ -155,6 +194,23 @@ Summary: Events
155
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. |
156
195
  | `country` | `no` | `string | null` | `-` | Country code to filter economic events (e.g., 'US', 'JP', 'CN'). |
157
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. |
213
+
158
214
  ---
159
215
 
160
216
  ### `equity.calendar.ipo`
@@ -187,6 +243,43 @@ Summary: Ipo
187
243
  | `max_value` | `no` | `integer | null` | `-` | Return IPOs with an offer dollar amount less than the given amount. |
188
244
  | `is_spo` | `no` | `boolean` | `false` | If True, returns data for secondary public offerings (SPOs). |
189
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. |
282
+
190
283
  ---
191
284
 
192
285
  ### `equity.calendar.splits`
@@ -213,6 +306,15 @@ Summary: Splits
213
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. |
214
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. |
215
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. |
317
+
216
318
  ---
217
319
 
218
320
  ### `equity.compare.company_facts`
@@ -243,6 +345,26 @@ Summary: Company Facts
243
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. |
244
346
  | `use_cache` | `no` | `boolean` | `true` | Whether to use cache for the request. Defaults to True. |
245
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. |
367
+
246
368
  ---
247
369
 
248
370
  ### `equity.compare.groups`
@@ -269,6 +391,33 @@ Summary: Groups
269
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'. |
270
392
  | `metric` | `no` | `string` | `performance` | enum: performance, valuation, overview Statistical metric to return. Select from: ['performance', 'valuation', 'overview'] The default is 'performance'. |
271
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. |
420
+
272
421
  ---
273
422
 
274
423
  ### `equity.compare.peers`
@@ -294,6 +443,15 @@ Summary: Peers
294
443
  |---|---|---|---|---|
295
444
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
296
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. |
454
+
297
455
  ---
298
456
 
299
457
  ### `equity.darkpool.otc`
@@ -321,6 +479,14 @@ Summary: Otc
321
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 |
322
480
  | `is_ats` | `no` | `boolean` | `true` | ATS data if true, NON-ATS otherwise |
323
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. |
489
+
324
490
  ---
325
491
 
326
492
  ### `equity.discovery.active`
@@ -347,6 +513,37 @@ Summary: Active
347
513
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
348
514
  | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
349
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. |
546
+
350
547
  ---
351
548
 
352
549
  ### `equity.discovery.aggressive_small_caps`
@@ -373,6 +570,37 @@ Summary: Aggressive Small Caps
373
570
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
374
571
  | `limit` | `no` | `integer | null` | `-` | Limit the number of results. Default is all. |
375
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. |
603
+
376
604
  ---
377
605
 
378
606
  ### `equity.discovery.filings`
@@ -401,6 +629,18 @@ Summary: Filings
401
629
  | `form_type` | `no` | `string | null` | `-` | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. |
402
630
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return.; The maximum number of results to return. Default is 10000. |
403
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. |
643
+
404
644
  ---
405
645
 
406
646
  ### `equity.discovery.gainers`
@@ -428,6 +668,41 @@ Summary: Gainers
428
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`. |
429
669
  | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
430
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. |
705
+
431
706
  ---
432
707
 
433
708
  ### `equity.discovery.growth_tech`
@@ -454,6 +729,37 @@ Summary: Growth Tech
454
729
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
455
730
  | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
456
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. |
762
+
457
763
  ---
458
764
 
459
765
  ### `equity.discovery.latest_financial_reports`
@@ -480,6 +786,25 @@ Summary: Latest Financial Reports
480
786
  | `date` | `no` | `string | null` | `-` | A specific date to get data for. Defaults to today. |
481
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. |
482
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. |
807
+
483
808
  ---
484
809
 
485
810
  ### `equity.discovery.losers`
@@ -506,6 +831,37 @@ Summary: Losers
506
831
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
507
832
  | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
508
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. |
864
+
509
865
  ---
510
866
 
511
867
  ### `equity.discovery.top_retail`
@@ -531,6 +887,15 @@ Summary: Top Retail
531
887
  |---|---|---|---|---|
532
888
  | `limit` | `no` | `integer` | `5` | The number of data entries to return. |
533
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. |
898
+
534
899
  ---
535
900
 
536
901
  ### `equity.discovery.undervalued_growth`
@@ -557,6 +922,37 @@ Summary: Undervalued Growth
557
922
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
558
923
  | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
559
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. |
955
+
560
956
  ---
561
957
 
562
958
  ### `equity.discovery.undervalued_large_caps`
@@ -583,6 +979,37 @@ Summary: Undervalued Large Caps
583
979
  | `sort` | `no` | `string` | `desc` | enum: asc, desc Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. |
584
980
  | `limit` | `no` | `integer | null` | `200` | Limit the number of results. |
585
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. |
1012
+
586
1013
  ---
587
1014
 
588
1015
  ### `equity.estimates.analyst_search`
@@ -614,6 +1041,67 @@ Summary: Analyst Search
614
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. |
615
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. |
616
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. |
1104
+
617
1105
  ---
618
1106
 
619
1107
  ### `equity.estimates.consensus`
@@ -640,6 +1128,33 @@ Summary: Consensus
640
1128
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
641
1129
  | `industry_group_number` | `no` | `integer | null` | `-` | The Zacks industry group number. |
642
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. |
1157
+
643
1158
  ---
644
1159
 
645
1160
  ### `equity.estimates.forward_ebitda`
@@ -669,6 +1184,26 @@ Summary: Forward Ebitda
669
1184
  | `include_historical` | `no` | `boolean` | `false` | If True, the data will include all past data and the limit will be ignored. |
670
1185
  | `estimate_type` | `no` | `string | null` | `-` | Limit the EBITDA estimates to this type. |
671
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. |
1206
+
672
1207
  ---
673
1208
 
674
1209
  ### `equity.estimates.forward_eps`
@@ -700,6 +1235,29 @@ Summary: Forward Eps
700
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. |
701
1236
  | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. |
702
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. |
1260
+
703
1261
  ---
704
1262
 
705
1263
  ### `equity.estimates.forward_pe`
@@ -725,6 +1283,21 @@ Summary: Forward Pe
725
1283
  |---|---|---|---|---|
726
1284
  | `symbol` | `no` | `string | null` | `-` | Symbol to get data for. Multiple comma separated items allowed |
727
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. |
1300
+
728
1301
  ---
729
1302
 
730
1303
  ### `equity.estimates.forward_sales`
@@ -754,6 +1327,33 @@ Summary: Forward Sales
754
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. |
755
1328
  | `calendar_period` | `no` | `string | null` | `-` | The future calendar period to retrieve estimates for. |
756
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. |
1356
+
757
1357
  ---
758
1358
 
759
1359
  ### `equity.estimates.historical`
@@ -783,6 +1383,33 @@ Summary: Historical
783
1383
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
784
1384
  | `page` | `no` | `integer | null` | `-` | Page number for paginated results. Used with limit. |
785
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. |
1412
+
786
1413
  ---
787
1414
 
788
1415
  ### `equity.estimates.price_target`
@@ -819,6 +1446,39 @@ Summary: Price Target
819
1446
  | `firm_ids` | `no` | `array | string | null` | `-` | accepts array values Comma-separated list of firm IDs. Multiple comma separated items allowed. |
820
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. |
821
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. |
1481
+
822
1482
  ---
823
1483
 
824
1484
  ### `equity.fundamental.balance`
@@ -847,6 +1507,68 @@ Summary: Balance
847
1507
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
848
1508
  | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
849
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. |
1571
+
850
1572
  ---
851
1573
 
852
1574
  ### `equity.fundamental.balance_growth`
@@ -874,6 +1596,31 @@ Summary: Balance Growth
874
1596
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
875
1597
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
876
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. |
1623
+
877
1624
  ---
878
1625
 
879
1626
  ### `equity.fundamental.cash`
@@ -902,6 +1649,36 @@ Summary: Cash
902
1649
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
903
1650
  | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
904
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. |
1681
+
905
1682
  ---
906
1683
 
907
1684
  ### `equity.fundamental.cash_growth`
@@ -929,6 +1706,31 @@ Summary: Cash Growth
929
1706
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
930
1707
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
931
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. |
1733
+
932
1734
  ---
933
1735
 
934
1736
  ### `equity.fundamental.dividends`
@@ -957,6 +1759,24 @@ Summary: Dividends
957
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. |
958
1760
  | `limit` | `no` | `integer | null` | `-` | Return N most recent payments.; The number of data entries to return. |
959
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. |
1779
+
960
1780
  ---
961
1781
 
962
1782
  ### `equity.fundamental.employee_count`
@@ -985,6 +1805,17 @@ Summary: Employee Count
985
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. |
986
1806
  | `limit` | `no` | `integer | null` | `-` | Number of records to return. Default is all. |
987
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. |
1818
+
988
1819
  ---
989
1820
 
990
1821
  ### `equity.fundamental.esg_score`
@@ -1010,6 +1841,22 @@ Summary: Esg Score
1010
1841
  |---|---|---|---|---|
1011
1842
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1012
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. |
1859
+
1013
1860
  ---
1014
1861
 
1015
1862
  ### `equity.fundamental.filings`
@@ -1045,6 +1892,37 @@ Summary: Filings
1045
1892
  | `form_group` | `no` | `string` | `8k` | enum: annual, quarterly, proxy, insider, 8k, registration, comment The form group to fetch, default is 8k. |
1046
1893
  | `use_cache` | `no` | `boolean` | `true` | Whether or not to use cache. If True, cache will store for one day. |
1047
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. |
1925
+
1048
1926
  ---
1049
1927
 
1050
1928
  ### `equity.fundamental.historical_attributes`
@@ -1077,6 +1955,15 @@ Summary: Historical Attributes
1077
1955
  | `tag_type` | `no` | `string | null` | `-` | Filter by type, when applicable. |
1078
1956
  | `sort` | `no` | `string | null` | `desc` | Sort order. |
1079
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. |
1966
+
1080
1967
  ---
1081
1968
 
1082
1969
  ### `equity.fundamental.historical_eps`
@@ -1104,6 +1991,22 @@ Summary: Historical Eps
1104
1991
  | `period` | `no` | `string` | `quarter` | enum: annual, quarter Time period of the data to return. |
1105
1992
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1106
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. |
2009
+
1107
2010
  ---
1108
2011
 
1109
2012
  ### `equity.fundamental.historical_splits`
@@ -1129,6 +2032,15 @@ Summary: Historical Splits
1129
2032
  |---|---|---|---|---|
1130
2033
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1131
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. |
2043
+
1132
2044
  ---
1133
2045
 
1134
2046
  ### `equity.fundamental.income`
@@ -1157,6 +2069,32 @@ Summary: Income
1157
2069
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1158
2070
  | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1159
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. |
2097
+
1160
2098
  ---
1161
2099
 
1162
2100
  ### `equity.fundamental.income_growth`
@@ -1184,6 +2122,31 @@ Summary: Income Growth
1184
2122
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1185
2123
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1186
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). |
2149
+
1187
2150
  ---
1188
2151
 
1189
2152
  ### `equity.fundamental.latest_attributes`
@@ -1210,6 +2173,14 @@ Summary: Latest Attributes
1210
2173
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1211
2174
  | `tag` | `yes` | `string` | `-` | Intrinio data tag ID or code. Multiple comma separated items allowed |
1212
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. |
2183
+
1213
2184
  ---
1214
2185
 
1215
2186
  ### `equity.fundamental.management`
@@ -1235,6 +2206,20 @@ Summary: Management
1235
2206
  |---|---|---|---|---|
1236
2207
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1237
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. |
2222
+
1238
2223
  ---
1239
2224
 
1240
2225
  ### `equity.fundamental.management_compensation`
@@ -1261,6 +2246,26 @@ Summary: Management Compensation
1261
2246
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1262
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. |
1263
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. |
2268
+
1264
2269
  ---
1265
2270
 
1266
2271
  ### `equity.fundamental.management_discussion_analysis`
@@ -1319,6 +2324,41 @@ Summary: Metrics
1319
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'. |
1320
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. |
1321
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). |
2361
+
1322
2362
  ---
1323
2363
 
1324
2364
  ### `equity.fundamental.ratios`
@@ -1348,6 +2388,31 @@ Summary: Ratios
1348
2388
  | `period` | `no` | `string` | `annual` | Specify the fiscal period for the data.; Time period of the data to return. |
1349
2389
  | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1350
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. |
2415
+
1351
2416
  ---
1352
2417
 
1353
2418
  ### `equity.fundamental.reported_financials`
@@ -1377,6 +2442,14 @@ Summary: Reported Financials
1377
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. |
1378
2443
  | `fiscal_year` | `no` | `integer | null` | `-` | The specific fiscal year. Reports do not go beyond 2008. |
1379
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. |
2452
+
1380
2453
  ---
1381
2454
 
1382
2455
  ### `equity.fundamental.revenue_per_geography`
@@ -1403,6 +2476,17 @@ Summary: Revenue Per Geography
1403
2476
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1404
2477
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1405
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. |
2489
+
1406
2490
  ---
1407
2491
 
1408
2492
  ### `equity.fundamental.revenue_per_segment`
@@ -1429,6 +2513,17 @@ Summary: Revenue Per Segment
1429
2513
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1430
2514
  | `period` | `no` | `string` | `annual` | Time period of the data to return. |
1431
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. |
2526
+
1432
2527
  ---
1433
2528
 
1434
2529
  ### `equity.fundamental.search_attributes`
@@ -1455,6 +2550,22 @@ Summary: Search Attributes
1455
2550
  | `query` | `yes` | `string` | `-` | Query to search for. |
1456
2551
  | `limit` | `no` | `integer | null` | `1000` | The number of data entries to return. |
1457
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. |
2568
+
1458
2569
  ---
1459
2570
 
1460
2571
  ### `equity.fundamental.trailing_dividend_yield`
@@ -1481,6 +2592,13 @@ Summary: Trailing Dividend Yield
1481
2592
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
1482
2593
  | `limit` | `no` | `integer | null` | `252` | The number of data entries to return. Default is 252, the number of trading days in a year. |
1483
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. |
2601
+
1484
2602
  ---
1485
2603
 
1486
2604
  ### `equity.fundamental.transcript`
@@ -1536,6 +2654,14 @@ Summary: Historical Market Cap
1536
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. |
1537
2655
  | `interval` | `no` | `string` | `day` | enum: day, week, month, quarter, year None |
1538
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. |
2664
+
1539
2665
  ---
1540
2666
 
1541
2667
  ### `equity.market_snapshots`
@@ -1562,6 +2688,36 @@ Summary: Market Snapshots
1562
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. |
1563
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' |
1564
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. |
2720
+
1565
2721
  ---
1566
2722
 
1567
2723
  ### `equity.ownership.form_13f`
@@ -1589,6 +2745,24 @@ Summary: Form 13F
1589
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. |
1590
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. |
1591
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. |
2765
+
1592
2766
  ---
1593
2767
 
1594
2768
  ### `equity.ownership.government_trades`
@@ -1616,6 +2790,23 @@ Summary: Government Trades
1616
2790
  | `chamber` | `no` | `string` | `all` | Government Chamber. |
1617
2791
  | `limit` | `no` | `integer | null` | `-` | The number of data entries to return. |
1618
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. |
2809
+
1619
2810
  ---
1620
2811
 
1621
2812
  ### `equity.ownership.insider_trading`
@@ -1650,6 +2841,29 @@ Summary: Insider Trading
1650
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. |
1651
2842
  | `summary` | `no` | `boolean` | `false` | Return a summary of the insider activity instead of the individuals. |
1652
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. |
2866
+
1653
2867
  ---
1654
2868
 
1655
2869
  ### `equity.ownership.institutional`
@@ -1677,6 +2891,25 @@ Summary: Institutional
1677
2891
  | `year` | `no` | `integer | null` | `-` | Calendar year for the data. If not provided, the latest year is used. |
1678
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. |
1679
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. |
2912
+
1680
2913
  ---
1681
2914
 
1682
2915
  ### `equity.ownership.major_holders`
@@ -1706,6 +2939,30 @@ Summary: Major Holders
1706
2939
  | `page` | `no` | `integer | null` | `-` | Page number, used in conjunction with the limit. The default is 0. |
1707
2940
  | `limit` | `no` | `integer | null` | `-` | Number of items to return per page. The default is 100, which is the maximum. |
1708
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. |
2965
+
1709
2966
  ---
1710
2967
 
1711
2968
  ### `equity.ownership.share_statistics`
@@ -1731,6 +2988,26 @@ Summary: Share Statistics
1731
2988
  |---|---|---|---|---|
1732
2989
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1733
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. |
3010
+
1734
3011
  ---
1735
3012
 
1736
3013
  ### `equity.price.historical`
@@ -1769,6 +3046,27 @@ Summary: Historical
1769
3046
  | `source` | `no` | `string` | `realtime` | enum: realtime, delayed, nasdaq_basic The source of the data. |
1770
3047
  | `include_actions` | `no` | `boolean` | `true` | Include dividends and stock splits in results. |
1771
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. |
3069
+
1772
3070
  ---
1773
3071
 
1774
3072
  ### `equity.price.performance`
@@ -1794,6 +3092,33 @@ Summary: Performance
1794
3092
  |---|---|---|---|---|
1795
3093
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1796
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. |
3121
+
1797
3122
  ---
1798
3123
 
1799
3124
  ### `equity.price.quote`
@@ -1822,6 +3147,33 @@ Summary: Quote
1822
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. |
1823
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. |
1824
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. |
3176
+
1825
3177
  ---
1826
3178
 
1827
3179
  ### `equity.profile`
@@ -1847,6 +3199,39 @@ Summary: Profile
1847
3199
  |---|---|---|---|---|
1848
3200
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
1849
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. |
3234
+
1850
3235
  ---
1851
3236
 
1852
3237
  ### `equity.screener`
@@ -1899,6 +3284,38 @@ Summary: Screener
1899
3284
  | `region` | `no` | `string` | `all` | Filter by region. Multiple comma separated items allowed. |
1900
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. |
1901
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. |
3318
+
1902
3319
  ---
1903
3320
 
1904
3321
  ### `equity.search`
@@ -1930,6 +3347,25 @@ Summary: Search
1930
3347
  | `is_etf` | `no` | `boolean` | `false` | If True, returns only ETFs. |
1931
3348
  | `is_fund` | `no` | `boolean` | `false` | Whether to direct the search to the list of mutual funds and ETFs. |
1932
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. |
3368
+
1933
3369
  ---
1934
3370
 
1935
3371
  ### `equity.shorts.fails_to_deliver`
@@ -1958,6 +3394,17 @@ Summary: Fails To Deliver
1958
3394
  | `skip_reports` | `no` | `integer | null` | `0` | Skip N number of reports from current. A value of 1 will skip the most recent report. |
1959
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. |
1960
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. |
3407
+
1961
3408
  ---
1962
3409
 
1963
3410
  ### `equity.shorts.short_interest`
@@ -1982,3 +3429,18 @@ Summary: Short Interest
1982
3429
  | Param | Required | Type | Default | Notes |
1983
3430
  |---|---|---|---|---|
1984
3431
  | `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
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. |