mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 15:01:18 +00:00
00febe1942
* regen excel md * add syntax + basic example * fix example * create json with docs map * update docs to latest functions.json + remove tiingo * remove space from examples * minor fix * remove spaces * remove spaces * bug fix: remove folder before generating * fix typo * add link to appsource * fix * Update templates.md * regenerate content * change docs colors * fix light mode * add back tiingo * update functions.json * templates go later * remove Library from reference * Make the excel markdown being generated at runtime * fix reference cards having commands under menu * remove excel/reference folder since this is built at runtime by gh-pages action * black formatting * improve title * add excel to the main page * add excel image bg * make excel sidebar show up next to pro * improve main page * small fix for platform page title * update basics page * add tip to autocomplete --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
1.1 KiB
Vendored
1.1 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | |||||
|---|---|---|---|---|---|---|---|---|
| Basics | 1 | This page provides an overview of the basics of the OpenBB add-in for Microsoft Excel. It covers the basic usage of the add-in and the available functions. |
|
To access the following features you need to sign-in first with your OpenBB Pro account.
The add-in provides direct access to the OpenBB platform, where each function implements the following pattern:
OBB.[MENU].[SUB_MENU].[COMMAND]
:::tip
Use the <TAB> key to autocomplete the function name after typing =OBB.
:::
Examples:
-
Getting balance sheet data for a stock:
=OBB.EQUITY.FUNDAMENTAL.BALANCE("AAPL") -
Getting the latest news for a stock:
=OBB.NEWS.COMPANY("AAPL") -
Getting the earnings calendar:
=OBB.EQUITY.CALENDAR.IPO(;;"2023-11-20")
:::tip If you want to skip a parameter just use semi-colon (or comma depending on your number separator) without any value. In example iii. we are skipping the first parameter (provider) and the second parameter (symbol). :::