mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 21:12:16 +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>
1.9 KiB
Vendored
1.9 KiB
Vendored
title, description
| title | description |
|---|---|
| ross | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
ross
Get startups from ROSS index [Source: https://runacap.com/].
Source Code: [link]
openbb.alt.oss.ross()
Parameters
This function does not take any parameters.
Returns
| Type | Description |
|---|---|
| pd.DataFrame | list of startups |
Plots list of startups from ross index [Source: https://runacap.com/]
Source Code: [link]
openbb.alt.oss.ross_chart(limit: int = 10, sortby: str = "Stars AGR [%]", ascend: bool = False, show_chart: bool = False, show_growth: bool = True, chart_type: str = "stars", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| limit | int | Number of startups to search | 10 | True |
| sortby | str | Key by which to sort data. Default: Stars AGR [%] | Stars AGR [%] | True |
| ascend | bool | Flag to sort data descending | False | True |
| show_chart | bool | Flag to show chart with startups | False | True |
| show_growth | bool | Flag to show growth line chart | True | True |
| chart_type | str | Chart type {stars,forks} | stars | True |
| export | str | Export dataframe data to csv,json,xlsx file | 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