mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +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>
50 lines
1.2 KiB
Markdown
Vendored
50 lines
1.2 KiB
Markdown
Vendored
---
|
|
title: metrics
|
|
description: This page details the process of getting key metrics in stock market
|
|
by using the metrics function with parameters symbol, limit, and quarterly. It includes
|
|
the Python code for this function.
|
|
keywords:
|
|
- OpenBBTerminal Metrics
|
|
- Metrics Function
|
|
- Stock Market Metrics
|
|
- Python Stock Market Code
|
|
- Fundamental Analysis
|
|
- FMP model
|
|
- Stock ticker symbol
|
|
- Quarterly data
|
|
- Market Analysis
|
|
- Dataframe of Key Metrics
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.fa.metrics - Reference | OpenBB SDK Docs" />
|
|
|
|
Get key metrics
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L421)]
|
|
|
|
```python
|
|
openbb.stocks.fa.metrics(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 metrics |
|
|
---
|