mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 23:41:27 +00:00
* 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>
1.4 KiB
Vendored
1.4 KiB
Vendored
title, description, keywords
| title | description | keywords | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| cashflow | This page discusses the cashflow data from Marketwatch. It explains how to use the openbb.stocks.ca.cashflow function, its parameters, and outputs, emphasizing on a dataframe of cashflow comparisons. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
Get cashflow data. [Source: Marketwatch]
Source Code: [link]
openbb.stocks.ca.cashflow(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 cashflow comparisons |