API Keys

The API Keys screen is for managing data provider credentials accessible to the Open Data Platform Python packages and API interface. Environment variables and credentials can be configured centrally across any environment using the openbb-core and its extension framework.

In the environment setup panels, data provider extensions highlight if an API key is required. Values there represent the name of the key(s) needing to be set.

info

The initial installation creates entries for each selected extension requiring credentials, just add your key.

For example, if openbb-fred was selected, fred_api_key will appear on the screen as, Undefined.

Features

• Interface for adding and modifying credentials entries stored in the user_settings.json file.
  • Import key:value pairs from file (.json or .env).
• Easy access to key ODP configuration files in the ~/.openbb_platform directory, opening directly in the default text editor:
  • user_settings.json (see the docs here.)
  • system_settings.json (see the docs here.)
  • .env (see the docs here.)

Edit, Save, & Remove

Hover the mouse over an entry to reveal the icons. The edit button is the first in the row of three.

Enter the changes and press Save to update the file and close the modal.

note

Backend servers and Python interpreters will need to be restarted for the changes to be reflected.

Configuration Files

The button to the right of, Import Keys, is for opening ODP configuration files (listed above with documentation links).

tip

The .env file can be added to any Backend configuration.

Clicking the button will open it with the system's default text editor.