mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-09 10:51:57 +00:00
* fix(docs): added margin between sections * feat: removed unused files; updated ga * fix: juan stuff doesnt work * fix: random fix * moon at noon * fix: update docusaurus config * Update controller_doc_classes.py * fix: temp fix * fix: temp fix * Update controller_doc_classes.py * fix: remove old content * fix: taggfix * init * fix: styling and moved file * Update generate_terminal_markdown.py * fix: removed unused images * fix: port new files * Update generate_sdk_markdown.py * Update controller_doc_classes.py Co-authored-by: teh_coderer <me@tehcoderer.com>
2.6 KiB
Vendored
2.6 KiB
Vendored
title, description
| title | description |
|---|---|
| cps | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
cps
Get number of companies per sector in a specific country (and specific market cap). [Source: Finance Database]
Source Code: [link]
openbb.stocks.sia.cps(country: str = "United States", mktcap: str = "Large", exclude_exchanges: bool = True)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| country | str | Select country to get number of companies by each sector | United States | True |
| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True |
| exclude_exchanges | bool | Exclude international exchanges | True | True |
Returns
| Type | Description |
|---|---|
| dict | Dictionary of sectors and number of companies in a specific country |
Display number of companies per sector in a specific country (and market cap). [Source: Finance Database]
Source Code: [link]
openbb.stocks.sia.cps_chart(country: str = "United States", mktcap: str = "Large", exclude_exchanges: bool = True, export: str = "", raw: bool = False, max_sectors_to_display: int = 15, min_pct_to_display_sector: float = 0.015, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| country | str | Select country to get number of companies by each sector | United States | True |
| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True |
| exclude_exchanges | bool | Exclude international exchanges | True | True |
| export | str | Format to export data as | True | |
| raw | bool | Output all raw data | False | True |
| max_sectors_to_display | int | Maximum number of sectors to display | 15 | True |
| min_pct_to_display_sector | float | Minimum percentage to display sector | 0.015 | 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