Backend examples for the OpenBB Terminal Pro

Introduction

Spinning up an OpenBB API is a versatile way to host your data and integrate it into widgets. Whether hosted internally or externally, this method provides a standardized API structure that Pro widgets can effortlessly connect to.

Note: Most of the examples provided use Python FastAPI due to our familiarity with the library, but the same could be done utilizing different languages.

The Main tenants are:

Data returned should be in JSON non-nested format.

Example :

[
	{
		"color": "red",
		"value": "#f00"
	},
	{
		"color": "green",
		"value": "#0f0"
	}
]

Ensure that you have a well-structured widgets.json file. This file defines widget properties such as name, description, category, type, endpoint, and other information needed. Each widget needs to be defined in this file – You can find the format in any of the templates folder with a detailed definition below.
API - If hosting locally you must enable CORS and have an endpoint available that will return the widgets.json file.

Supported Integrations and Templates

Each Integration below has its folder which contains an example of a different implementation.

Integration	Description
Snowflake	Snowflake is a cloud-based data warehousing platform.
ClickHouse	ClickHouse is an open-source column-oriented DBMS.
Supabase	Supabase is an open source Firebase alternative.
MindsDB	MindsDB is an open-source AI layer for existing databases.
ElasticSearch	Elasticsearch is a search engine based on the Lucene library.
Readfile	This integration allows reading data directly from a file.
Public	This integration allows fetching data from public APIs.
Plotly	Plotly is a Python graphing library for interactive graphs.

Getting Started

Go into the folder you want to test
Read the README.md file with instructions
Run uvicorn main:app --port 5050

(add an image of what it looks like in the console)

Add steps for Data Connectors in the Terminal Pro

(add steps according to Terminal Pro)

Code explained

main.py

This is responsible for running the FastAPI with endpoints that will be consumed by the Terminal Pro.

This file:

Enables cross-origin resource sharing (CORS) and configures it according to the domain where FastAPI is running and the Terminal Pro link.
Initializes FastAPI with app = FastAPI()
Ensures that there's a /widgets.json file that the OpenBB Terminal Pro can use to configure the widgets configured

@app.get("/widgets.json")
def get_widgets():
    """Widgets configuration file for the OpenBB Terminal Pro"""
    file_path = "widgets.json"
    with open(file_path, "r") as file:
        data = json.load(file)
    return JSONResponse(content=data)

Creates remaining endpoints that retrieve data that will be consumed by the Terminal Pro

Passing Params (Table Only)

To pass params in the widget you can check out he example below :

You can see we set our endpoint to take the symbol param and then handle it to pass to the API (In our example we hit a unique endpoint but the url request ultimately looks like this against our api /get_options?symbol=AMZN )

In our main.py :

@app.get("/get_options")
def get_options(symbol: str):
    """Get options data"""

    response = requests.get(f'https://test.com/options/flow/{symbol}')

    if response.status_code == 200:
        data = response.json()
        return data

And in our widgets.json :

{
  "get_options": {
    "name": "Options Data",
    "description": "Options Data from Source",
    "category": "options",
    "searchCategory": "options",
    "widgetType": "options",
    "widgetId": "get_options",
    "params": { "symbol": "", "optional": { "interval": [1, 2, 3, 4, 5] } }, //interval isn't needed here just showing other ways to pass more params
    // another example is "params": { "symbol": "", "date": "string" }, - which gives you a date picker to send
    "options": {
      "allowTickerChange": true // needed if you are going to pass symbol since we already built out this search
    },
    "endpoint": "get_options",
    "gridData": {
      "w": 20,
      "h": 5
    },
    "data": {
      "table": {
        "showAll": true,
        "index": "symbol"
      }
    }
  }
}

This then allows us to use the pass the ticker to the endpoint along with any other optional params you need.

widgets.json

This contains the settings for all the widgets that the backend contains.

This file is a dictionary, and each dictionary within represents a widget.

You must ensure that in your widget.json - each widget name (top level) will match the widgetID like shown in the examples

{
  "financial_data_from_supabase": { // this name must match widgetId
    "name": "Financial data supabase",
    "description": "Financial data from supabase",
    "category": "economy",
    "searchCategory": "economy",
    "widgetType": "individual",
    "widgetId": "financial_data_from_supabase", // match to top name
    "endpoint": "financial_data_from_supabase",
    "gridData": {
      "w": 20,
      "h": 5
    }
  }
}

Each widget will have the following properties:

