Skip to content

Commit

Permalink
Added data connector docs (#6286)
Browse files Browse the repository at this point in the history
  • Loading branch information
colin99d authored Apr 5, 2024
1 parent 11023f8 commit f0b29cf
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 17 deletions.
10 changes: 0 additions & 10 deletions website/content/pro/data-connectors/integrate-your-own-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,6 @@ The language-agnostic API approach offers flexibility by allowing you to use the

3. **Connect widgets to your API**: Once your API is up and running, users can add the custom widgets using the Terminal Pro interface. They just need to input the endpoint details, and the widget will fetch and display the data from your API.

## Using OpenBB Native Integrations

The OpenBB native integrations allows you to connect to Snowflake, MySQL, or SQLite databases directly. You can run any query against your database directly from our terminal.

1. **Install our Client**: Reach out to us [here](mailto:colin.delahunty@openbb.finance?subject=Data%20Connector) to receive your free client.

2. **Run the Client**: Simply click on our app and type in the port you would like to use. If you are unsure of a good port, feel free to select `Recommend Port`.

3. **Connect inside the Terminal Pro**: Once your client is up and running, click [here](https://pro.openbb.co/app/data-connectors) to enable the connectors. Now feel free to enter login credentials for any Snowflake, MySQL, or SQLite database and begin to analyze your data inside of our terminal.

### Quick Start with Python and FastAPI

Our team has created several examples that you can use to quickly get started with Python and FastAPI. For more information, check [this open source repository](https://github.com/OpenBB-finance/backend-for-terminal-pro/tree/main) for examples.
13 changes: 6 additions & 7 deletions website/content/pro/data-connectors/native-integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,27 @@ sidebar_position: 3
description: Get in-depth documentation on Native Integrations provided by OpenBB
Terminal Pro including API key connections to data providers and database/warehouse
connections for an enhanced data analysis experience.
draft: true
keywords:
- Native Integrations
- API key
- Data Providers
- Data Warehouse
- Database Connections
- SQL queries
- Snowflake queries
- Data Analysis
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Native Integrations | OpenBB Terminal Pro Docs" />

WORK IN PROGRESS.
## Using OpenBB Native Integrations

OpenBB Terminal Pro will allow seamless integration with two types of third-party data providers.
## API Key Connections
The OpenBB native integrations allows you to connect to Snowflake, MySQL, or SQLite databases directly. You can run any query against your database directly from our Pro Terminal.

To access certain data providers and their associated widgets, you'll need an API key obtained directly from the data provider. We provide step-by-step instructions for each use case to guide you through this process.
1. **Install our Client**: Download our free client for [Mac](https://openbb-installers.s3.amazonaws.com/data_connector_0.0.2.dmg) or [Windows](https://openbb-installers.s3.amazonaws.com/OpenBB+Data+Connector_0.0.2_x64_en-US.msi) to get started.

## Data Warehouse/Database Connections
2. **Run the Client**: Once installed, Simply open our app and type in the port you would like to use. If you are unsure of a good port, feel free to select `Recommend Port`.

For a more robust integration, OpenBB Terminal Pro offers connections to your data warehouse or database. Simply use your login credentials to access your warehouse or database, and swiftly run SQL queries. The queried data can then be rendered as a table within the Terminal Pro interface, providing you with a powerful tool for data analysis.
3. **Connect inside the Terminal Pro**: Once your client is up and running, click [here](https://pro.openbb.co/app/data-connectors) to enable the connectors - it will ask you for the URL the port is running on - you can find that on the Data Connector Application at the top. Now feel free to enter login credentials for any Snowflake, MySQL, or SQLite database and begin to analyze your data inside of our terminal.

0 comments on commit f0b29cf

Please sign in to comment.