Build New Provider Extension
This page will walk through adding a new data provider extension to the OpenBB Platform. By the end, you will have an extension that is ready to be published, or submitted as a pull request.
Template For Getting Started
If you've already been through some of the other data provider tasks - How To Add Data To An Existing Endpoint & How To Add A New Data Endpoint With An Existing Provider - these steps will simply tag on to the beginning. Instead of editing the __init__.py
file, we will create it.
An easy way to get started is to copy and paste something existing. In the OpenBB GitHub repository, provider extensions are located here.
For convenience's sake, download this template zip file. It contains the basic folder structure and everything required to get started creating new data models.
For demonstration purposes, we'll assume this is from the perspective of somebody who will open a pull request and contribute the code to the OpenBB repository. The process, however, also applies to publishing directly via PyPI. Anyone can make an OpenBB extension.
The structure of the folder will look something like this:
template/
├── openbb_template/
│ ├── models/