Files
OpenBB/website/content/sdk/reference/alt/oss/search.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

36 lines
854 B
Markdown
Vendored

---
title: search
description: OpenBB SDK Function
---
# search
Get repos sorted by stars or forks. Can be filtered by categories.
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_model.py#L56)]
```python
openbb.alt.oss.search(sortby: str = "stars", page: int = 1, categories: str = "")
```
---
## Parameters
| Name | Type | Description | Default | Optional |
| ---- | ---- | ----------- | ------- | -------- |
| sortby | str | Sort repos by {stars, forks} | stars | True |
| categories | str | Check for repo categories. If more than one separate with a comma: e.g., finance,investment. Default: None | | True |
| page | int | Page number to get repos | 1 | True |
---
## Returns
| Type | Description |
| ---- | ----------- |
| pd.DataFrame | Dataframe with repos |
---