Files
OpenBB/openbb_platform/extensions/equity
montezdesousa 6095c4314f [Feature] - Equity router descriptions & examples (#6103)
* feat: equity/calendar

* feat: compare router

* fix descriptions

* darkpool + discovery

* fix paragraph issues

* fix descriptions

* fundamental part 1

* fundamental part2

* transcipts

* ownership

* fix

* price

* shorts

* Update darkpool_router.py

* minor fix

* shorts examples

* examples

* ruff

* black

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
2024-02-22 14:04:26 +00:00
..
2023-11-13 15:03:31 +00:00
2024-02-15 11:37:00 -05:00
2024-02-15 11:37:00 -05:00

OpenBB Equity Extension

This extension provides equity market data tools for the OpenBB Platform.

Features of the Equity extension include:

  • Access to various equity market data sources
  • Sub-modules such as:
    • calendar for equity-specific events
    • compare for peer analysis
    • darkpool for dark pool shorts data
    • discovery for equity discovery
    • estimates for analyst estimates
    • fundamental for fundamental analysis
    • options for options
    • ownership for internal and external ownership
    • price for historical pricing data
    • shorts for shorts data

Installation

To install the extension, run the following command in this folder:

pip install openbb-equity

For development please check Contribution Guidelines.

Documentation available here.