balance-crypto's Introduction

balance-crypto

Get wallet balance for 5.8K+ cryptocurrencies with a single function.

Comparison to crypto-balances-2:

🔐 API keys support (for EtherScan and BlockCypher)
💙 written in TypeScript
⚡ doesn't depend on request libraries
📦 smaller library size
🦕 Deno and Node.js support

Install

# pnpm
pnpm i balance-crypto
# yarn
yarn add balance-crypto
# npm
npm i balance-crypto

To use the module in Deno import it like this: import { balance } from 'https://deno.land/x/balance_crypto/deno/mod.ts'

Example

Node.js

import { balance } from 'balance-crypto'
import fetch from 'node-fetch'

balance('3PxedDftWBXujWtr7TbWQSiYTsZJoMD8K5', 'BTC', {
  keys: {
    etherscan: process.env.ETHERSCAN_KEY,
    blockcypher: process.env.BLOCKYCPHER_KEY
  },
  verbose: true
}).then((res) => console.log(res))

Deno

import { balance } from 'https://deno.land/x/balance_crypto/deno/mod.ts'

balance('3PxedDftWBXujWtr7TbWQSiYTsZJoMD8K5', 'BTC', {
  keys: {
    etherscan: Deno.env.get('ETHERSCAN_KEY'),
    blockcypher: Deno.env.get('BLOCKYCPHER_KEY')
  },
  verbose: true
}).then((res) => console.log(res))

Result:

{ "balance": 0, "asset": "BTC" }

Supported cryptos

Asset	Service	API key
ETH, ERC-20 tokens	https://etherscan.io	✔️
BTC, DASH, LTC, DOGE	https://blockcypher.com	✔️ (optional)
BTC-based tokens	https://chainz.cryptoid.info
ADA	https://explorer.cardano.org

balance-crypto's People

Stargazers

Watchers

balance-crypto's Issues

doge search

Hello, i am searching doge coin with this :

balance('0xf8e9b725e0de8a9546916861c2904b0eb8805b96', 'DOGE', {
keys: {
etherscan: process.env.ETHERSCAN_KEY,
blockcypher: process.env.BLOCKYCPHER_KEY
},
verbose: true
}).then((res) => console.log(res))

it says every doge address : Error: Invalid address "0xf8e9b725e0de8a9546916861c2904b0eb8805b96" for DOGE

Neoscan integration

URL: https://neoscan.io
Coins: NEO, GAS

Not working for me

I'm running the example code in README

 npm run test

> [email protected] test
> node --loader ts-node/esm --experimental-specifier-resolution=node node_modules/uvu/bin.js

(node:19362) ExperimentalWarning: `--experimental-loader` may be removed in the future; instead use `register()`:
--import 'data:text/javascript,import { register } from "node:module"; import { pathToFileURL } from "node:url"; register("ts-node/esm", pathToFileURL("./"));'
(Use `node --trace-warnings ...` to show where the warning was created)
(node:19362) ExperimentalWarning: The Node.js specifier resolution flag is experimental. It could change or be removed at any time.
(node:19362) ExperimentalWarning: The Node.js specifier resolution flag is experimental. It could change or be removed at any time.
(Use `node --trace-warnings ...` to show where the warning was created)
test/test.js

  Total:     0
  Passed:    0
  Skipped:   0
  Duration:  0.96ms

file:///home/debian/node_modules/balance-crypto/dist/index.js:5171
        throw new Error(`Invalid address "${addr}" for ${coin}`);
              ^

Error: Invalid address "3PxedDftWBXujWtr7TbWQSiYTsZJoMD8K5" for BTC
    at balance (file:///home/debian/node_modules/balance-crypto/dist/index.js:5171:15)
    at file:///home/debian/node_modules/balance-crypto/test/test.js:4:1
    at ModuleJob.run (node:internal/modules/esm/module_job:195:25)
    at async ModuleLoader.import (node:internal/modules/esm/loader:336:24)
    at async Module.run (file:///home/debian/node_modules/balance-crypto/node_modules/uvu/run/index.mjs:9:3)
    at async /home/debian/node_modules/balance-crypto/node_modules/uvu/bin.js:26:5

Node.js v18.19.0

I also tried ETH and added an valid API. It said API invalid. Code broken?

Recommend Projects