Files
OpenBB/website/content/excel/data-connectors.md
Disorder AA 5bd4ae0856 [Docs] Upgrade Docusaurus to v3 (#6386)
* da3: minor updates

* da3: upgrade react 18

* da3: fix md content

* da3: upgrade docusaurus 3, fix math in tables

* da3: fix DocSearch

* put search back

* da3: fix details / summary

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
2024-05-10 11:17:15 +00:00

2.1 KiB
Vendored

title, sidebar_position, description, keywords
title sidebar_position description keywords
Data connectors 3 Access your data connectors from OpenBB Terminal Pro inside OpenBB Add-in for Excel.
Microsoft Excel
Add-in
Advanced
Data connectors
BYOD
Bring your own data

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

OpenBB Add-In for Excel allows you to access your data connectors from OpenBB Terminal Pro inside Microsoft Excel. This can be done using the OBB.BYOD function.

Single widget

=OBB.BYOD("widget_name")

:::info

  • Make sure your widget is setup in the OpenBB Terminal Pro.

:::

Own backend

=OBB.BYOD("widget_name","backend_name")

If your backend supports it is possible to pass a symbol, a date or other optional parameters:

=OBB.BYOD("widget_name","backend_name","my_symbol","YYYY-MM-DD",{"param1":"value1","param2":"value2", ...})

:::tip The easiest way to pass optional parameters is to write them into cells and reference them in the function. For example, =OBB.BYOD(...,A1:B2) where A1 contains "param1", B1 "value1", A2 "param2", B2 "value2" and so on. :::

:::info

  • Make sure your backend's CORS settings allow requests coming from https://excel.openbb.co.
  • Requests via HTTP will be blocked by Excel. So if you are using the Add-in for Excel on Mac or Office on the web with Safari browser you need to run your backend via HTTPS.

:::

Native integrations

Supported native integrations:

  • database
  • snowflake
=OBB.BYOD("widget_name","native_integration")

:::info

  • Make sure your OpenBB Data Connector is properly configured and the widget is setup in the OpenBB Terminal Pro.
  • Native integrations are available only for Excel on the web or Windows.

:::