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] Add SEC As Provider To equity.ownership.insider_trading #6947

Merged
merged 13 commits into from
Nov 25, 2024

Conversation

deeleeramone
Copy link
Contributor

@deeleeramone deeleeramone commented Nov 15, 2024

  1. Why?:

    • Expand the coverage of data directly from the SEC.
  2. What?:

    • Adds sec as a provider to, obb.equity.ownership
  3. Impact:

    • Download historical filings is a relatively expensive I/O transaction to the SEC, this persists downloaded forms permanently as a parsed, compressed, SQL database in the user_cache_directory.
    • Using the cache can be disabled with use_cache=False
    • A narrow width between start/end dates should be used, some companies have few, or no, insider transactions, while others have hundreds every year - CRM. Approach as a drinking fountain vs. a fire hose.
    • For SEC, default start date is 120 days ago, if not supplied.
  4. Testing Done:

    • Unit/integration.

Screenshot 2024-11-15 at 3 25 10 PM

A message will display how many cached vs. uncached items there are for the current request.

Screenshot 2024-11-15 at 3 40 34 PM

A note urges caution with requesting wide date ranges.

Screenshot 2024-11-15 at 4 31 05 PM

@deeleeramone deeleeramone added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 labels Nov 15, 2024
@deeleeramone deeleeramone added this pull request to the merge queue Nov 25, 2024
Merged via the queue into develop with commit bde8aba Nov 25, 2024
10 checks passed
@IgorWounds IgorWounds deleted the feature/sec-insider-trading branch December 1, 2024 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants