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/fa/earnings.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

1.5 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
earnings This site provides an extensive guide to retrieving earnings data of any stock ticker using the OpenBB Terminal. The page includes detailed parameters descriptions and practical examples.
earnings data
stock ticker
AlphaVantage
YahooFinance
quarterly data

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

Get earnings data.

Source Code: [link]

openbb.stocks.fa.earnings(symbol: str, source: str = "YahooFinance", quarterly: bool = False)

Parameters

Name Type Description Default Optional
symbol str Stock ticker None False
source str Source to use, by default "AlphaVantage" YahooFinance True
quarterly bool Flag to get quarterly data (AlphaVantage only), by default False. False True

Returns

Type Description
pd.DataFrame Dataframe of earnings

Examples

from openbb_terminal.sdk import openbb
aapl_earnings = openbb.stocks.fa.earnings("AAPL", source ="YahooFinance)

To obtain quarterly earnings, use the quarterly flag with AlphaVantage

aapl_earnings = openbb.stocks.fa.metrics("earnings", source ="AlphaVantage, quarterly=True)