OpenBB/data_extensions.md at 06daf98366ded0db188eefb0bbf2558e51201ef3

mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 05:52:23 +00:00

Files

Danglewood 7bcef37874 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 commit 7d095fcfd2.

* 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 commit 7300904e9f.

* 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>

2023-11-20 20:14:00 +00:00

5.1 KiB

Vendored

Raw Blame History

title, sidebar_position, description, keywords

title

sidebar_position

description

keywords

Data Extensions

Learn about the OpenBB Platform and its extension framework that allows seamless integration of modules like 'openbb-yfinance'. Discover how installations and removals automatically update the router when the Python interpreter is refreshed. This page lists the data provider extensions available.

OpenBB Platform

extension framework

yFinance

install openbb-yfinance

Python interpreter

PyPI

openbb-qa

data

vendors

providers

install

free

subscription

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Data extensions will expand the breadth and coverage of the data available in the OpenBB Platform. Each source (provider) is its own independent extension, even if there is only one endpoint accessible. This allows every data source to be inserted or removed, at any time, without distrubing the operation of the Core components.

Functions will appear in the Python Interface and Fast API only if a supported provider, for that specific endpoint, is installed. Additional Python libraries will be installed, where required, by the extension.

Provider Coverage

The total installed coverage can be determined through the Python interface, as a dictionary.

from openbb import obb
obb.coverage.providers

Installation

All data extensions are installed with similar syntax. Published data extensions will have names beginning with openbb. For example, yFinance.

pip install openbb-yfinance

Additions and removals update the router automatically to reflect the changes when the Python interpreter is refreshed. Below is a list of data provider extensions.

Uninstall any extension with pip uninstall.

pip uninstall openbb-yfinance

Available Data Extensions

Extension Name	Description	Installation Command	Core/Community	Minimum Subscription Type Required
openbb-alpha-vantage	Alpha Vantage data connector.	pip install openbb-alpha-vantage	Community	Free
openbb-benzinga	Benzinga data connector.	pip install openbb-benzinga	Core	Paid
openbb-biztoc	Biztoc News data connector.	pip install openbb-biztoc	Community	Free
openbb-cboe	Cboe data connector.	pip install openbb-cboe	Community	None
openbb-ecb	ECB data connector.	pip install openbb-ecb	Community	None
openbb-finra	FINRA data connector.	pip install openbb-finra	Community	None / Free
openbb-fmp	FMP data connector.	pip install openbb-fmp	Core	Free
openbb-fred	FRED data connector.	pip install openbb-fred	Core	Free
openbb-government-us	US Government data connector.	pip install openbb-us-government	Core	None
openbb-intrinio	Intrinio data connector.	pip install openbb-intrinio	Core	Paid
openbb-nasdaq	Nasdaq Data Link connector.	pip install openbb-nasdaq	Community	None / Free
openbb-oecd	OECD data connector.	pip install openbb-oecd	Core	Free
openbb-polygon	Polygon data connector.	pip install openbb-polygon	Core	Free
openbb-sec	SEC data connector.	pip install openbb-sec	Core	None
openbb-seeking-alpha	Seeking Alpha data connector.	pip install openbb-seeking-alpha	Community	None
openbb-stockgrid	Stockgrid data connector.	pip install openbb-stockgrid	Community	None
openbb-tiingo	Tiingo data connector.	pip install openbb-tiingo	Core	Free
openbb-tradingeconomics	TradingEconomics data connector.	pip install openbb-tradingeconomics	Core	Paid
openbb-ultima	Ultima Insights data connector.	pip install openbb-ultima	Community	Paid
openbb-wsj	Wall Street Journal data connector.	pip install openbb-wsj	Community	None
openbb-yfinance	Yahoo Finance data connector.	pip install openbb-yfinance	Community	None

Have you published a data provider extension and want it featured on this list? Tell us about it! Open a pull request on GitHub to submit an extension for inclusion. Code contributions, for new and existing, data providers are always welcome.

Search PyPI to find more extensions.

5.1 KiB Vendored Raw Blame History

Provider Coverage

Installation

Available Data Extensions

5.1 KiB

Vendored

Raw Blame History