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] Compare Company Facts (SEC) #6444

Merged
merged 10 commits into from
May 21, 2024
Merged

Conversation

deeleeramone
Copy link
Contributor

  1. Why?:

    • This endpoint provides the ability to compare single line items in financial statements across multiple, or all, companies reporting that particular metric. This is similar to obb.equity.fundamental.historical_attributes

Screenshot 2024-05-20 at 3 25 12 PM

  1. What?:

    • obb.equity.compare.company_facts(provider="sec")

    • This utilizes the "Frames" and "Company Concept" APIs from the SEC.

      • Not supplying a symbol utilizes "Frames" and returns all companies reporting that particular field during that calendar period.
      • When a symbol(s) is supplied, it returns the "Concept" as-reported, with the option to filter by fiscal year.
  2. Impact (1-2 sentences or a bullet point list):

    • The Literal choices for fact is very large.
  3. Testing Done:

    • Unit/Integration tests.
    • CLI
    • Good/Bad combinations of parameters.

Screenshot 2024-05-20 at 3 27 59 PM

@IgorWounds IgorWounds added this pull request to the merge queue May 21, 2024
Merged via the queue into develop with commit bf20807 May 21, 2024
9 checks passed
@IgorWounds IgorWounds deleted the feature/compare-company-facts branch May 21, 2024 07:59
@dijonkitchen
Copy link

Thanks for this PR!

It is a public service given how hard it is to consume SEC public filing data.

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.

3 participants