mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
4.3 KiB
Vendored
4.3 KiB
Vendored
title, description
| title | description |
|---|---|
| search | OpenBB Terminal Function |
search
Search over CoinPaprika API You can display only N number of results with --limit parameter. You can sort data by id, name , category --sort parameter and also with --reverse flag to sort descending. To choose category in which you are searching for use --cat/-c parameter. Available categories: currencies|exchanges|icos|people|tags|all Displays: id, name, category
Usage
search -q QUERY [QUERY ...] [-c {currencies,exchanges,icos,people,tags,all}] [-l LIMIT] [-s {category,id,name}] [-r]
Parameters
| Name | Description | Default | Optional | Choices |
|---|---|---|---|---|
| query | phrase for search | None | False | None |
| category | Categories to search: currencies | exchanges | icos | people |
| limit | Limit of records | 10 | True | None |
| sortby | Sort by given column. Default: id | id | True | category, id, name |
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
Examples
2022 Feb 15, 06:51 (🦋) /crypto/disc/ $ search -q bitcoin
CoinPaprika Results
┌─────────────────────────┬──────────────────────┬────────────┐
│ id │ name │ category │
├─────────────────────────┼──────────────────────┼────────────┤
│ bbtc-baby-bitcoin │ Baby Bitcoin │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bc-bitcoin-confidential │ Bitcoin Confidential │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bca-bitcoin-atom │ Bitcoin Atom │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bcd-bitcoin-diamond │ Bitcoin Diamond │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bcf-bitcoin-fast │ Bitcoin Fast │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bch-bitcoin-cash │ Bitcoin Cash │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bch-bitcoin-cash-token │ Bitcoin Cash Token │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bci-bitcoin-interest │ Bitcoin Interest │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bcr-bitcoinrock │ BITCOINROCK │ currencies │
├─────────────────────────┼──────────────────────┼────────────┤
│ bct-bitcointrust │ BitcoinTrust │ currencies │
└─────────────────────────┴──────────────────────┴────────────┘