Files
OpenBB/website/content/excel/usage/basics.md
montezdesousa 40c0c9c20f Excel docs (#5870)
* first test

* remove old reference

* bring this file back

* generate sidebar and write empty mds

* generate index.mdx

* get description from cmd_lib

* fix reference card error

* rename file

* generate markdown

* regen

* add last+hist

* update pages with seo metadata

* format types

* small fix

* css sux

* add usage placeholder

* set hidden by default

* nah

* add cmds and menus to reference

* lint

* fix/Users/diogosousa/opt/anaconda3/envs/platform/bin/python /Users/diogosousa/OpenBB/OpenBBTerminal/website/generate_excel_markdown.py

* format mds

* remove space

* fix commands heading

* redo folder structure

* add back cmd description

* move card to var

* different main folder

* clean

* move vars

* refer to editor

* rename var

* done

* recreate folder structure

* add section: syntax + minor adjustments

* remove return type

* remove return type

* rename api to library

* minor fix

* remove api folder

* remove api folder

* formatting

* improve basics

* basics

* fetch functions.json from website

* complete basic

* change syntax to use semi-colon

* basics

* basics

* remove space in sig

* remove sections

* add metadata

* Update formula builder

* add tabs

* Update index.md

* complete basics and formula_builder

* Update index.md

* add windows screenshots

* restructure folders

* regenerate with latest add-in version

* move Excel sidebar

* rename function and add comment

* now it's working

* logic

* rename folder

* Update formula_builder.md

* fix

* hide excel for now

* some explicit typing

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-12-07 19:41:20 +00:00

2.0 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.
Microsoft Excel
Add-in
Basics
Examples
Functions

To access the following features you need to sign-in first with your OpenBB Pro account.

The add-in provides 3 types of custom functions all starting with OBB..

  1. Last value: returns the last value of a given symbol/field combination

    • OBB.LAST

    Examples:

    1. Getting the last price of a stock:

      =OBB.LAST("AAPL";"CLOSE_PRICE")
      
    2. Getting the industry group of a stock:

      =OBB.LAST("AAPL";"INDUSTRY_GROUP")
      
  2. Historical data: returns the historical values of a given symbol/field combination

    • OBB.HIST

    Examples:

    1. Getting the historical EBITDA:

      =OBB.HIST("AAPL";"EBITDA")
      
    2. Getting the historical Return on Equity (ROE) for a given period:

      =OBB.HIST("AAPL";"ROE";"2020-01-01";"2020-12-31")
      

    :::tip Dates can be specified in text format (YYYY-MM-DD) or as Excel dates from a cell or DATE(YYYY;MM;DD). :::

  3. Library: direct access to the OpenBB library

    • OBB.[MENU].[SUB_MENU].[COMMAND]

    Examples:

    1. Getting balance sheet data for a stock:

      =OBB.EQUITY.FUNDAMENTAL.BALANCE("AAPL")
      
    2. Getting the latest news for a stock:

      =OBB.NEWS.COMPANY("AAPL")
      
    3. 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 skip the first parameter (provider) and the second parameter (symbol). :::