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>
46 lines
1.1 KiB
Markdown
Vendored
46 lines
1.1 KiB
Markdown
Vendored
---
|
|
title: overview
|
|
description: This page provides an API for getting an Alpha Vantage's company overview
|
|
with OpenBB Terminal. It is implemented with Python for stock fundamental analysis.
|
|
A stock's ticker symbol is used as the parameter, and it returns the fundamentals
|
|
in a pd.DataFrame.
|
|
keywords:
|
|
- Alpha vantage company overview
|
|
- OpenBB finance
|
|
- OpenBB terminal
|
|
- Stocks fundamental analysis
|
|
- AV model
|
|
- Stock ticker symbol
|
|
- Dataframe of fundamentals
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.fa.overview - Reference | OpenBB SDK Docs" />
|
|
|
|
Get alpha vantage company overview
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/av_model.py#L36)]
|
|
|
|
```python
|
|
openbb.stocks.fa.overview(symbol: str)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Stock ticker symbol | None | False |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Dataframe of fundamentals |
|
|
---
|