mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
docs/working-docs: Working V4 Docs PR (#5747)
* post-install clarification, fix links * more links * change word * toolkit cleanup * rename 'contributing' to 'development' * update extensions * some urls * Update sdk-platform and v4-develop in urls (#5730) * Update sdk-platform and v4-develop in urls * Seprate Intrinio financials data tags into a different command (#5723) * add `ebit` field in income statement standard model * only add required data tags * remove calculations data * use `name` key instead of `tag` key * set `period` as required in data * remove `period` and `cik` from provider models * add `equity/fundamental/search_financial_attributes` with tests * clean descriptions file * add `equity/fundamental/financial_attributes` with tests * set `value` as `Optional` * Fix threadpool test error (#5734) * Remove ultima from deps (#5736) * remove ultima from deps * skip ultima test * black * change skip location * try except statement to avoid error on the ci * new currency reference rates pr (#5724) * point files to linters (#5739) * remove news from equity (#5741) * Add tiingo provider (#5740) * first commit * things * Add news endpoints * CryptoHistorical * Add currency and trailing dividend yield * things working * deps * fix pre commit things * tests? * black on the tests * pratty told me to add it * integration tests * added helpers * crypto revamped * currency revamped * trailing dividend yield revamped * equity historical revamped * company news overhauled * global news overhauled * remove `tags` param from news models * crypto correct `exchanges` description * james smh * re-recorded fetcher tests * fixed integration tests * econometrics smh * james smh again --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Add `derivatives` extension for `futures` and `options` (#5742) * removed options and futures * add derivatives extension * cleanup * bug #5649 (#5722) * bug #5649 * fixing --a upmom, downmom --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> * Rename the fmp search -> screener (#5744) * Rename the fmp search -> screener * misses some * i cant copy paste * docs/fix-urls: Updates the Terminal About URLs to match `/develop` (#5720) * update Terminal about URLs and some other broken links * ruff * intro * changing the heading levels * dependency management sections * structure * developer guides * structure * contributor guides * keywords and descriptions * broken urls * cool cards * Cool cards (#5727) * tidy up terminal/content * some more tidy up * fix styling for platform that was missing * more tidy up * improve color for dark and light mode * create new reference card for more basic cards * rename back to menus * implement all index.md for terminal, except reference * improve bot title * more refactoring * fix remaining index * header styling * more styling * heheheheheheeh * Revert "heheheheheheeh" This reverts commit7d095fcfd2. * Ccards (#5733) * links * more links * improved styling and chevron aligned to title * fix index.mdx urls for Terminal * update package.json * update index.mdx * fix generation * spelling * toolkit_extensions * update data extensions * couple of links * add tiingo to data extensions list --------- Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> Co-authored-by: James Maslek <jmaslek11@gmail.com> * Stock leftover cleanup (#5745) * change to equity in `.md` files * `HistoricalStockSplits`->`HistoricalSplits` * `StockInsiderTrading`->`InsiderTrading` * sorry fmp * `EquityHistorical` cleanup * `EquityNBBO` cleanup * .md leftover * the last of stocks * post-install clarification, fix links * more links * change word * toolkit cleanup * rename 'contributing' to 'development' * Hotfix/urllib to dev group (#5732) * use the urllib3 dependency on the dev group instead * adapt the version script for the nightlies - if it's a nightly the package distribution name will have a different name * add dev dependencies to the dev installation bc of the ci * updating the import on validate_call according to: https://docs.pydantic.dev/latest/concepts/validation_decorator/ the way we were importing it breaks if pydantic=2.5 @montezdesousa * loosing urllib3 version specification on the provider and adding it to platform dev deps * rmeoving urllib from top level deps; and removing --with dev flag * changing to ^ instead * Revert "changing to ^ instead" This reverts commit7300904e9f. * unnecessary dep --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> * feature/v4-bop - Add ECB Balance of Payments (Replaces #5716) (#5726) * add ecb balance of payments * missing __init__.py files * Nasdaq calendar earnings and fix FMP calendar earnings (#5718) Co-authored-by: James Maslek <jmaslek11@gmail.com> * feature/us-treasury-auctions: Adds Treasury Auctions endpoint and provider for US Government Data. (#5746) * add government_us provider and treasury auctions endpoint * black * add param for cusip * move logic for setting default start/end date * Update hub<>platform credentials map (#5749) * update hub<>platform credentials map * typo * Add API settings schema to system settings (#5743) Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> * Skip checking creds (#5737) * skip checking creds * fix bug * ok mypy * add comment * rename required_credentials * fix * fix top_retail bug * don't require creds in some nasdaq fetchers * black * this was not here before * fix tests * update fetcher test * update contributing guidelines * Fix Quote (#5752) * Fix Quote * fixed return type and model validation --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * Wrap up renaming global news to world news on a model level (#5750) * Wrap up renaming global news to world news on a model level * cleanup --------- Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> * update extensions * some urls * Revert changes to v3 docs --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Ramazan <guvencramazan@yandex.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt> * POST request example * update post example * find symbols * market calendars * codespell * codespell ftw * improve main page light mode --------- Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com> Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu> Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com> Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Ramazan <guvencramazan@yandex.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com> Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
This commit is contained in:
Danglewood
5
openbb_platform/README.md
vendored
5
openbb_platform/README.md
vendored
@@ -1,3 +1,5 @@
|
||||
# OpenBB Platform
|
||||
|
||||
[](https://pepy.tech/project/openbb)
|
||||
[](https://github.com/OpenBB-finance/OpenBBTerminal)
|
||||
|
||||
@@ -6,7 +8,7 @@
|
||||
|  |
|
||||
| Check our website at [openbb.co](www.openbb.co) |
|
||||
|
||||
## OpenBB Platform Overview
|
||||
## Overview
|
||||
|
||||
The OpenBB Platform provides a convenient way to access raw financial data from multiple data providers. The package comes with a ready to use REST API - this allows developers from any language to easily create applications on top of OpenBB Platform.
|
||||
|
||||
@@ -29,7 +31,6 @@ pip install openbb[all] --pre
|
||||
``````
|
||||
|
||||
> The `--pre` flag is required to install the latest alpha version.
|
||||
|
||||
> Note: These instruction are specific to v4. For installation instructions and documentation for v3 go to our [website](https://docs.openbb.co/sdk).
|
||||
|
||||
## Python
|
||||
|
||||
4
openbb_platform/extensions/crypto/README.md
vendored
4
openbb_platform/extensions/crypto/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-crypto
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-currency
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-econometrics
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/extensions/economy/README.md
vendored
4
openbb_platform/extensions/economy/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-economy
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/extensions/equity/README.md
vendored
4
openbb_platform/extensions/equity/README.md
vendored
@@ -25,6 +25,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-equity
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -12,6 +12,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-fixedincome
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/extensions/index/README.md
vendored
4
openbb_platform/extensions/index/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-index
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/extensions/news/README.md
vendored
4
openbb_platform/extensions/news/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-news
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -14,6 +14,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-qa
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -10,6 +10,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-regulators
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -14,6 +14,6 @@ To install the extension, run the following command in this folder:
|
||||
pip install openbb-technical
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-alpha-vantage
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/benzinga/README.md
vendored
4
openbb_platform/providers/benzinga/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-benzinga
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/cboe/README.md
vendored
4
openbb_platform/providers/cboe/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-cboe
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/ecb/README.md
vendored
4
openbb_platform/providers/ecb/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-ecb
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/finra/README.md
vendored
4
openbb_platform/providers/finra/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-finra
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/fmp/README.md
vendored
4
openbb_platform/providers/fmp/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-fmp
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/fred/README.md
vendored
4
openbb_platform/providers/fred/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-fred
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/intrinio/README.md
vendored
4
openbb_platform/providers/intrinio/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-intrinio
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/nasdaq/README.md
vendored
4
openbb_platform/providers/nasdaq/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-nasdaq
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/polygon/README.md
vendored
4
openbb_platform/providers/polygon/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-polygon
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/sec/README.md
vendored
4
openbb_platform/providers/sec/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-sec
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-seeking-alpha
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-stockgrid
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-tradingeconomics
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/ultima/README.md
vendored
4
openbb_platform/providers/ultima/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-ultima
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/wsj/README.md
vendored
4
openbb_platform/providers/wsj/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-wsj
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
4
openbb_platform/providers/yfinance/README.md
vendored
4
openbb_platform/providers/yfinance/README.md
vendored
@@ -10,6 +10,6 @@ To install the extension:
|
||||
pip install openbb-yfinance
|
||||
```
|
||||
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/feature/openbb-sdk-v4/openbb_platform/CONTRIBUTING.md).
|
||||
For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
|
||||
|
||||
Documentation available [here](https://docs.openbb.co/sdk).
|
||||
Documentation available [here](https://docs.openbb.co/platform).
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Contributing",
|
||||
"position": 6
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
title: Introduction
|
||||
sidebar_position: 1
|
||||
description: This introduction to the Contributor Guidelines provides an overview of how to enhance the OpenBB Platform's codebase. It highlights the various ways to contribute, from adding new data points and commands to creating new extensions and improving documentation.
|
||||
keywords:
|
||||
- OpenBB Contributor Guidelines
|
||||
- Codebase enhancement
|
||||
- OpenBB extensions
|
||||
- Documentation improvement
|
||||
- OpenBB Platform contribution
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Introduction - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
|
||||
The Contributor Guidelines are intended to be a continuation of the [Developer Guidelines](/platform/contributing/developer-guidelines/expecations_for_developers). They are not a replacement, but rather an expansion, focusing specifically on those who seek to directly enhance the OpenBB Platform's codebase. It's crucial for Contributors to be familiar with both sets of guidelines to ensure a harmonious and productive engagement with the OpenBB Platform.
|
||||
|
||||
There are many ways to contribute to the OpenBB Platform. You can add a [new data point](/platform/contributing/developer-guidelines/add_data_point), add a [new command](/platform/contributing/developer-guidelines/add_custom_data_sources#openbb-platform-commands), add a [new visualization](/openbb_platform/extensions/charting/README.md), add a [new extension](/platform/contributing/developer-guidelines/build_openbb_extensions), fix a bug, improve or create documentation, etc.
|
||||
4
website/content/platform/development/_category_.json
vendored
Normal file
4
website/content/platform/development/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Development",
|
||||
"position": 6
|
||||
}
|
||||
@@ -19,7 +19,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Expectations For Contributors - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Expectations For Contributors - Contributor Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
1. Use Cases:
|
||||
- Ensure that your contributions directly enhance the OpenBB Platform's functionality or extension ecosystem.
|
||||
19
website/content/platform/development/contributor-guidelines/index.md
vendored
Normal file
19
website/content/platform/development/contributor-guidelines/index.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: Introduction
|
||||
sidebar_position: 1
|
||||
description: This introduction to the Contributor Guidelines provides an overview of how to enhance the OpenBB Platform's codebase. It highlights the various ways to contribute, from adding new data points and commands to creating new extensions and improving documentation.
|
||||
keywords:
|
||||
- OpenBB Contributor Guidelines
|
||||
- Codebase enhancement
|
||||
- OpenBB extensions
|
||||
- Documentation improvement
|
||||
- OpenBB Platform contribution
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Introduction - Contributor Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
The Contributor Guidelines are intended to be a continuation of the [Developer Guidelines](/platform/development/developer-guidelines/expecations_for_developers). They are not a replacement, but rather an expansion, focusing specifically on those who seek to directly enhance the OpenBB Platform's codebase. It's crucial for Contributors to be familiar with both sets of guidelines to ensure a harmonious and productive engagement with the OpenBB Platform.
|
||||
|
||||
There are many ways to contribute to the OpenBB Platform. You can add a [new data point](/platform/development/developer-guidelines/add_data_point), add a [new command](/platform/development/developer-guidelines/add_custom_data_sources#openbb-platform-commands), add a [new visualization](/platform/extensions/toolkit_extensions#charting), add a [new extension](/platform/development/developer-guidelines/build_openbb_extensions), fix a bug, improve or create documentation, etc.
|
||||
@@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Manage Extensions - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Manage Extensions - Contributor Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
To install an extension hosted on PyPI, use the `pip install <extension>` command.
|
||||
|
||||
@@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Quality Assurance - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Quality Assurance - Contributor Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
We are strong believers in the Quality Assurance (QA) process and we want to make sure that all the extensions that are added to the OpenBB Platform are of high quality. To ensure this, we have a set of QA tools that you can use to test your extension.
|
||||
|
||||
@@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Sharing Your Extension - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Sharing Your Extension - Contributor Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
We encourage you to share your extension with the community. You can do that by publishing it to PyPI.
|
||||
|
||||
@@ -13,7 +13,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Write Code and Commit - Contributor Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Write Code and Commit - Contributor Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
## How to create a PR?
|
||||
|
||||
@@ -13,7 +13,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Dependency Management - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Dependency Management - Development | OpenBB Platform Docs" />
|
||||
|
||||
## High-Level Overview
|
||||
|
||||
@@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Add Custom Data Sources - Developer Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Add Custom Data Sources - Developer Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
You will get your data either from a CSV file, local database or from an API endpoint.
|
||||
|
||||
@@ -13,7 +13,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Add a Data Point - Developer Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Add a Data Point - Developer Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
In this section, we'll be adding a new data point to the OpenBB Platform. We will add a new provider with an existing [standard data](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_platform/platform/provider/openbb_provider/standard_models) model.
|
||||
|
||||
@@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Architectural Considerations - Developer Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Architectural Considerations - Developer Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
## Important classes
|
||||
|
||||
@@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Build OpenBB Extensions - Developer Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Build OpenBB Extensions - Developer Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
We have a **Cookiecutter** template that will help you get started. It serves as a jumpstart for your extension development, so you can focus on the data and not on the boilerplate.
|
||||
|
||||
@@ -12,7 +12,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Expectations for Developers - Developer Guidelines - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Expectations for Developers - Developer Guidelines - Development | OpenBB Platform Docs" />
|
||||
|
||||
1. Use Cases:
|
||||
- Ensure that your extensions or features align with the broader goals of the application.
|
||||
@@ -21,7 +21,7 @@ keywords:
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Introduction - Contributing | OpenBB Platform Docs" />
|
||||
<HeadTitle title="Introduction - Development | OpenBB Platform Docs" />
|
||||
|
||||
## Considerations
|
||||
|
||||
@@ -37,7 +37,7 @@ The OpenBB Platform is designed as a foundation for further development. We anti
|
||||
|
||||
The **Developer** role, as defined in this document, can be thought of as the foundational role. Developers are those who use the OpenBB Platform as is or build upon it.
|
||||
|
||||
Conversely, the **Contributor** role refers to those who enhance the OpenBB Platform codebase (either by directly adding to the OpenBB Platform or by extending the [extension repository]((https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/EXTENSIONS.md))). Contributors are willing to go the extra mile, spending additional time on quality assurance, testing, or collaborating with the OpenBB development team to ensure adherence to standards, thereby giving back to the community.
|
||||
Conversely, the **Contributor** role refers to those who enhance the OpenBB Platform codebase (either by directly adding to the OpenBB Platform or by extending the [extension repository](/platform/extensions)). Contributors are willing to go the extra mile, spending additional time on quality assurance, testing, or collaborating with the OpenBB development team to ensure adherence to standards, thereby giving back to the community.
|
||||
|
||||
## Quick look into the OpenBB Platform
|
||||
|
||||
@@ -97,7 +97,7 @@ Usage of these models will unlock a set of perks that are only available to stan
|
||||
|
||||
The standard models are defined under the `/OpenBBTerminal/openbb_platform/platform/core/provider/openbb_provider/standard_models/` directory.
|
||||
|
||||
They define the [`QueryParams`](platform/provider/openbb_provider/abstract/query_params.py) and [`Data`](platform/provider/openbb_provider/abstract/data.py) models, which are used to query and output data. They are pydantic and you can leverage all the pydantic features such as validators.
|
||||
They define the [`QueryParams`](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/platform/provider/openbb_provider/abstract/query_params.py) and [`Data`](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/platform/provider/openbb_provider/abstract/data.py) models, which are used to query and output data. They are pydantic and you can leverage all the pydantic features such as validators.
|
||||
|
||||
#### Standardization Caveats
|
||||
|
||||
@@ -66,6 +66,7 @@ pip uninstall openbb-yfinance
|
||||
| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector. | pip install openbb-finra | Community | None / Free |
|
||||
| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector. | pip install openbb-fmp | Core | Free |
|
||||
| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector. | pip install openbb-fred | Core | Free |
|
||||
| openbb-government-us | [US Government](https://data.gov) data connector. | pip install openbb-us-government | Core | None |
|
||||
| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector. | pip install openbb-intrinio | Core | Paid |
|
||||
| openbb-nasdaq | [Nasdaq Data Link](https://data.nasdaq.com/) connector. | pip install openbb-nasdaq | Community | None / Free |
|
||||
| openbb-oecd | [OECD](https://data.oecd.org/) data connector. | pip install openbb-oecd | Core | Free |
|
||||
|
||||
@@ -31,6 +31,7 @@ OpenBB Toolkit Extensions expand the Platform with functions for manipulating da
|
||||
| Extension Name | Description | Installation Command | Core/Community | Router Path |
|
||||
|:-----------------|:-----------:|:-------------------:|:------------------:|-------------:|
|
||||
| openbb-charting | Rest API charting service and Plotly library. | pip install openbb-charting | Community | N/A |
|
||||
| openbb-devtools | Aggregates dependencies that facilitate a nice development experience for OpenBB. | pip install openbb-devtools | N/A |
|
||||
| openbb-econometrics | Econometrics models for the Python interface only. | pip install openbb-econometrics | Community | obb.econometrics |
|
||||
| openbb-quantitative | Functions for performing quantitative analysis. | pip install openbb-quantitative | Community | obb.quantitative |
|
||||
| openbb-technical | Functions for performing technical analysis. | pip install openbb-technical | Community | obb.technical |
|
||||
@@ -89,14 +90,44 @@ When using Linux distributions, the PyWry dependency requires certain dependenci
|
||||
- Fedora:
|
||||
`sudo dnf install gtk3-devel webkit2gtk3-devel`
|
||||
|
||||
## Devtools
|
||||
|
||||
This extension aggregates the dependencies that facilitate a nice development experience
|
||||
for OpenBB. It does not contain any code itself, but rather pulls in the following dependencies:
|
||||
|
||||
- bandit
|
||||
- black
|
||||
- ipykernel
|
||||
- mypy
|
||||
- poetry
|
||||
- pre-commit
|
||||
- pydocstyle
|
||||
- pylint
|
||||
- pytest
|
||||
- pytest-cov
|
||||
- ruff
|
||||
- tox
|
||||
- types-python-dateutil
|
||||
- types-toml
|
||||
|
||||
### Installation
|
||||
|
||||
The extension is included in the dev_install.py script.
|
||||
|
||||
Standalone installation:
|
||||
|
||||
```console
|
||||
pip install openbb-devtools
|
||||
```
|
||||
|
||||
## Econometrics
|
||||
|
||||
The `openbb-econometrics` extension installs a new router path (`obb.econometrics`) and additional Python libraries:
|
||||
|
||||
- scipy = "^1.10.1"
|
||||
- statsmodels = "^0.14.0"
|
||||
- arch = "^5.5.0"
|
||||
- linearmodels = "<=4.25"
|
||||
- scipy
|
||||
- statsmodels
|
||||
- arch
|
||||
- linearmodels
|
||||
|
||||
:::note
|
||||
This extension is not accessible via REST API because `statsmodels` is not serializable.
|
||||
|
||||
2
website/content/platform/index.md
vendored
2
website/content/platform/index.md
vendored
@@ -24,4 +24,4 @@ Developing and maintaining a full-blown investment research infrastructure from
|
||||
|
||||
---
|
||||
|
||||
Want to contribute? Check out our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
|
||||
Want to contribute? Check out our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/CONTRIBUTING.md).
|
||||
|
||||
6
website/content/platform/installation.md
vendored
6
website/content/platform/installation.md
vendored
@@ -140,7 +140,7 @@ git clone git@github.com:OpenBB-finance/OpenBBTerminal.git
|
||||
When it is done, checkout the branch where the code is living:
|
||||
|
||||
```console
|
||||
git checkout feature/openbb-sdk-v4
|
||||
git checkout develop
|
||||
```
|
||||
|
||||
Then, `cd` into the directory:
|
||||
@@ -159,7 +159,9 @@ python dev_install.py
|
||||
To install all extensions and providers, run: `python dev_install.py -e`
|
||||
:::
|
||||
|
||||
With a fresh installation, or upon installing or uninstalling extensions, the Python interface needs to be built. This is done automatically, but can be manually triggered if required. Start a Python session and then `import openbb`:
|
||||
## Post-Installation
|
||||
|
||||
With a fresh installation, and upon installing or uninstalling extensions, the Python interface needs to be built. This is done automatically, but can be manually triggered if required. Start a Python session and then `import openbb`:
|
||||
|
||||
```console
|
||||
python
|
||||
|
||||
73
website/content/platform/usage/basic_syntax.md
vendored
73
website/content/platform/usage/basic_syntax.md
vendored
@@ -202,8 +202,79 @@ data.warnings
|
||||
[Warning_(category='OpenBBWarning', message="Parameter 'source' is not supported by fmp. Available for: intrinio.")]
|
||||
```
|
||||
|
||||
## REST API POST Requests
|
||||
|
||||
Most endpoints are for data retrieval, but some [toolkit extensions](/platform/extensions/toolkit_extensions) require data to pass through the function. In these instances, it must be a POST request, and JSON.
|
||||
|
||||
### Example
|
||||
|
||||
This example will use a GET request to fetch daily VIX data from the Cboe data extension, and then make a POST request which passes through the data to a technical analysis function.
|
||||
|
||||
First, start a development server.
|
||||
|
||||
```bash
|
||||
uvicorn openbb_core.api.rest_api:app --reload
|
||||
```
|
||||
|
||||
This example will use Python and the Requests library, so the syntax will vary according to the preferred medium for interacting with the API.
|
||||
|
||||
#### Fetch Some Data
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
get_url = "http://127.0.0.1:8000/api/v1/index/market?provider=cboe&symbol=vix&interval=1d"
|
||||
get_response = requests.get(get_url)
|
||||
data_results = get_response.json()["results"]
|
||||
|
||||
data_results[-1]
|
||||
```
|
||||
|
||||
```json
|
||||
{'date': '2023-11-17T00:00:00',
|
||||
'open': 14.18,
|
||||
'high': 14.19,
|
||||
'low': 13.67,
|
||||
'close': 13.79,
|
||||
'volume': 0,
|
||||
'calls_volume': None,
|
||||
'puts_volume': None,
|
||||
'total_options_volume': None}
|
||||
```
|
||||
|
||||
#### Send a POST Request
|
||||
|
||||
Next, pass the `data_results` to a function, using the `json` field in the POST headers. For this example, realized volatiliy cones, the default parameters assume the time series data is daily and that volatility should be annualized over 252 trading days.
|
||||
|
||||
The `index` parameter tells the function which field in the posted data to use as the date index.
|
||||
|
||||
```python
|
||||
import pandas as pd
|
||||
|
||||
post_url = "http://localhost:8000/api/v1/technical/cones"
|
||||
post_response = requests.post(post_url, json=data_results)
|
||||
ta_results = post_response.json()["results"]
|
||||
|
||||
pd.DataFrame.from_records(ta_results)
|
||||
```
|
||||
|
||||
| window | realized | min | lower_25% | median | upper_75% | max |
|
||||
|---------:|-----------:|-----------:|------------:|---------:|------------:|--------:|
|
||||
| 3 | 0.396165 | 0.00701638 | 0.444709 | 0.72414 | 1.11563 | 8.47636 |
|
||||
| 10 | 0.623199 | 0.190188 | 0.665584 | 0.852915 | 1.15491 | 4.83264 |
|
||||
| 30 | 0.988435 | 0.332913 | 0.750007 | 0.921482 | 1.17072 | 2.98404 |
|
||||
| 60 | 0.932594 | 0.47639 | 0.792548 | 0.964617 | 1.20171 | 2.35563 |
|
||||
| 90 | 0.915137 | 0.551011 | 0.815229 | 0.965553 | 1.2128 | 2.04104 |
|
||||
| 120 | 0.858644 | 0.549233 | 0.836395 | 0.983437 | 1.21097 | 1.86416 |
|
||||
| 150 | 0.898628 | 0.557274 | 0.842359 | 0.991539 | 1.23165 | 1.73182 |
|
||||
| 180 | 0.902293 | 0.579575 | 0.84876 | 1.00421 | 1.23584 | 1.68786 |
|
||||
| 210 | 0.901717 | 0.580214 | 0.854655 | 0.996992 | 1.2271 | 1.65739 |
|
||||
| 240 | 0.884282 | 0.587564 | 0.857935 | 1.00491 | 1.22141 | 1.62973 |
|
||||
| 300 | 0.852533 | 0.622105 | 0.862097 | 1.00724 | 1.21705 | 1.51887 |
|
||||
| 360 | 0.847416 | 0.661648 | 0.869691 | 1.03923 | 1.20488 | 1.48571 |
|
||||
|
||||
## References
|
||||
|
||||
All functions, parameters, and responses are detailed under the [Reference pages](/platform/reference/fixedincome/ycrv). The data models for each provider source are described within the [Data Models](/platform/data_models/StockHistorical) pages.
|
||||
All functions, parameters, and responses are detailed under the [Reference pages](/platform/reference). The data models for each provider source are described within the [Data Models](/platform/data_models) pages.
|
||||
|
||||
These pages are a quick way to cross-reference differences between providers. The same information is provided in a function's signature and docstring.
|
||||
|
||||
315
website/content/platform/usage/find_symbols.md
vendored
Normal file
315
website/content/platform/usage/find_symbols.md
vendored
Normal file
@@ -0,0 +1,315 @@
|
||||
---
|
||||
title: Finding Symbols
|
||||
sidebar_position: 3
|
||||
description: This page provides comprehensive information about finding stocks in the
|
||||
with the OpenBB Platform. Search companies from different sources, and filter results.
|
||||
This guide is intended to introduce some methods for searching, screening, and discovery.
|
||||
keywords:
|
||||
- stocks
|
||||
- companies
|
||||
- how to find
|
||||
- stocks from India
|
||||
- countries
|
||||
- regions
|
||||
- screen
|
||||
- search
|
||||
- ticker
|
||||
- sector
|
||||
- industry
|
||||
- market caps
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Finding Symbols - Usage | OpenBB Platform Docs" />
|
||||
|
||||
Finding the ticker symbol, security identifier, the sector, and other metadata is easy if you know where to look. This guide is intended to introduce some methods for searching, screening, and discovery.
|
||||
|
||||
:::note
|
||||
For maximum coverage and functionality, install OpenBB with `[all]` packages.
|
||||
|
||||
The examples on this page will assume that the OpenBB Platform has been installed, the environment is active, and it has been imported into a Python session.
|
||||
|
||||
```python
|
||||
from openbb import obb
|
||||
```
|
||||
|
||||
If the installation is fresh, or an extension was just installed, the Python interface will need to be rebuilt. It will only take a few moments to complete.
|
||||
:::
|
||||
|
||||
The simplest way to find a ticker for a company is with a simple fuzzy query.
|
||||
|
||||
## Search the SEC
|
||||
|
||||
Perform a quick search using the `openbb-sec` provider.
|
||||
|
||||
### Find a Company
|
||||
|
||||
Use an empty string, `""`, to return the complete list - over 10,000.
|
||||
|
||||
```python
|
||||
all_companies = obb.equity.search("", provider="sec")
|
||||
|
||||
len(all_companies.results)
|
||||
```
|
||||
|
||||
```bash
|
||||
Out: 10840
|
||||
```
|
||||
|
||||
The SEC sorts this list by market cap. Applying the `to_df()` method to `all_companies` will show Apple on top
|
||||
|
||||
```python
|
||||
all_companies.to_df().head(10)
|
||||
```
|
||||
|
||||
| symbol | name | cik |
|
||||
|:---------|:-----------------------|--------:|
|
||||
| AAPL | Apple Inc. | 320193 |
|
||||
| MSFT | MICROSOFT CORP | 789019 |
|
||||
| GOOGL | Alphabet Inc. | 1652044 |
|
||||
| AMZN | AMAZON COM INC | 1018724 |
|
||||
| NVDA | NVIDIA CORP | 1045810 |
|
||||
| META | Meta Platforms, Inc. | 1326801 |
|
||||
| BRK-B | BERKSHIRE HATHAWAY INC | 1067983 |
|
||||
| TSLA | Tesla, Inc. | 1318605 |
|
||||
| LLY | ELI LILLY & Co | 59478 |
|
||||
| V | VISA INC. | 1403161 |
|
||||
|
||||
:::tip
|
||||
This endpoint can be used to map a ticker symbol to a CIK number.
|
||||
:::
|
||||
|
||||
### Find an Institution
|
||||
|
||||
Some reporting companies, like invesment trusts and insurance companies, do not have a ticker symbol directly associated with them. Filers in the US will have a CIK number, used to retrieve documents from the SEC.
|
||||
|
||||
```python
|
||||
obb.regulators.sec.institutions_search("Berkshire Hathaway").to_df()
|
||||
```
|
||||
|
||||
| name | cik |
|
||||
|:-------------------------------------------------|-----------:|
|
||||
| BERKSHIRE HATHAWAY ENERGY CO | 0001081316 |
|
||||
| BERKSHIRE HATHAWAY FINANCE CORP | 0001274791 |
|
||||
| BERKSHIRE HATHAWAY HOME STATE INSURANCE CO. | 0000829771 |
|
||||
| BERKSHIRE HATHAWAY INC /DE/ | 0000109694 |
|
||||
| BERKSHIRE HATHAWAY INC/DE | 0000109694 |
|
||||
| BERKSHIRE HATHAWAY INC | 0001067983 |
|
||||
| BERKSHIRE HATHAWAY LIFE INSURANCE CO OF NEBRASKA | 0001015867 |
|
||||
| LMZ & BERKSHIRE HATHAWAY CO | 0001652795 |
|
||||
|
||||
### Find a Filing
|
||||
|
||||
Search for filings by CIK or ticker symbol.
|
||||
|
||||
```python
|
||||
homestate_filings = obb.equity.fundamental.filings(cik="0000829771", provider="sec")
|
||||
|
||||
homestate_filings.to_df().iloc[-1]
|
||||
```
|
||||
|
||||
| | 2023-11-14 |
|
||||
|:------------------------|:-----------------------------------------------------------------------------------------------------|
|
||||
| type | 13F-NT |
|
||||
| link | https://www.sec.gov/Archives/edgar/data/0000829771/000095012323010929/xslForm13F_X02/primary_doc.xml |
|
||||
| report_date | 2023-09-30 |
|
||||
| accepted_date | 2023-11-14 16:15:06+00:00 |
|
||||
| act | 34 |
|
||||
| primary_doc_description | |
|
||||
| primary_doc | xslForm13F_X02/primary_doc.xml |
|
||||
| accession_number | 0000950123-23-010929 |
|
||||
| file_number | 028-02226 |
|
||||
| film_number | 231406391 |
|
||||
| is_inline_xbrl | 0 |
|
||||
| is_xbrl | 0 |
|
||||
| size | 2960 |
|
||||
| complete_submission_url | https://www.sec.gov/Archives/edgar/data/0000829771/0000950123-23-010929.txt |
|
||||
| filing_detail_url | https://www.sec.gov/Archives/edgar/data/0000829771/0000950123-23-010929-index.htm |
|
||||
|
||||
Or, search by form type.
|
||||
|
||||
```python
|
||||
obb.equity.fundamental.filings("AAPL", type="4", provider="sec").to_df().iloc[-1]
|
||||
```
|
||||
|
||||
| | 2023-11-14 |
|
||||
|:------------------------|:---------------------------------------------------------------------------------------------------------|
|
||||
| type | 4 |
|
||||
| link | https://www.sec.gov/Archives/edgar/data/0000320193/000032019323000109/xslF345X05/wk-form4_1700004649.xml |
|
||||
| report_date | 2023-11-10 |
|
||||
| accepted_date | 2023-11-14 18:31:09+00:00 |
|
||||
| primary_doc_description | FORM 4 |
|
||||
| primary_doc | xslF345X05/wk-form4_1700004649.xml |
|
||||
| accession_number | 0000320193-23-000109 |
|
||||
| is_inline_xbrl | 0 |
|
||||
| is_xbrl | 0 |
|
||||
| size | 5066 |
|
||||
| complete_submission_url | https://www.sec.gov/Archives/edgar/data/0000320193/0000320193-23-000109.txt |
|
||||
| filing_detail_url | https://www.sec.gov/Archives/edgar/data/0000320193/0000320193-23-000109-index.htm |
|
||||
|
||||
## Screen Markets
|
||||
|
||||
Screeners provide a targeted search, a tool for comparison and discovery. Find stocks from around the world with the screener endpoint, and the `openbb-fmp` provider.
|
||||
|
||||
### Find Stocks From India
|
||||
|
||||
```python
|
||||
results = obb.equity.screener(country="IN", provider="fmp").to_df()
|
||||
len(results)
|
||||
```
|
||||
|
||||
```bash
|
||||
Out: 1821
|
||||
```
|
||||
|
||||
### Search by Sector
|
||||
|
||||
```python
|
||||
results = obb.equity.screener(country="IN", sector="Financial Services", provider="fmp").to_df()
|
||||
len(results)
|
||||
```
|
||||
|
||||
```bash
|
||||
Out: 190
|
||||
```
|
||||
|
||||
```python
|
||||
results.iloc[0]
|
||||
```
|
||||
|
||||
| symbol | HDFCBANK.NS |
|
||||
|:---------------------|:---------------------------------|
|
||||
| name | HDFC Bank Limited |
|
||||
| market_cap | 11344796293939 |
|
||||
| sector | Financial Services |
|
||||
| industry | Banks—Regional |
|
||||
| beta | 0.714285 |
|
||||
| price | 1505.1 |
|
||||
| last_annual_dividend | 19.0 |
|
||||
| volume | 11850413 |
|
||||
| exchange | NSE |
|
||||
| exchange_name | National Stock Exchange of India |
|
||||
| country | IN |
|
||||
| is_etf | False |
|
||||
| actively_trading | True |
|
||||
|
||||
### Search by Industry
|
||||
|
||||
```python
|
||||
results = obb.equity.screener(country="IN", industry="manufacturing").to_df()
|
||||
len(results)
|
||||
```
|
||||
|
||||
```bash
|
||||
Out: 119
|
||||
```
|
||||
|
||||
```python
|
||||
results.iloc[0]
|
||||
```
|
||||
|
||||
| symbol | PAGEIND.NS |
|
||||
|:---------------------|:---------------------------------|
|
||||
| name | Page Industries Limited |
|
||||
| market_cap | 418222172840 |
|
||||
| sector | Consumer Cyclical |
|
||||
| industry | Apparel Manufacturing |
|
||||
| beta | 0.462 |
|
||||
| price | 37495.6 |
|
||||
| last_annual_dividend | 300.0 |
|
||||
| volume | 12166 |
|
||||
| exchange | NSE |
|
||||
| exchange_name | National Stock Exchange of India |
|
||||
| country | IN |
|
||||
| is_etf | False |
|
||||
| actively_trading | True |
|
||||
|
||||
### Search by Exchange
|
||||
|
||||
Some countries, like America, have multiple exchanges. Narrow the search by combining two or more parameters. The example below finds the companies listed on the American Stock Exchange (AMEX) that are domiciled in China.
|
||||
|
||||
```python
|
||||
obb.equity.screener(exchange="amex", country="CN").to_df()
|
||||
```
|
||||
|
||||
| symbol | name | market_cap | sector | industry | beta | price | volume | exchange | exchange_name | country | is_etf | actively_trading |
|
||||
|:---------|:----------------------------------|-------------:|:-------------------|:---------------------------------------|-------:|--------:|---------:|:-----------|:------------------------|:----------|:---------|:-------------------|
|
||||
| AMBO | Ambow Education Holding Ltd. | 4041842 | Consumer Defensive | Education & Training Services | 0.448 | 0.1425 | 203994 | AMEX | American Stock Exchange | CN | False | True |
|
||||
| ITP | IT Tech Packaging, Inc. | 2945282 | Basic Materials | Paper & Paper Products | -0.1 | 0.2926 | 14954 | AMEX | American Stock Exchange | CN | False | True |
|
||||
| DXF | Dunxin Financial Holdings Limited | 1291625 | Financial Services | Credit Services | 1.632 | 0.325 | 2829238 | AMEX | American Stock Exchange | CN | False | True |
|
||||
| CPHI | China Pharma Holdings, Inc. | 1024379 | Healthcare | Drug Manufacturers—Specialty & Generic | 0.875 | 0.0896 | 539863 | AMEX | American Stock Exchange | CN | False | True |
|
||||
|
||||
### Filter by Metric
|
||||
|
||||
Applying some filters refines and targets the search. The example below finds listing on the NYSE domiciled in the USA, with a market cap between $100-300 billion, and exhibiting a beta value of less than 0.5
|
||||
|
||||
```python
|
||||
obb.equity.screener(
|
||||
exchange="nyse",
|
||||
mktcap_min=100000000000,
|
||||
mktcap_max=300000000000,
|
||||
country="us",
|
||||
beta_max=0.5,
|
||||
provider="fmp",
|
||||
).to_df()
|
||||
```
|
||||
|
||||
| symbol | name | market_cap | sector | industry | beta | price | last_annual_dividend | volume | exchange | exchange_name | country | is_etf | actively_trading |
|
||||
|:---------|:----------------------------|-------------:|:-----------------------|:---------------------------|-------:|--------:|-----------------------:|---------:|:-----------|:------------------------|:----------|:---------|:-------------------|
|
||||
| MRK | Merck & Co., Inc. | 258192673024 | Healthcare | Drug Manufacturers—General | 0.375 | 101.75 | 2.92 | 6760568 | NYSE | New York Stock Exchange | US | False | True |
|
||||
| VZ | Verizon Communications Inc. | 152314546478 | Communication Services | Telecom Services | 0.391 | 36.23 | 2.66 | 14960968 | NYSE | New York Stock Exchange | US | False | True |
|
||||
|
||||
## Find an Index
|
||||
|
||||
List all indices from a source with:
|
||||
|
||||
```python
|
||||
indices = obb.index.available(provider="yfinance").to_df()
|
||||
|
||||
len(indices)
|
||||
```
|
||||
|
||||
```bash
|
||||
Out: 274
|
||||
```
|
||||
|
||||
Filter the list down by querying the DataFrame.
|
||||
|
||||
```python
|
||||
indices[indices["name"].str.contains("ASX 200")]
|
||||
```
|
||||
|
||||
| name | code | symbol |
|
||||
|:------------------------------------------------------|:------------------|:---------|
|
||||
| S&P/ASX 200 Index (AUD) | au_asx200 | ^AXJO |
|
||||
| S&P/ASX 200 Energy Sector Index (AUD) | au_energy | ^AXEJ |
|
||||
| S&P/ASX 200 Resources Sector Index (AUD) | au_resources | ^AXJR |
|
||||
| S&P/ASX 200 Materials Sector Index (AUD) | au_materials | ^AXMJ |
|
||||
| S&P/ASX 200 Industrials Sector Index (AUD) | au_industrials | ^AXNJ |
|
||||
| S&P/ASX 200 Consumer Discretionary Sector Index (AUD) | au_discretionary | ^AXDJ |
|
||||
| S&P/ASX 200 Consumer Staples Sector Index (AUD) | au_staples | ^AXSJ |
|
||||
| S&P/ASX 200 Health Care Sector Index (AUD) | au_health | ^AXHJ |
|
||||
| S&P/ASX 200 Financials Sector Index (AUD) | au_financials | ^AXFJ |
|
||||
| S&P/ASX 200 A-REIT Industry Index (AUD) | au_reit | ^AXPJ |
|
||||
| S&P/ASX 200 Info Tech Sector Index (AUD) | au_tech | ^AXIJ |
|
||||
| S&P/ASX 200 Communications Sector Index (AUD) | au_communications | ^AXTJ |
|
||||
| S&P/ASX 200 Utilities Sector Index (AUD) | au_utilities | ^AXUJ |
|
||||
|
||||
:::tip
|
||||
With the `openbb-yfinance` extension, index time series can be loaded using the ticker symbol or short code. Non-American indices have a code beginning with the two-letter country code.
|
||||
|
||||
```python
|
||||
(
|
||||
obb.index.market("au_utilities", provider="yfinance").to_df().tail(1)
|
||||
== obb.index.market("^AXUJ", provider="yfinance").to_df().tail(1)
|
||||
)
|
||||
```
|
||||
|
||||
| date | open | high | low | close | volume |
|
||||
|:--------------------|-------:|-------:|------:|--------:|---------:|
|
||||
| 2023-11-17 | True | True | True | True | True |
|
||||
|
||||
:::
|
||||
|
||||
The examples above show demonstrate the most basic ways to find ticker symbols with the OpenBB Platform. Create your own custom scripts for discovery by combining these with other methods.
|
||||
303
website/content/platform/usage/market_calendars.md
vendored
Normal file
303
website/content/platform/usage/market_calendars.md
vendored
Normal file
@@ -0,0 +1,303 @@
|
||||
---
|
||||
title: Market Calendars
|
||||
sidebar_position: 4
|
||||
description: This page provides details on the market calendars available in the OpenBB
|
||||
Platform. Equity and economic calendars keep investors abreast of market activity and events.
|
||||
This guide provides examples for using the variety of calendars, and differences between sources.
|
||||
keywords:
|
||||
- stocks
|
||||
- companies
|
||||
- calendars
|
||||
- earnings
|
||||
- splits
|
||||
- dividends
|
||||
- ipo
|
||||
- events
|
||||
- economic calendar
|
||||
- CPI report
|
||||
- inflation
|
||||
- expectations
|
||||
- global
|
||||
- central banks
|
||||
- timezone
|
||||
- tz-aware
|
||||
- tz-unaware
|
||||
- convert time
|
||||
- ISM Manufacturing New Orders
|
||||
- dividend yield
|
||||
- analyst consensus
|
||||
- EPS
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Market Calendars - Usage | OpenBB Platform Docs" />
|
||||
|
||||
Market calendars are an essential part of any analyst's daily rituals. Economic events and corporate actions provide near-term trading opportunities (or reasons to get out of the way) as expectations meet reality. The OpenBB Platform has a variety of calendars.
|
||||
|
||||
- Economic
|
||||
- Earnings
|
||||
- Dividends
|
||||
- Splits
|
||||
- IPO/SPOs
|
||||
|
||||
Let's take a look at some use-cases.
|
||||
|
||||
:::note
|
||||
Examples on this page will assume that the OpenBB Platform is installed, the Python environment is active, and the Python interface has been imported into the active session.
|
||||
|
||||
```python
|
||||
from openbb import obb
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
## Economic Calendar
|
||||
|
||||
The economic calendar aggregates global central bank and macroeconomic releases, it is located within the `obb.economy` module.
|
||||
|
||||
:::tip
|
||||
Do not rely on the economic calendar for real-time updates. Times posted are scheduled by publishers and are estimates which do not reflect the actual time data is released to the public.
|
||||
:::
|
||||
|
||||
### Timezone Considerations
|
||||
|
||||
There are subtle differences between providers, the main consideration will be the timestamp. FMP and TradingEconomics both return the calendar as UTC-0, while Nasdaq posts events in US/Eastern time. Of the three, only TradingEconomics provides a TZ-aware timestamp. The differences can be reconciled with a few lines of code.
|
||||
|
||||
To identify the issue, let's look at one event. First, from FMP:
|
||||
|
||||
```python
|
||||
fmp_df = obb.economy.calendar(provider="fmp", start_date="2023-11-19", end_date="2023-11-20").to_df()
|
||||
fmp_df[fmp_df["event"].str.contains("20-Year Bond Auction")]
|
||||
```
|
||||
|
||||
date | country | event | previous | consensus | importance | currency | change | change_percent |
|
||||
|:--------------------|:----------|:---------------------|-----------:|------------:|:-------------|:-----------|---------:|-----------------:|
|
||||
| 2023-11-20 18:00:00 | US | 20-Year Bond Auction | 5.245 | nan | Low | USD | nan | 0 |
|
||||
|
||||
Then Nasdaq:
|
||||
|
||||
```python
|
||||
nasdaq_df = obb.economy.calendar(provider="nasdaq", start_date="2023-11-19", end_date="2023-11-20").to_df()
|
||||
nasdaq_df[nasdaq_df["event"].str.contains("20-Year Bond Auction")]
|
||||
```
|
||||
|
||||
| date | country | event | actual | previous | consensus | description |
|
||||
|:--------------------|:--------------|:---------------------|:---------|:-----------|:------------|:----------------|
|
||||
| 2023-11-20 13:00:00 | United States | 20-Year Bond Auction | - | 5.245% | - | The figures displayed in the calendar represent the yield on the Treasury Bond auctioned. |
|
||||
|
||||
Now let's convert the FMP timestamp to US/Eastern time.
|
||||
|
||||
```python
|
||||
from datetime import time
|
||||
|
||||
fmp_df.index = fmp_df.index.map(
|
||||
lambda dt: dt.tz_localize("UTC")
|
||||
.tz_convert("America/New_York")
|
||||
if dt.time() != time(0, 0, 0)
|
||||
else dt.tz_localize("America/New_York")
|
||||
)
|
||||
fmp_df[fmp_df["event"].str.contains("20-Year Bond Auction")]
|
||||
```
|
||||
|
||||
| date | country | event | previous | consensus | importance | currency | change | change_percent |
|
||||
|:--------------------------|:----------|:---------------------|-----------:|------------:|:-------------|:-----------|---------:|-----------------:|
|
||||
| 2023-11-20 13:00:00-05:00 | US | 20-Year Bond Auction | 5.245 | nan | Low | USD | nan | 0 |
|
||||
|
||||
Timestamps can be a factor with start/end dates because the calendar day will roll over at midnight, moving the date. Converting the timestamp will overcome this, but be aware of when the time is `00:00:00`, signifying an all-day event like a holiday.
|
||||
|
||||
An exception was added in the code above to maintain the time where applicable, instead of rolling it back five hours.
|
||||
|
||||
For these reasons, among others, it is important for users to know and understand their data intimately.
|
||||
|
||||
### Filtering by Event
|
||||
|
||||
The providers do not have a pre-request filter for a specific event. TradingEconomics does have categories, like 'government', but that does not focus it on any particular release. To find something like PMI reports, search for it post-request.
|
||||
|
||||
FMP allows queries to this endpoint to be a maximum width of three months. To get the year-to-date events, requests will need to loop. The code below will do that, filter the results for ISM Manufacturing New Orders, and display the table of hits.
|
||||
|
||||
### ISM New Orders
|
||||
|
||||
```python
|
||||
|
||||
start_dates = ["2023-01-04", "2023-04-01", "2023-07-01", "2023-10-01"]
|
||||
end_dates = ["2023-03-31", "2023-06-30", "2023-09-30", "2023-12-30"]
|
||||
results = []
|
||||
|
||||
for i in range(0, len(start_dates)):
|
||||
_data = (
|
||||
obb.economy.calendar(provider="fmp", start_date=start_dates[i], end_date=end_dates[i])
|
||||
.model_dump()["results"]
|
||||
)
|
||||
results.extend(_data)
|
||||
events = pd.DataFrame.from_records(results).set_index("date").sort_index()
|
||||
|
||||
events[events["event"].str.contains("ISM Manufacturing New Orders")]
|
||||
```
|
||||
|
||||
| date | country | event | actual | previous | consensus | importance | currency | change | change_percent |
|
||||
|:--------------------|:----------|:-----------------------------------|---------:|-----------:|------------:|:-------------|:-----------|---------:|-----------------:|
|
||||
| 2023-01-04 15:00:00 | US | ISM Manufacturing New Orders (Dec) | 45.2 | 47.2 | nan | Low | USD | -2 | -4.237 |
|
||||
| 2023-02-01 15:00:00 | US | ISM Manufacturing New Orders (Jan) | 42.5 | 45.1 | nan | Low | USD | -2.6 | -5.765 |
|
||||
| 2023-03-01 20:00:00 | US | ISM Manufacturing New Orders (Feb) | 47 | 42.5 | nan | Low | USD | 4.5 | 10.588 |
|
||||
| 2023-04-03 18:00:00 | US | ISM Manufacturing New Orders (Mar) | 44.3 | 47 | nan | Low | USD | -2.7 | -5.745 |
|
||||
| 2023-05-01 18:00:00 | US | ISM Manufacturing New Orders (Apr) | 45.7 | 44.3 | nan | Low | USD | 1.4 | 3.16 |
|
||||
| 2023-06-01 14:00:00 | US | ISM Manufacturing New Orders (May) | 42.6 | 45.7 | nan | Low | USD | -3.1 | -6.783 |
|
||||
| 2023-07-03 18:00:00 | US | ISM Manufacturing New Orders (Jun) | 45.6 | 42.6 | nan | Low | USD | 3 | 7.042 |
|
||||
| 2023-08-01 18:00:00 | US | ISM Manufacturing New Orders (Jul) | 47.3 | 45.6 | 44 | Low | USD | 1.7 | 3.728 |
|
||||
| 2023-09-01 14:00:00 | US | ISM Manufacturing New Orders (Aug) | 46.8 | 47.3 | nan | Low | USD | -0.5 | -1.057 |
|
||||
| 2023-10-02 14:00:00 | US | ISM Manufacturing New Orders (Sep) | 49.2 | 46.8 | nan | Low | USD | 2.4 | 5.128 |
|
||||
| 2023-11-01 14:00:00 | US | ISM Manufacturing New Orders (Oct) | 45.5 | 49.2 | nan | Low | USD | -3.7 | -7.52 |
|
||||
| 2023-12-01 15:00:00 | US | ISM Manufacturing New Orders (Nov) | nan | 45.5 | nan | Low | USD | nan | 0 |
|
||||
|
||||
## Earnings Calendar
|
||||
|
||||
The earnings calendar works in a similar way. For companies outside of the US, try the `openbb-fmp` provider.
|
||||
|
||||
```python
|
||||
calendar = (
|
||||
obb.equity.calendar.earnings(
|
||||
provider="fmp",
|
||||
start_date="2023-11-20",
|
||||
end_date="2023-11-24"
|
||||
).to_df()
|
||||
)
|
||||
```
|
||||
|
||||
This returned 1,234 results, but let's filter it down to those companies with analysts estimates, and display the top ten by EPS conensus.
|
||||
|
||||
```python
|
||||
(
|
||||
calendar[calendar["eps_consensus"].notnull()
|
||||
& calendar["revenue_consensus"].notnull()]
|
||||
.sort_values(by="eps_consensus", ascending=False)
|
||||
.head(10)
|
||||
)
|
||||
```
|
||||
|
||||
| report_date | symbol | eps_consensus | actual_eps | actual_revenue | revenue_consensus | period_ending | reporting_time | updated_date |
|
||||
|:--------------|:---------|----------------:|-------------:|-----------------:|--------------------:|:----------------|:-----------------|:---------------|
|
||||
| 2023-11-22 | CAP.SN | 279.3 | nan | nan | 690955000000 | 2023-09-30 | bmo | 2023-11-19 |
|
||||
| 2023-11-20 | ABDP.L | 56.4 | nan | nan | 106000000 | 2023-09-29 | bmo | 2023-11-19 |
|
||||
| 2023-11-23 | 4206.T | 56.3 | nan | nan | 62200000 | 2023-09-30 | bmo | 2023-11-19 |
|
||||
| 2023-11-22 | DE | 7.58 | nan | nan | 12909600000 | 2023-10-29 | bmo | 2023-11-19 |
|
||||
| 2023-11-21 | NVDA | 3.34 | nan | nan | 15194600000 | 2023-10-29 | amc | 2023-11-19 |
|
||||
| 2023-11-21 | LOW | 3.1 | nan | nan | 21059700000 | 2023-11-03 | bmo | 2023-11-19 |
|
||||
| 2023-11-20 | MOH.AT | 2.48 | nan | nan | 3030480000 | 2023-09-30 | bmo | 2023-11-19 |
|
||||
| 2023-11-20 | SJM | 2.47 | nan | nan | 1947800000 | 2023-10-30 | bmo | 2023-11-19 |
|
||||
| 2023-11-21 | BIDU | 2.45 | nan | nan | 4735580000 | 2023-09-30 | bmo | 2023-11-19 |
|
||||
| 2023-11-21 | DKS | 2.42 | nan | nan | 2948570000 | 2023-10-28 | bmo | 2023-11-19 |
|
||||
|
||||
:::tip
|
||||
EPS values are reported in the currency of the exchange listing price, direct comparisons are not viable across domiciles without a conversion factor.
|
||||
:::
|
||||
|
||||
## Dividend Calendar
|
||||
|
||||
The dividend calendar uses start/end dates that reflect the ex-dividend date - the date when it begins trading without dividend rights. Aside from the notable dates, the information returned tells you only the amount paid. Calculating the yield requires more data.
|
||||
|
||||
:::note
|
||||
|
||||
- Nasdaq provides a field for 'annualized_amount', which makes it easier to calculate a dividend yield.
|
||||
|
||||
- The `openbb-nasdaq` provider has US-only data for this endpoint.
|
||||
|
||||
- The same markets covered by FMP's earnings calendar are included in their dividend calendar.
|
||||
:::
|
||||
|
||||
### Calculate Dividend Yield
|
||||
|
||||
The ten highest-payments going ex-div between November 20-24 are shown below. With T+2 settlement, a purchase needs to occur two days prior to the record date for payment eligibility. The dividend yield is the current payment annualized as a percent of the asset's price.
|
||||
|
||||
```python
|
||||
dividends = (
|
||||
obb.equity.calendar.dividend(
|
||||
provider="nasdaq",
|
||||
start_date="2023-11-20",
|
||||
end_date="2023-11-24",
|
||||
).to_df()
|
||||
.drop_duplicates(subset="symbol")
|
||||
.sort_values("amount", ascending=False)
|
||||
.reset_index()
|
||||
.set_index("symbol")
|
||||
.head(10)
|
||||
)
|
||||
|
||||
symbols = dividends.index.tolist()
|
||||
prices = (
|
||||
obb.equity.price.quote(symbols, provider="fmp").to_df()
|
||||
.reset_index()
|
||||
.set_index("symbol")["price"]
|
||||
)
|
||||
dividends["price"] = prices
|
||||
|
||||
dividends["yield"] = (
|
||||
round((dividends["annualized_amount"]/dividends["price"])*100, 4)
|
||||
)
|
||||
|
||||
(
|
||||
dividends[["record_date", "payment_date", "amount", "annualized_amount", "price", "yield"]]
|
||||
.sort_values("yield", ascending=False)
|
||||
)
|
||||
```
|
||||
|
||||
| symbol | record_date | payment_date | amount | annualized_amount | price | yield |
|
||||
|:---------|:--------------|:---------------|---------:|--------------------:|--------:|--------:|
|
||||
| USOI | 2023-11-21 | 2023-11-27 | 1.8588 | 16.134 | 75.73 | 21.3046 |
|
||||
| ATCD | 2023-11-21 | 2023-12-26 | 60.14 | 60.14 | 1235 | 4.8696 |
|
||||
| GLDI | 2023-11-21 | 2023-11-27 | 1.5153 | 4.8216 | 141.8 | 3.4003 |
|
||||
| CHTM | 2023-11-21 | 2023-12-26 | 59.62 | 59.62 | 1856.95 | 3.2106 |
|
||||
| CMI | 2023-11-24 | 2023-12-07 | 1.68 | 6.72 | 225.5 | 2.98 |
|
||||
| KLIB | 2023-11-24 | 2023-12-15 | 2.1 | 4.2 | 144 | 2.9167 |
|
||||
| SNA | 2023-11-21 | 2023-12-11 | 1.86 | 7.44 | 277.76 | 2.6786 |
|
||||
| NOC | 2023-11-27 | 2023-12-13 | 1.87 | 7.48 | 464.17 | 1.6115 |
|
||||
| CBCYB | 2023-11-24 | 2023-12-01 | 3.75 | 8 | 647 | 1.2365 |
|
||||
| CBCY | 2023-11-24 | 2023-12-01 | 3.75 | 8 | 660 | 1.2121 |
|
||||
|
||||
## IPO Calendar
|
||||
|
||||
The IPO calendar shows events based on their status - `["upcoming", "priced", "withdrawn"]` - and Intrinio provides a filter for the min/max dollar amount offerred.
|
||||
|
||||
:::note
|
||||
The data from both Intrinio and Nasdaq is US-only, both relying on the SEC for filing information.
|
||||
:::
|
||||
|
||||
Use the `status` parameter to find announcements in different stages of the cycle.
|
||||
|
||||
### Upcoming
|
||||
|
||||
The initial public offerings that are confirmed to be coming to market are categorized as 'upcoming'. The number of companies going public at any given time will depend on market cycles.
|
||||
|
||||
```python
|
||||
obb.equity.calendar.ipo(provider="nasdaq", status="upcoming").to_df()
|
||||
```
|
||||
|
||||
| symbol | name | offer_amount | share_count | expected_price_date | id | exchange | share_price |
|
||||
|:---------|:-------------|---------------:|--------------:|:----------------------|:--------------|:---------------|:--------------|
|
||||
| DOCO | Docola, Inc. | 8235004 | 1060870 | 2023-11-21 | 995278-107909 | NASDAQ Capital | 5.75-6.75 |
|
||||
|
||||
### Withdrawn
|
||||
|
||||
A `withdrawn` status might be the result of a SPAC unwinding after failing to merge with a company.
|
||||
|
||||
```python
|
||||
obb.equity.calendar.ipo(provider="nasdaq", status="withdrawn").to_df().tail(3)
|
||||
```
|
||||
|
||||
| withdraw_date | name | offer_amount | share_count | filed_date | id |
|
||||
|:----------------|:--------------------------|---------------:|--------------:|:-------------|:---------------|
|
||||
| 2023-11-09 | Arago Acquisition Corp. | 86250000.0 | 7500000 | 2022-05-06 | 1214792-102968 |
|
||||
| 2023-11-13 | CW Petroleum Corp | 17249995.5 | 3157894 | 2022-06-02 | 1055531-103241 |
|
||||
| 2023-11-13 | Tiga Acquisition Corp. II | 230000000.0 | 20000000 | 2021-02-26 | 1148285-96307 |
|
||||
|
||||
### SPO
|
||||
|
||||
SPOs, secondary pubic offerings, are shares being sold by investors after an IPO. The money does not go to the company, but directly to the investor selling shares into the market. The `openbb-nasdaq` provider has an additional boolean parameter, `is_spo`. By default, year-to-date data is returned.
|
||||
|
||||
```python
|
||||
obb.equity.calendar.ipo(provider="nasdaq", is_spo=True).to_df().tail(1)
|
||||
```
|
||||
|
||||
| symbol | ipo_date | name | offer_amount | share_count | deal_status | id | exchange | share_price |
|
||||
|:---------|:-----------|:----------------------------------------|---------------:|--------------:|:--------------|:--------------|:---------------------|--------------:|
|
||||
| SKWD | 2023-11-16 | Skyward Specialty Insurance Group, Inc. | 152500000.0 | 5000000 | Priced | 854131-108262 | NASDAQ Global Select | 30.5 |
|
||||
12
website/pypi.md
vendored
12
website/pypi.md
vendored
@@ -1,3 +1,5 @@
|
||||
# OpenBB SDK v3
|
||||
|
||||
[](https://pepy.tech/project/openbb)
|
||||
[](https://github.com/OpenBB-finance/OpenBBTerminal)
|
||||
|
||||
@@ -6,14 +8,12 @@
|
||||
|  |
|
||||
| Check our website at [openbb.co](www.openbb.co) |
|
||||
|
||||
|
||||
## OpenBB SDK Overview
|
||||
## Overview
|
||||
|
||||
OpenBB SDK provides a convenient way to access raw financial data from multiple data providers. This allows users to build custom financial dashboards and reports in minutes.
|
||||
|
||||
More information on this product can be found [here](https://openbb.co/products/sdk)
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
The command below provides access to the core functionalities behind the [OpenBB Terminal](https://openbb.co/products/terminal).
|
||||
@@ -22,7 +22,7 @@ The command below provides access to the core functionalities behind the [OpenBB
|
||||
pip install openbb-terminal
|
||||
```
|
||||
|
||||
If you wish to utilize our **Portfolio Optimization** or **Machine Learning / Artificial Intelligence** toolkits, please see instructions [here](https://docs.openbb.co/sdk/installation).
|
||||
If you wish to utilize our **Portfolio Optimization** or **Machine Learning / Artificial Intelligence** toolkits, please see instructions [here](https://docs.openbb.co/terminal/installation).
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -37,13 +37,13 @@ Everything you need to use the OpenBB SDK can be found on our [Official Document
|
||||
Main uses cases can be seen below.
|
||||
___
|
||||
|
||||
#### RAW FINANCIAL DATA AT YOUR FINGERTIPS
|
||||
### RAW FINANCIAL DATA AT YOUR FINGERTIPS
|
||||
|
||||
Access raw financial data from any data source that you are interested. The open source nature of this SDK makes it so that this is an ever-growing project and that everyone can contribute to.
|
||||
|
||||
|
||||
|
||||
#### GENERATE INSIGHTS 10X FASTER
|
||||
### GENERATE INSIGHTS 10X FASTER
|
||||
|
||||
For most of the functionalities, adding `_chart` to the function will allow you to visualize the output directly from a Jupyter Notebook. Not only speeding up the time it takes to create a plot for the data you are interested in, but making building custom reports much faster.
|
||||
|
||||
|
||||
14
website/src/pages/index.tsx
vendored
14
website/src/pages/index.tsx
vendored
@@ -27,9 +27,9 @@ export default function Home(): JSX.Element {
|
||||
backgroundSize: "100% 130%",
|
||||
}}
|
||||
to="/platform"
|
||||
className="bg-[url(/img/sdk_bg_light.png)] dark:bg-[url('/img/sdk_bg.png')] bg-no-repeat shadow-sm group !no-underline text-grey-900 dark:text-white hover:text-grey-900 dark:hover:border-white hover:border-grey-600/80 dark:hover:!text-white relative w-full h-[156px] max-w-full p-8 rounded flex flex-col items-start justify-start border border-grey-300 bg-white dark:bg-grey-900"
|
||||
className="!bg-grey-900 bg-[url('/img/sdk_bg.png')] bg-no-repeat shadow-sm group !no-underline text-white dark:hover:border-white hover:border-grey-600/80 relative w-full h-[238px] max-w-full p-8 rounded flex flex-col items-start justify-start border border-grey-300 hover:!text-white"
|
||||
>
|
||||
<h3 className="uppercase tracking-widest font-bold mb-0 mt-0">
|
||||
<h3 className="uppercase tracking-widest font-bold mb-0 mt-0 text-white">
|
||||
OpenBB Platform
|
||||
</h3>
|
||||
<p className="text-sm lg:text-base dark:text-grey-300">
|
||||
@@ -51,9 +51,9 @@ export default function Home(): JSX.Element {
|
||||
backgroundSize: "100% 110%",
|
||||
}}
|
||||
to="/terminal"
|
||||
className="bg-[url(/img/terminal_bg_light.png)] dark:bg-[url('/img/terminal_bg.png')] bg-no-repeat shadow-sm group !no-underline text-grey-900 dark:text-white hover:text-grey-900 dark:hover:border-white hover:border-grey-600/80 dark:hover:!text-white relative w-full h-[238px] max-w-full p-8 rounded flex flex-col items-start justify-start border border-grey-300 bg-white dark:bg-grey-900"
|
||||
className="!bg-grey-900 bg-[url('/img/terminal_bg.png')] bg-no-repeat shadow-sm group !no-underline text-white dark:hover:border-white hover:border-grey-600/80 relative w-full h-[238px] max-w-full p-8 rounded flex flex-col items-start justify-start border border-grey-300 hover:!text-white"
|
||||
>
|
||||
<h3 className="uppercase tracking-widest font-bold mb-0 mt-0">
|
||||
<h3 className="uppercase tracking-widest font-bold mb-0 mt-0 text-white">
|
||||
OpenBB Terminal
|
||||
</h3>
|
||||
<p className="text-sm lg:text-base dark:text-grey-300">
|
||||
@@ -73,12 +73,12 @@ export default function Home(): JSX.Element {
|
||||
backgroundSize: "100% 130%",
|
||||
}}
|
||||
to="/bot"
|
||||
className="bg-[url(/img/bot_bg_light.png)] dark:bg-[url('/img/bot_bg.png')] bg-no-repeat shadow-sm group !no-underline text-grey-900 dark:text-white hover:text-grey-900 dark:hover:border-white hover:border-grey-600/80 dark:hover:!text-white relative w-full h-[238px] max-w-full p-8 rounded flex flex-col items-start justify-start border border-grey-300 bg-white dark:bg-grey-900"
|
||||
className="!bg-grey-900 bg-[url('/img/bot_bg.png')] bg-no-repeat shadow-sm group !no-underline text-white dark:hover:border-white hover:border-grey-600/80 relative w-full h-[238px] max-w-full p-8 rounded flex flex-col items-start justify-start border border-grey-300 hover:!text-white"
|
||||
>
|
||||
<h3 className="uppercase tracking-widest font-bold mb-0 mt-0">
|
||||
<h3 className="uppercase tracking-widest font-bold mb-0 mt-0 text-white">
|
||||
OpenBB Bot
|
||||
</h3>
|
||||
<p className="text-sm lg:text-base dark:text-grey-300">
|
||||
<p className="text-sm lg:text-base text-grey-300">
|
||||
The OpenBB Bot bring market data directly to your financial groups, such as on Discord, Telegram and more.
|
||||
</p>
|
||||
<p
|
||||
|
||||
Reference in New Issue
Block a user