From abd181a7065daa67cf3b396e3542a8f4759b0bc8 Mon Sep 17 00:00:00 2001 From: bchamagne Date: Tue, 9 Jan 2024 18:31:49 +0100 Subject: [PATCH] documentation --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 2db009c..c2376fd 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,35 @@ An API server that provides various off-chain resources. Such as cryptocurrencies prices. + +## Quotes + +Cryptocurrencies handled: + +- bitcoin +- bnb +- eth +- matic +- uco +- ... more later + +Providers requested: + +- coinmarketcap.com +- ... more later + +### Latest + +Return the latest available quotes from given cryptocurrencies. The result is an aggregate of multiple providers. + +`GET /v2/cryptocurrency/quotes/latest?currency=eth,bitcoin,matic,uco,bnb` + +```json +{ + "bitcoin":46886.44559469423, + "bnb":301.88655780971703, + "eth":2263.032408397367, + "matic":0.790940929057782, + "uco":0.04767200156279931 +} +```