OpenBB CLI
Website: https://openbb.co CLI Tool: openbb PyPI Package: openbb-cli Repository: https://github.com/OpenBB-finance/OpenBB License: AGPL-3.0 Documentation: https://docs.openbb.co/cli
Description
OpenBB CLI is a command-line interface for the Open Data Platform (ODP) - an open-source investment research toolset. Provides access to equity, crypto, forex, economy, and fixed income data from multiple providers. Features routine scripts for automated data collection and integrates with AI agents via MCP servers.
Install
pip install openbb-cli
Or with all extensions:
pip install "openbb[all]"
Launch:
openbb
Requirements
- Python 3.10+
Commands
The CLI uses a hierarchical menu system. Main categories:
| Category | Description |
|---|---|
equity |
Stock market data, fundamentals, options |
crypto |
Cryptocurrency prices and metrics |
forex |
Foreign exchange rates |
economy |
Economic indicators, GDP, inflation |
fixedincome |
Bonds, yields, rates |
derivatives |
Options and futures |
etf |
ETF data and holdings |
index |
Market indices |
news |
Financial news |
quantitative |
Technical analysis |
Examples
Launch Interactive CLI
openbb
Equity Data
# In CLI
/equity
price/historical --symbol AAPL
profile --symbol TSLA
Crypto Data
# In CLI
/crypto
price/historical --symbol BTC
Economic Indicators
# In CLI
/economy
gdp
cpi
unemployment
Using Python API
from openbb import obb
# Get stock price history
output = obb.equity.price.historical("AAPL")
df = output.to_dataframe()
# Get crypto data
btc = obb.crypto.price.historical("BTC")
Start API Server
# Launch REST API at localhost:6900
openbb-api
Routine Scripts
Automate data collection with routine scripts:
# Run a routine script
openbb /exe myscript.openbb
Routine script example:
# myscript.openbb
/equity
price/historical --symbol AAPL --export csv
/home
Data Providers
OpenBB integrates with multiple data providers: - Yahoo Finance (free) - Alpha Vantage - Polygon - FRED (economic data) - Intrinio - And many more
Configure API keys:
# In CLI
/settings
keys
AI Agent Integration
OpenBB provides MCP servers for AI agent integration:
# Start API server
openbb-api
# Server runs at http://127.0.0.1:6900
Use with Claude Code, Cursor, or other AI tools to query financial data.
Notes
- Interactive mode: Rich terminal UI with autocomplete
- Export formats: CSV, JSON, XLSX
- Charting: Built-in visualization in terminal
- Extensible: Add custom data providers via extensions
- "Connect once, consume everywhere": Python, Excel, API, AI agents
Comments (0)
Add a Comment
No comments yet. Be the first to comment!