Finance Database provider for OpenBB
Finance Database by Jeroen Bouma offers an extensive collection of over 300,000 symbols across various financial instruments, including Equities, ETFs, Funds, Indices, Currencies, Cryptocurrencies, and Money Markets. It's designed to provide a comprehensive overview of sectors, industries, and types of investments.
Introduction
This extension integrates the Finance Database datasets into OpenBB. It enhances the capabilities of OpenBB’s equity, crypto, and ETF search functionalities. This integration adds capabilities to search through a broad spectrum of financial instruments.
Requirements
- Python 3.12+
- OpenBB Core 2.0.1+
uvfor local development
Installation
Add the provider and the asset routers used by the examples to your uv project:
uv add openbb-fd openbb-equity openbb-etf openbb-crypto
Alternatively, for the latest version directly from the repository:
uv add git+https://github.com/piiq/openbb-fd.git
Rebuild the generated interface after changing installed extensions:
uv run openbb-build
Local development
uv sync --locked
uv run openbb-build
uv run pytest
uv run ruff check .
uv run ty check
uv run rumdl check --config pyproject.toml README.md
The development group installs the equity, ETF, and crypto routers for the generated obb interface, plus the Platform API for HTTP integration tests. OpenBB 5 installs these asset routers through its optional routers extra; a provider installation alone does not install them.
Run the API and the live integration tests in separate terminals:
uv run openbb-api --host 127.0.0.1 --port 8000
uv run pytest integration
Publishing
The Publish to PyPI workflow compares [project].version before and after each push to main. A changed version runs validation, builds the wheel and source distribution, and publishes them directly to PyPI. An unchanged version skips publishing. For pushes with multiple commits, the comparison covers the complete push.
Configure a PyPI Trusted Publisher for the openbb-fd project with these values:
- Owner:
piiq - Repository:
openbb-fd - Workflow filename:
publish.yml - Environment:
pypi
To release, set a new, unpublished version and update the lockfile before pushing the change to main:
uv version --bump patch
uv lock
Usage
from openbb import obb
Here are some command examples to demonstrate the usage of this integration:
To search for equities in a defense industry:
>>> sample = obb.equity.search(query="Defense", provider="fd")
>>> print(f"Total companies in the sample: {len(sample.to_df()['name'].unique())}")
Total companies in the sample: 880
To find ETFs matching certain criteria:
>>> sample = obb.etf.search(query="Wheat", provider="fd")
>>> print(f"Total etfs in the sample: {len(sample.to_df()['name'].unique())}")
Total etfs in the sample: 10
For cryptocurrency analysis:
>>> sample = obb.crypto.search(query="node", provider="fd")
>>> print(f"Total cryptos in the sample: {len(sample.to_df()['name'].unique())}")
Total cryptos in the sample: 10
License
This project is licensed under the MIT License.
Metadata
Release files for openbb-fd 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| openbb_fd-2.0.0.tar.gz | 143.8 kB | Without provenance | Details for openbb_fd-2.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| openbb_fd-2.0.0-py3-none-any.whl | Python 3 | none | any | Details for openbb_fd-2.0.0-py3-none-any.whl |
Total release size: 152.4 kB
Release files / openbb_fd-2.0.0.tar.gz
| Download URL | openbb_fd-2.0.0.tar.gz |
|---|---|
| Size | 143.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4a651faa15143d8d3d6c95cd6e378b16c5426398b6b0c740de4b56372589acc8
|
|
BLAKE2b-256 checksum How to use checksums |
ec22b02edaebc9ba5f35457e869c9b3c2285ae1e0d0d8032e34d3e6d834c13b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / openbb_fd-2.0.0-py3-none-any.whl
| Download URL | openbb_fd-2.0.0-py3-none-any.whl |
|---|---|
| Size | 8.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
444be1a9dd65869124f788d91c09545bb053ec04fd8b8e6bd699fb90f5dc00fb
|
|
BLAKE2b-256 checksum How to use checksums |
63136727412e9367938d431daf3a60151ec5373fd14bc3d407ce9ee5c3b31118
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for openbb-fd 2.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.