Quick start

The Python Interface, the REST API, the MCP server, and a Workspace backend all run the same commands, taken from the provider and extension packages installed in the environment. Start with the surface you plan to use, or with the developer guide if you are adding commands of your own.

User
Install a provider, set its API key, and call it with from openbb import obb.
Developer
Register a FastAPI router as an openbb_core_extension and call it from Python and REST.
REST API
Serve the installed commands over HTTP with FastAPI.
MCP server
Expose the installed commands as MCP tools with openbb-mcp.
Workspace
Connect openbb-api to OpenBB Workspace as a custom backend.

After the quickstart, the User Guide covers credentials, defaults, output types, and error handling, and Settings & Configuration lists every settings field.