mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-13 04:41:24 +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>
94 lines
3.1 KiB
Markdown
Vendored
94 lines
3.1 KiB
Markdown
Vendored
---
|
|
title: cps
|
|
description: A docusaurus documentation page detailing the usage of the 'cps' and
|
|
'cps_chart' functions within the OpenBB marketing terminal. The functions pertain
|
|
to the analysis of companies per sector in a specific country and market cap
|
|
keywords:
|
|
- docusaurus
|
|
- cps
|
|
- cps_chart
|
|
- OpenBB terminal
|
|
- sector industry analysis
|
|
- finance database
|
|
- stock market
|
|
- metadata
|
|
- market cap analysis
|
|
- company analysis
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.sia.cps - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get number of companies per sector in a specific country (and specific market cap). [Source: Finance Database]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L205)]
|
|
|
|
```python
|
|
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 |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display number of companies per sector in a specific country (and market cap). [Source: Finance Database]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_view.py#L238)]
|
|
|
|
```python
|
|
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
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|