jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/ca/income.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

2.6 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
income This page provides detailed information on how to get income data from different peer companies using OpenBB's financial functions. This includes the source code and the parameters needed for these operations.
income data
financial functions
parameters
Marketwatch
income statements
quarterly statements
dataframe
income chart
data export
financial comparison
ticker comparison
financial data analysis

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

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

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