Skip to main content

Introduction

ODP Desktop is a light-weight application (macOS & Windows) for installing and using the open-source tools, along with your favourite developer tools and resources. Its features are well-suited for building language-agnostic OpenBB Workspace Applications and agentic workflows.

Application Screenshot

backends-screen

Quick Start​

Download and install the latest release from: https://github.com/OpenBB-finance/OpenBB/releases/tag/ODP

Installation Summary - See the installation page for more details.

The initial environment (openbb) is setup when you first run the application, and comes with:

  • OpenBB Core Python packages
    • openbb-api and openbb-mcp executables
  • Optional packages selected during installation
  • Jupyter Lab & Notebook in a dedicated window
    • Python langugage server
  • Isolated npm executable
important

When the application is started (except first launch), no window is created. Access it from the tray icon menu, or doubleclick on the shortcut again.

Step 1​

Go to the API Keys page, add or import your provider credentials, if needed.

Step 2​

Navigate to the Backends page by clicking on it in the header, or selecting from the tray icon's menu.

Step 3​

Press the, Start, button for the OpenBB API backend.

info

By default, this will run: openbb-api --host 127.0.0.1 --port 6900

Application Screenshot

backends-running

  1. Open Workspace in your browser and connect to http://127.0.0.1:6900. You now have a fully local data stack.
Workspace Screenshot

Add To Workspace

note

Number of widgets and applications will depend on packages and versions installed in the environment.

Overview​

The application operates as a system tray icon, and its main window has three, navigatable, screens:

Next Steps​

  • Use the OpenBB Python Package as a Workspace backend.
  • Create your own custom Environments, or modify the existing.
  • Define custom Backends to run independently, in any environment.

On this page