mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
dce447b423
* install v4
* add run on pr
* this seems sus
* thnx juan
* flip
* thnx juan
* idk
* Update index.js
* Update Root.tsx
* Update index.js
* try again
* fix front matter
* fix description front matter
* Revert "fix description front matter"
This reverts commit cccc7b2469.
* try to fix this mickey
* fixed all that mickey @DidierRLopes broke
* Update index.js
* generate platform fix
* black fix
---------
Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
Co-authored-by: tehcoderer <me@tehcoderer.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
89 lines
2.4 KiB
Markdown
Vendored
89 lines
2.4 KiB
Markdown
Vendored
---
|
|
title: mktcap
|
|
description: This page provides documentation about the mktcap function of OpenBB-finance's
|
|
Yahoo Finance Module. It explains the operation and usage of the functions for
|
|
market cap modeling and charting over a certain period.
|
|
keywords:
|
|
- OpenBB-finance
|
|
- Yahoo Finance
|
|
- mktcap function
|
|
- market cap model
|
|
- market cap chart
|
|
- Stock ticker symbol
|
|
- Financial analysis
|
|
- Fundamental analysis
|
|
- Stock market data
|
|
- Source code
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.fa.mktcap - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get market cap over time for ticker. [Source: Yahoo Finance]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L287)]
|
|
|
|
```python
|
|
openbb.stocks.fa.mktcap(symbol: str, start_date: Optional[str] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Ticker to get market cap over time | None | False |
|
|
| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 3 years back | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Dataframe of estimated market cap over time |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display market cap over time. [Source: Yahoo Finance]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_view.py#L338)]
|
|
|
|
```python
|
|
openbb.stocks.fa.mktcap_chart(symbol: str, start_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | str | Stock ticker symbol | None | False |
|
|
| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 3 years back | None | True |
|
|
| export | str | Format to export data | | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|