mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 05:21:48 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
2.9 KiB
Vendored
2.9 KiB
Vendored
title, description
| title | description |
|---|---|
| key | OpenBB Terminal Function |
key
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
key
Parameters
This command has no parameters
Examples
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 │
└──────────────────────────┴───────────┘