mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 21:42:22 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
992 B
Vendored
992 B
Vendored
title, description
| title | description |
|---|---|
| balance | OpenBB SDK Function |
balance
Get balance data. [Source: Marketwatch].
Source Code: [link]
openbb.stocks.ca.balance(similar: List[str], timeframe: str = "2021", quarter: bool = False)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| similar | List[str] | List of tickers to compare. Comparable companies can be accessed through finnhub_peers(), finviz_peers(), polygon_peers(). |
None | False |
| timeframe | str | Column header to compare | 2021 | True |
| quarter | bool | Whether to use quarterly statements, by default False | False | True |
| export | str | Format to export data | None | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Dataframe of balance comparisons |