kencrypto-alsv
v0.0.3
Published
Uma biblioteca simples para facilitar as consultas na CoinMarketCap API
Downloads
2
Readme
kencrypto-alsv
- Consulte dados de cotação das criptomoedas
- Consulte diretament o valor em Dólar das criptomoedas
- Converta uma quantidade de criptomoeda em outra
Instalação
Usando npm:
npm install kencrypto-alsv
Usando yarn:
yarn add kencrypto-alsv
Usando
É necessário obter a API Key da CoinMarketCap, basta acessar: link ↗
const { EasyCrypMarketCap } = require('kencrypto-alsv');
const cryptoConsultor = EasyCrypMarketCap("API-KEY");
Pegando dados da cotação atual
A biblioteca funciona assíncronamente! Todos retornos são promisses e devem ser tratados como tal!
// instance.quotes(Array<abreviação da criptomoeda(3 letras)>)
const cotacoes = criptoConsultor.quotes(['btc']).then(resp => console.log(resp))
//{
//data: {
// BTC: {
// id: 1,
// name: 'Bitcoin',
// symbol: 'BTC',
// slug: 'bitcoin',
// date_added: '2013-04-28T00:00:00.000Z',
// last_updated: '2022-01-21T17:56:00.000Z',
// quote: {
// price: 1234,
// last_updated: "2022-01-21T15:32:00.000Z"
// }
// }
// }
//}
Valor atual da criptomoeda em dólar
// instance.quoteResult(<abreviação da criptomoeda(3 letras)>)
const cotacaoBTC = criptoConsultor.quoteResult('btc').then(resp => console.log(resp))
// 38531.138414041765
Dados de conversão entre criptomoedas
O plano gratuíto do CoinMarketCap só permite a conversão para 1 (uma) outra criptomoeda"
// instance.conversion(String<abreviação da criptomoeda de origem(3 letras)>, Array<abreviação da criptomoedas para consultar>, Number<quantidade da criptomoeda de origem(padrão=1))
const cotacoes = criptoConsultor.conversion('btc', ['eth']).then(resp => console.log(resp))
// {
// data: {
// id: 1,
// symbol: 'BTC',
// name: 'Bitcoin',
// amount: 1,
// last_updated: '2022-01-21T18:10:00.000Z',
// quote: { ETH: {
// price: 13.599090116518978,
// last_updated: "2022-01-21T01:21:00.000Z"}
// }
// }
//}
Valor de cotação entre criptomoedas
// instance.conversion(String<abreviação da criptomoeda de origem(3 letras)>, String<abreviação da criptomoedas para consultar>, Number<quantidade da criptomoeda de origem(padrão=1))
const BTCtoETH = criptoConsultor.conversionResult('btc', 'eth').then(resp => console.log(resp))
// 13.599090116518978
Erros
Os erros são retornado como uma String! Caso esteja usando typescript uma condicional pode ser necessária para usar os retornos. A verificação de tipo String também pode ser usada para controle de fluxo.
As seguintes mensagens são possíveis:
- "Invalid value for "symbol" => abreviatura da criptomoeda não reconhecida
- "API key missing." => instância criada sem uma API Key
- "Your API Key subscription plan doesn't support this endpoint" => limitações do CoinMarketCap
- "You've exceeded your API Key's HTTP request rate limit. Rate limits reset every minute." => ultrapassado limite de requisições
- "An internal server error occurred" => falha no CoinMarketCap API
- "Your plan is limited to 1 convert options" => limitação do plano gratuíto, só pode converter para uma criptomoeda de destino.