Skip to main content

OpenBB Platform backend for OpenBB Terminal Pro

The application in this repository wraps the OpenBB Platform API in a way that it:

  1. Creates a widgets.json from the OpenAPI schema
  2. Creates the widgets.json and root ("/") endpoints for the OpenBB Platform API

Installation

Install from pypi into the same python environment as your OpenBB Platform:

pip install openbb-platform-pro-backend

Running

The package provides a shortcut to launch the application using:

openbb-api

:note: If this command is not available immediately after installation, you need to deactivate and activate back your virtual environment.

:note: Set up your provider API keys in the ~/.openbb_platform/user_settings.json file.

Configuring host and port

You can configure the host and port by setting the OPENBB_API_HOST and OPENBB_API_PORT environment variables.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openbb_platform_pro_backend-1.1.0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openbb_platform_pro_backend-1.1.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file openbb_platform_pro_backend-1.1.0.tar.gz.

File metadata

  • Download URL: openbb_platform_pro_backend-1.1.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Darwin/23.5.0

File hashes

Hashes for openbb_platform_pro_backend-1.1.0.tar.gz
Algorithm Hash digest
SHA256 5693da618855ca13780d55298fc3168e8d2051a1f47b21bfe75230eb98c4dd26
MD5 577e4915dbd96f94ccc91b1f93bce779
BLAKE2b-256 817285da53ca80b9f427c7f76cdced12f1ebb2ecabc0d6627fbc740d2707ea2c

See more details on using hashes here.

File details

Details for the file openbb_platform_pro_backend-1.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openbb_platform_pro_backend-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a79e5e5201b5c9fd90c9ee493866764a04821d2f9ed5de7f012a1cb6fb2fb148
MD5 aaa4172a0c1f668d57cdea78aa748b8c
BLAKE2b-256 4ef2d7b05e03e8d0307a98813bbd7f2d310cca10e6a1df4be042c3fb675ded85

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 files

1.0.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page