kencrypto-biblioteca-kp
v1.0.5
Published
Esta entrega consiste na criação de uma pequena biblioteca em TypeScript que lidará com a busca e tratamento das informações de cotação e conversão das moedas.
Downloads
3
Readme
Entrega 4: Kencrypto
Esta entrega consiste na criação de uma pequena biblioteca em TypeScript que lidará com a busca e tratamento das informações de cotação e conversão das moedas.
API usada: CoinMarketCap
Objetivo:
Criar uma biblioteca que facilite o acesso à API CoinMarketCap, de forma que o uso da biblioteca não demande que seja informada nenhuma URL, podendo obter as informações diretamente por meio de funções.
Exemplo de uso:
- Importar a biblioteca:
import { KenCrypto } from "kencrypto-biblioteca-kp";
- Deve ser criado um arquivo .env na raiz do seu projeto. Nela deve ser colocado sua chave da API CoinMarketCap. Caso não tenha a chave de API, ela pode ser gerada aqui: https://coinmarketcap.com/api/ Exemplo de como deve ser passada a chave no .env:
API_KEY=sua_chave_deve_ser_colocada_aqui
- Usando a bilioteca:
const teste = new KenCrypto()
teste.quotes(["BTC"]).then((resp) => {
console.log(resp)
})
teste.conversion(["BTC"], 50, ["BRL"]).then((resp) => {
console.log(resp)
})
Rotas da API CoinMarketCap:
- Cotação Atual
A documentação sobre como obter a cotação atual pode ser vista aqui: https://coinmarketcap.com/api/documentation/v1/#operation/getV1CryptocurrencyQuotesLatest
Por questão de simplicidade, vamos trabalhar apenas com o parâmetro symbol.
O symbol deve aceitar uma ou mais moedas. Se for mais de uma, elas devem estar separadas por vírgula, da seguinte forma: symbol=BTC,ETH.
- exemplo de retorno:
{
"data": {
"BTC": {
"id": 1,
"name": "Bitcoin",
"symbol": "BTC",
"slug": "bitcoin",
"date_added": "2013-04-28T00:00:00.000Z",
"last_updated": "2021-08-26T17:44:11.000Z",
"quote": {
"USD": {
"price": 46963.215165006586,
"last_updated": "2021-08-26T17:44:11.000Z"
}
}
}
}
}
- Conversão de Preço
A documentação sobre como obter uma conversão de preços pode ser vista aqui: https://coinmarketcap.com/api/documentation/v1/#operation/getV1ToolsPriceconversion
Por questão de simplicidade, vamos trabalhar apenas com os parâmetros amount, symbol e convert.
- exemplo de retorno:
{
"data": {
"id": 1,
"symbol": "BTC",
"name": "Bitcoin",
"amount": 25.67,
"last_updated": "2021-08-26T18:30:17.000Z",
"quote": {
"ETH": {
"price": 386.5352847529818,
"last_updated": "2021-08-26T18:30:16.000Z"
}
}
}
}
Métodos da Biblioteca KenCrypto
quotes:
- deverá trazer os dados de cotação atual para a(s) moeda(s) informada(s).
conversion:
- deverá trazer os valores de conversão entre as moedas desejadas.