mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-31 22:41:19 +00:00
e9ddbd36cf
* uppercase reference * fix name header * add tab title * remove reference excel folder * add to gitignore excel reference files --------- Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
60 lines
1.6 KiB
Markdown
Vendored
60 lines
1.6 KiB
Markdown
Vendored
---
|
|
title: Basics
|
|
sidebar_position: 2
|
|
description: 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.
|
|
keywords:
|
|
- Microsoft Excel
|
|
- Add-in
|
|
- Basics
|
|
- Examples
|
|
- Functions
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="Basics | OpenBB Add-in for Excel Docs" />
|
|
|
|
The OpenBB Excel 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:
|
|
|
|
1. Getting balance sheet data for a stock:
|
|
|
|
```excel
|
|
=OBB.EQUITY.FUNDAMENTAL.BALANCE("AAPL")
|
|
```
|
|
|
|
2. Getting the latest news for a stock:
|
|
|
|
```excel
|
|
=OBB.NEWS.COMPANY("AAPL")
|
|
```
|
|
|
|
3. Getting the earnings calendar:
|
|
|
|
```excel
|
|
=OBB.EQUITY.CALENDAR.IPO(;"2023-11-20")
|
|
```
|
|
|
|
:::tip
|
|
If you want to skip a parameter use semi-colon (or comma depending on your number separator) without any value. In example iii. we are skipping the first parameter (symbol).
|
|
:::
|
|
|
|
## Advanced
|
|
|
|
<div style={{display: 'flex', justifyContent: 'center'}}>
|
|
<iframe
|
|
style={{width: '800px', height: '450px', display: 'block', margin: '0 auto'}}
|
|
src="https://www.youtube.com/embed/mk-NDjH8CDE?si=oL1Iqh1yJc24dh-K"
|
|
title="YouTube video player"
|
|
frameBorder="0"
|
|
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
|
|
/>
|
|
</div>
|