Files
OpenBB/website/content/sdk/reference/stocks/sia/cpcs.md
jose-donato 2e7eb4c9b6 New documentation website (#3526)
* 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>
2022-11-22 16:47:03 +00:00

2.5 KiB
Vendored

title, description
title description
cpcs OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

cpcs

Get number of companies per country in a specific sector (and specific market cap).

Source Code: [link]

openbb.stocks.sia.cpcs(sector: str = "Technology", mktcap: str = "Large", exclude_exchanges: bool = True)

Parameters

Name Type Description Default Optional
sector str Select sector to get number of companies by each country Technology 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 countries and number of companies in a specific sector

Display number of companies per country in a specific sector. [Source: Finance Database]

Source Code: [link]

openbb.stocks.sia.cpcs_chart(sector: str = "Technology", mktcap: str = "Large", exclude_exchanges: bool = True, export: str = "", raw: bool = False, max_countries_to_display: int = 15, min_pct_to_display_country: float = 0.015, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
sector str Select sector to get number of companies by each country Technology 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_countries_to_display int Maximum number of countries to display 15 True
min_pct_to_display_country float Minimum percentage to display country 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