Files
OpenBB/website/content/sdk/reference/stocks/ca/balance.md
James Maslek dce447b423 install v4 (#5766)
* install v4

* add run on pr

* this seems sus

* thnx juan

* flip

* thnx juan

* idk

* Update index.js

* Update Root.tsx

* Update index.js

* try again

* fix front matter

* fix description front matter

* Revert "fix description front matter"

This reverts commit cccc7b2469.

* try to fix this mickey

* fixed all that mickey @DidierRLopes broke

* Update index.js

* generate platform fix

* black fix

---------

Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: tehcoderer <me@tehcoderer.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-11-21 06:38:50 +00:00

1.4 KiB
Vendored

title, description, keywords
title description keywords
balance This page provides a detailed view on the balance data obtained through OpenBB Terminal's stocks comparison analysis. Python source code, parameters for the function and return type are conventionally presented.
balance data
stocks comparison analysis
marketwatch model
tickers comparison
quarterly statements
data export
dataframe

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

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