jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/terminal/reference/crypto/disc/search.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

4.7 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
search This docusaurus page provides detail on how to use the Search function within the CoinPaprika API, including specific parameters such as limit, sort, and category.
CoinPaprika
API
Search function
Data sorting
Data categories
metadata
docusaurus
bitcoin

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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 │
└─────────────────────────┴──────────────────────┴────────────┘