jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-14 05:14:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/stocks/ca/income.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* 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>
2022-11-22 16:47:03 +00:00

2.1 KiB
Vendored
Raw Blame History

title, description
title description
income OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

income

Get income data. [Source: Marketwatch].

Source Code: [link]

openbb.stocks.ca.income(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 income statements

Display income data. [Source: Marketwatch].

Source Code: [link]

openbb.stocks.ca.income_chart(symbols: List[str], timeframe: str = "2021", quarter: bool = False, export: str = "")

Parameters

Name Type Description Default Optional
symbols List[str] List of tickers to compare. Enter tickers you want to see as shown below:
["TSLA", "AAPL", "NFLX", "BBY"]
You can also get a list of comparable peers with
finnhub_peers(), finviz_peers(), polygon_peers().		 None False
timeframe str What year to look at 2021 True
quarter bool Whether to use quarterly statements, by default False False True
export str Format to export data True

Returns

This function does not return anything