{
  // Basic props
  "id": "string", // Unique identifier for the widget.
  "innerTab": "string", // If it's from a template, it may have a tab assigned, e.g., equity template.
  "gridData": {
    // Grid data configuration for the widget.
    "x": 0, // Horizontal grid position.
    "y": 0, // Vertical grid position.
    "w": 0, // Width for the widget in the grid.
    "h": 0, // Height for the widget in the grid.
    "minH": 0, // Minimum height.
    "minW": 0, // Minimum width.
    "maxH": 0, // Maximum height.
    "maxW": 0, // Maximum width.
    "moved": true, // Indicates if the widget has been moved.
    "static": false, // Indicates if the widget is static and cannot be moved.
    "isDraggable": true // Specifies if the widget can be dragged.
  },
  "storage": {
    // Storage for the widget that doesn't fit in the other fields.
    "key": "value"
  },
  "aiHistory": [
    {
      // AI history for the widget.
      "question": "string", // Question for the AI.
      "answer": "string", // Answer from the AI.
      "ticker": "string" // Ticker at the time of the question.
    }
  ],
  "schema": {
    // Schema for the widget.
    "properties": {
      // Properties for the schema.
      "key": {
        "type": "string", // Type of property (object, array, string, number, boolean).
        "title": "string", // Title for the property.
        "description": "string", // Description for the property.
        "default": "value", // Default value for the property.
        "choices": ["option1", "option2"], // Choices for the property.
        "format": "string", // Format for the property (url, email, date, date-time, time, color).
        "mandatory": true, // Indicates if the property is mandatory.
        "specifics": {
          "min": 0, // Minimum value for the property.
          "max": 100 // Maximum value for the property.
        }
      }
    }
  },
  "defaultViz" : "table", // Default visualization for the widget. Can be one of table or chart (default : table)
  "external": false, // Indicates if the widget is external, i.e., if data is loaded from outside OpenBB API.
  "name": "string", // Name of the widget in the list the user sees. Displayed on top left of widget.
  "type": "string", // Main widget type (chart, table, note, custom).
  "description": "string", // Description to show to the user on the info button and on the search/add widget menu.
  "widgetId": "string", // Identifier for the specific widget instance. Used to map with openbb ui widgets.
  "data": {
    // Data configuration for the widget.
    "schemaData": {
      // Schema data for the widget.
      "key": "value"
    },
    "gridChart": {
      // Configuration for having a chart detached from aggrid table.
      "chartModel": "string", // The model of the aggrid chart.
      "fromTableId": "string" // Identifier for the source table of the chart data.
    },
    "values": [
      {
        // Array of x and y coordinate values.
        "x": 0,
        "y": 0
      }
    ],
    "mainTicker": {
      // Main ticker information. Displayed on top left after the widget name. Normally can be changed on this dropdown.
      "tickerProperty": "value"
    },
    "securities": ["security1", "security2"], // Array of security types.
    "secondaryTickers": ["ticker1", "ticker2"], // Array of secondary tickers.
    "hideControls": true, // Indicates if controls should be hidden.
    "color": "color", // Color configuration for the widget (used in Notes to store the color of the note).
    "html": "string", // HTML content to be displayed (used in Notes to save the note content).
    "dataKey": "string", // Key for the data.
    "table": {
      // Configuration for table columns.
      "columnState": {
        "key": "value"
      },
      "enableCharts": true, // Allow charting to work from the widget table (default: true)
      "mode": "string", // Display mode for the table (light, dark).
      "density": "string", // Density mode for the table (compact, default).
      "transpose": true, // Indicates if the table should be transposed.
      "period": ["period1", "period2"], // Period information for the table.
      "showAll": true, // Indicates if all data should be shown.
      "columnsDefs": [
        {
          // Configuration for table columns.
          "field": "string", // Field name from the JSON data.
          "headerName": "string", // Header name for the column.
          "chartDataType": "string", // Chart data type (category, series, time, excluded).
          "cellDataType": "string", // Cell data type (text, number, boolean, date, dateString, object).
          "formatterFn": "string", // Formatter function (int, bigInt, etc.).
          "renderFn": "string", // Render function (green, red, titleCase, etc.).
          "width": 0, // Width of the column.
          "maxWidth": 0, // Maximum width of the column.
          "minWidth": 0, // Minimum width of the column.
          "hide": true, // Indicates if the column should be hidden.
          "rowGroup": true // Indicates if the column is a row group column.
        }
      ]
    },
    "chart": {
      // Chart instance that hits a callback for the JSON data.
      "callback": "string" // Callback function for the chart.
    }
  },
  "endpoint": "string", // Endpoint or endpoints for the widget data.
  "endpointMethod": "GET", // Endpoint method (GET, POST).
  "endpointHeaders": [
    {
      // Endpoint headers.
      "key": "string",
      "value": "string"
    }
  ],
  "params": {
    // URL params to send to the endpoint (e.g., callback endpoint in "analyst_upgrades_downgrades").
    "key": "value"
  },
  "options": {
    // Widget options.
    "size": "string", // Size configuration for the widget (normal, maximize).
    "chartType": "string", // Type of chart to display (line, candlestick, bar).
    "allowTickerChange": true, // Indicates if ticker change is allowed.
    "allowSecondaryTickersChange": true, // Indicates if secondary ticker change is allowed.
    "allowChartTypeChange": true, // Indicates if chart type change is allowed.
    "allowTimeframeChange": true, // Indicates if timeframe change is allowed.
    "allowRaw": true, // Indicates if raw data is allowed.
    "allowSettingsChange": true // Indicates if settings change is allowed.
  },
  "groupId": "string" // Identifier for a widget group.
}

HTTPS

Some browsers (Safari) or applications (Excel on Mac) require HTTPS to be enabled to fetch data from an API.

To enable HTTPS in your local environment, follow these steps:

Install mkcert.
cd into the backend you will be using, e.g. cd snowflake_python.
Run mkcert localhost 127.0.0.1 ::1. This will create localhost+2.pem and localhost+2-key.pem files in the current directory.
Run uvicorn main:app --port 5050 --ssl-keyfile=localhost+2-key.pem --ssl-certfile=localhost+2.pem --reload to start the server with HTTPS enabled.

mstcls / backend-for-terminal-pro Goto Github PK

backend-for-terminal-pro's Introduction

Backend examples for the OpenBB Terminal Pro

Introduction

Supported Integrations and Templates

Getting Started

Code explained

main.py

Passing Params (Table Only)

widgets.json

HTTPS

backend-for-terminal-pro's People

Contributors

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent