Open Source Platform Integration

This section will highlight how you can run the OpenBB Platform locally and integrate 350+ different datasets into the OpenBB Terminal in under 5 minutes.

If you want to learn more about the open source platform, check our documentation.

Here's a video that you can use to follow step-by-step instructions.

Step by step

The steps are also described below:

1. Download the OpenBB Platform Installer which can be found here.

Select the right installer based on your OS and architecture. Then install it.

2. Once installation is complete, find the OpenBB folder that has been created in the installation directory selected. Double click on OpenBB/openbb-api.

3. A terminal popup should be initiated, and you will be prompted to insert your personal access token (PAT), which can be retrieved from here.

Note: This assumes that the user has spent time setting up their API keys here.

4. The OpenBB Platform API should now be up and running.

5. Finally, you simply need to set up the custom backend on Terminal Pro.

note

If you are using Brave/Safari you will need an HTTPS connection - see how here

6. Voila. You are now ready to access 350+ data widgets from your OpenBB Terminal. For free.

Advanced - Access this data on mobile

This section will use ngrok as the proxy between our platform API endpoints running locally and the internet. You can do this in ngrok free plan.

1. Install ngrok by following these instructions.

2. Open a terminal and run ngrok http 6900. This assume that the open source platform API is running on http://localhost:6900.

If that runs correctly, you'll get an output similar to the following.

Note the Forwarding row. That will contain a public URL that has access to your endpoint.

3. Update your localhost endpoint with the public URL provided by ngrok.

4. Add a request header as authentication.

Click on "Add Authentication" button, and add the following:

Key: ngrok-skip-browser-warning Value: x Location: Header

You have to include the request header ngrok-skip-browser-warning with any value in the request header, to bypass the Ngrok Browser Warning.

You are now ready to access this data on your phone, just ensure that you keep running the API endpoint and ngrok locally.

Advanced - Filter widgets

If you run the steps above, you will have access to a dozen different data vendors and hundreds of different widgets. However, some of these may not work because you haven't set up the API key for the data vendor or you may not be interested to bring some of those widgets into your OpenBB Terminal.

This section will explore how you can filter the platform integration datasets that are made available on the Terminal.

1. Go to the widgets filter page where you can set the data vendors you are interested and also select the widgets within. Once you are happy you can download the widget_settings.json configuration file by clicking on Download.

2. In the OpenBB folder that has been created when you installed the Platform. There must be a Settings folder within. This folder should be the destination of your widget setttings file (widget_settings.json), which will serve as the configuration file for your custom backend.

Now, similarly to the previous section, you should:

• Run OpenBB/openbb-api
• Set your PAT
• Refresh the connection inside the "My Data" tab or follow instructions above to add again.

Take into consideration that, if you change the default configurations on the OpenBB Platform settings, the URL (http://127.0.0.1:6900) might differ.