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>
79 lines
3.4 KiB
Markdown
Vendored
79 lines
3.4 KiB
Markdown
Vendored
---
|
|
title: key
|
|
description: This documentation provides users with key metrics data about a company
|
|
using Alpha Vantage API. It presents data fields like Market capitalization, EBITDA,
|
|
EPS, PE ratio, and more.
|
|
keywords:
|
|
- Alpha Vantage API
|
|
- Market capitalization
|
|
- EBITDA
|
|
- EPS
|
|
- PE ratio
|
|
- PEG ratio
|
|
- Price to book ratio
|
|
- Return on equity TTM
|
|
- Payout ratio
|
|
- Price to sales ratio TTM
|
|
- Dividend yield
|
|
- 50 day moving average
|
|
- Analyst target price
|
|
- Beta
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks/fa/key - Reference | OpenBB Terminal Docs" />
|
|
|
|
Gives main key metrics about the company (it's a subset of the Overview data from Alpha Vantage API). The following fields are expected: Market capitalization, EBITDA, EPS, PE ratio, PEG ratio, Price to book ratio, Return on equity TTM, Payout ratio, Price to sales ratio TTM, Dividend yield, 50 day moving average, Analyst target price, Beta [Source: Alpha Vantage API]
|
|
|
|
### Usage
|
|
|
|
```python
|
|
key
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
This command has no parameters
|
|
|
|
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
2022 Feb 16, 06:54 (🦋) /stocks/fa/ $ key
|
|
AAPL Key Metrics
|
|
┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓
|
|
┃ ┃ ┃
|
|
┡━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩
|
|
│ Market capitalization │ 2.820 T │
|
|
├──────────────────────────┼───────────┤
|
|
│ EBITDA │ 128.218 B │
|
|
├──────────────────────────┼───────────┤
|
|
│ EPS │ 6.01 │
|
|
├──────────────────────────┼───────────┤
|
|
│ PE ratio │ 28.73 │
|
|
├──────────────────────────┼───────────┤
|
|
│ PEG ratio │ 3.28 │
|
|
├──────────────────────────┼───────────┤
|
|
│ Price to book ratio │ 38.31 │
|
|
├──────────────────────────┼───────────┤
|
|
│ Return on equity TTM │ 1.456 │
|
|
├──────────────────────────┼───────────┤
|
|
│ Price to sales ratio TTM │ 7.45 │
|
|
├──────────────────────────┼───────────┤
|
|
│ Dividend yield │ 0.0052 │
|
|
├──────────────────────────┼───────────┤
|
|
│ 50 day moving average │ 172.3 │
|
|
├──────────────────────────┼───────────┤
|
|
│ Analyst target price │ 192.52 │
|
|
├──────────────────────────┼───────────┤
|
|
│ Beta │ 1.188 │
|
|
└──────────────────────────┴───────────┘
|
|
```
|
|
---
|