Concepts

These pages explain how the engine works. The Developer section builds on them with step-by-step guides.

Architecture
The Python Interface and REST API, how a command call flows through routers and providers, and where extensions plug in.
The OBBject envelope
Fields and conversion methods of the object every command returns, and the output_type preference.
Extension types
The router, provider, OBBject, and charting entry-point groups and what each entry point must resolve to.
Packaging and static assets
How the openbb package is generated, when it rebuilds, and when to run openbb-build.
Streaming responses
OBBStream in Python and text/event-stream over REST, for fetchers that yield rows as they arrive.