jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/fa/ratios.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.2 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
ratios This page provides important details about the 'ratios' function in 'OpenBB Stocks' module which is used for fundamental analysis. Users can extract key ratios by providing a stock's ticker symbol and specifying other optional parameters. The function returns a DataFrame of key ratios.
OpenBB Stocks
Fundamental Analysis
Key Ratios
Stock Ticker Symbol
Quarterly Data

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

Get key ratios

Source Code: [link]

openbb.stocks.fa.ratios(symbol: str, limit: int = 5, quarterly: bool = False)

Parameters

Name Type Description Default Optional
symbol str Stock ticker symbol None False
limit int Number to get 5 True
quarterly bool Flag to get quarterly data, by default False False True

Returns

Type Description
pd.DataFrame Dataframe of key ratios