jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/fa/balance.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.8 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
balance This page provides detailed information for retrieving balance sheet data via the OpenBBTerminal's Python function. This includes the parameters and return type of the function, as well as examples of its use for different data sources specifically for the stock symbol 'AAPL'.
balance sheet
financial data
YahooFinance
AlphaVantage
stock symbol
AAPL

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

Get balance sheet.

Source Code: [link]

openbb.stocks.fa.balance(symbol: str, quarterly: bool = False, ratios: bool = False, source: str = "YahooFinance", limit: int = 10)

Parameters

Name Type Description Default Optional
symbol str Symbol to get balance sheet for None False
source str Data source for balance sheet, by default "YahooFinance" YahooFinance True
quarterly bool Flag to get quarterly data False True
ratios bool Flag to return data as a percent change. False True
limit int Number of statements to return (free tiers may be limited to 5 years) 10 True

Returns

Type Description
pd.DataFrame Dataframe of balance sheet

Examples

from openbb_terminal.sdk import openbb
balance_sheet = openbb.stocks.fa.balance("AAPL", source="YahooFinance)

If you have a premium AlphaVantage key, you can use the quarterly flag to get quarterly statements

quarterly_income_statement = openbb.stocks.fa.balance("AAPL", source="AlphaVantage", quarterly=True)