Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] SEC - Management Discussion & Analysis Sections #7006

Open
wants to merge 29 commits into
base: develop
Choose a base branch
from

Conversation

deeleeramone
Copy link
Contributor

@deeleeramone deeleeramone commented Jan 19, 2025

Beta Feature

  1. Why?:

    • Extends the SEC functionality and brings in data that is not readily found programatically.

    • Key company disclosures are made within this text and it is not part of the structured financial statements.

  2. What?:

    • New endpoint:
      • obb.equity.fundamental.management_discussion_analysis()
    • Parameters:
      • symbol - required
      • calendar year - optional
      • calendar period - optional
      • include_tables - optional (false)
      • raw_html - optional (false)
        • Use this if/when extraction fails, or you simply want the complete HTML filing.
    • Returns:
      • Dictionary with the text string in the "content" key.
        • Text has markdown formatting for "**<h2><h3>** " and tables.
  3. Impact:

  4. Testing Done:

    • Various - WIP
    • Generally, issues will be related to "include_tables=True". Definitely open to help on broad solutions for huge variations in content.
  5. Reviewer Notes:

    • You will need to run dev_install.py and then rebuild the static assets to run the function.

Example:

Screenshot 2025-01-18 at 11 32 04 PM

Example with tables:

Screenshot 2025-01-22 at 2 25 23 PM

Example Bad Tables (can potentially be saved post-request, information is discernible with some assembly required):

Screenshot 2025-01-22 at 2 16 57 PM

Example Failed Tables (likely unrecoverable ):

Screenshot 2025-01-26 at 8 30 08 PM

Successful Format Variation:

Screenshot 2025-01-19 at 12 42 03 AM

Embedded Images:

Screenshot 2025-01-19 at 1 25 30 AM

@github-actions github-actions bot added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 breaking_change labels Jan 19, 2025
@deeleeramone deeleeramone marked this pull request as ready for review January 27, 2025 04:54
@deeleeramone deeleeramone requested a review from piiq January 27, 2025 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking_change enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant