mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-05 17:01:58 +00:00
4ad995fdd0
* 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>
49 lines
1.4 KiB
Markdown
Vendored
49 lines
1.4 KiB
Markdown
Vendored
---
|
|
title: cashflow
|
|
description: 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.
|
|
keywords:
|
|
- cashflow data
|
|
- marketwatch source code
|
|
- openbb.stocks.ca.cashflow function
|
|
- parameters
|
|
- dataframe of cashflow comparisons
|
|
- timeframe
|
|
- quarter
|
|
- export
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.ca.cashflow - Reference | OpenBB SDK Docs" />
|
|
|
|
Get cashflow data. [Source: Marketwatch]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/marketwatch_model.py#L140)]
|
|
|
|
```python
|
|
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.<br/>Comparable companies can be accessed through<br/>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 |
|
|
---
|