OpenBB
Financial data platform for analysts, quants and AI agents.
Configure OpenBB development mode and debug settings by enabling debug_mode in system_settings.json or exporting the DEBUG_MODE environment variable. Unlock advanced features for seamless development.
How to Implement Callback Functions for Processing Command Output in OpenBBLearn to implement callback functions for processing command output in OpenBB. Define async callbacks and pass them to amake_request for efficient model building.
How to Use the OpenBB OBBject for Data Frame ConversionEasily convert OpenBB OBBject to pandas DataFrames with to_dataframe or to_df. This function handles BaseModel dict list and existing DataFrame results seamlessly.
How to Deploy the OpenBB REST API in Production Using UvicornDeploy the OpenBB REST API in production with Uvicorn. Learn to configure security and performance for high-demand access to financial data.
How to Configure Multi-Provider Fallback When a Primary Provider Fails in OpenBBConfigure multi-provider fallback in OpenBB for seamless data access. Automatically switch to backup providers when your primary fails using openbb.yaml or environment variables.
How to Handle Data Format Differences Between Providers Using OpenBB Standard ModelsLearn how OpenBB Platform standard models unify provider data. Effortlessly handle data format differences using Pydantic schemas and a unified ProviderInterface.
How to Add Custom API Endpoints to the OpenBB REST API: A Complete Developer GuideLearn how to add custom API endpoints to the OpenBB REST API. This guide shows developers how to create extensions and integrate them seamlessly into the main FastAPI application.
How the OpenBB Router Command System Processes Incoming Requests: A Complete Technical GuideLearn how the OpenBB router command system processes incoming requests. Discover its four-stage pipeline, FastAPI integration, and dependency injection for seamless execution.
How to Securely Manage Data Provider API Keys Within OpenBBLearn to securely manage OpenBB data provider API keys using environment variables or a local JSON file. Protect sensitive data with Pydantic SecretStr.
How to Write Integration Tests for Custom OpenBB Provider ExtensionsLearn to write integration tests for custom OpenBB provider extensions. Use pytest and the obb fixture to validate your extensions, ensuring data integrity and proper functionality for your OpenBB project.
How to Optimize OpenBB Query Performance Using Caching MechanismsOptimize OpenBB query performance with automatic HTTP response caching. Discover how aiohttp_client_cache and SQLite backends minimize redundant network calls and speed up your data retrieval.
How to Debug OpenBB REST API Authentication Issues: A Step-by-Step GuideEffectively debug OpenBB REST API authentication issues. Learn to check startup banners, verify environment variables, and inspect auth service loading for quick resolution.
Have a question about this repo?
These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:
curl -s "https://instagit.com/install.md" Maintain an open-source project? Get it listed too →