kencrypto-iago v1.0.1

kencrypto

Biblioteca que simplifica duas rotas da API CoinMarketCap, feito como uma atividade do curso fullstack da Kenzie Academy

Documentação da CoinMarketCap: https://coinmarketcap.com/api/documentation/v1/

Como instalar e rodar?

Instalação:

npm i kencrypto-iago

Basta exportar a classe "KenCrypto" e criar uma instancia. Ela recebe como parametro sua chave da biblioteca CoinMarketCap e possui os metodos para ver a cotação atual da moeda e a conversão de preço de uma moeda para outra

Utilização

Metodo .quote

mostra a cotação da moeda.

Parametro: symbol - Symbol da moeda. 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"
                }
            }
        }
    }
}

Metodo .conversion

Converte um valor de uma cryptomoeda para outra moeda.

Parametros:

• amount: valor para converter
• symbol: Symbol da moeda que quer converter. Só aceita uma.
• convert: Symbol da moeda que quer que o valor seja convertido. Só aceita uma.

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"
            }
        }
    }
}

Types

Também pode ser exportado da biblioteca os seguintes types para programação com typescript:

• quoteInterface: retorno do metodo .quote
• conversionInfosInterface: retorno do metodo .conversion
• errorInterface: formado do retorno dos metodos, em caso e erro

Tecnologias utilizadas

• typescript
• axios

Licence

MIT