Simple Ethereum API to get your ERC20 Token Balance along with useful information
Clone or download
Latest commit 1fcaffa Nov 6, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd docker multistage build Nov 6, 2018
docs server status Jun 1, 2018
.dockerignore docker multistage build Nov 6, 2018
.gitignore docker multistage build Nov 6, 2018
.travis.yml go dep Nov 6, 2018
Dockerfile docker multistage build Nov 6, 2018
Gopkg.lock docker multistage build Nov 6, 2018
Gopkg.toml docker multistage build Nov 6, 2018
LICENSE Create LICENSE Apr 2, 2017
Makefile docker multistage build Nov 6, 2018 updates Nov 6, 2018
doc.go examples - docs - dep Oct 6, 2018
example_test.go decimal 0 fix Oct 30, 2018
tokenbalance.go healthcheck Nov 6, 2018
tokenbalance_test.go decimal 0 fix Oct 31, 2018
tokens.go remove exports Oct 6, 2018
types.go decimal 0 fix Oct 30, 2018


TokenBalance API Build Status Docker Build Status Coverage Status GoDoc

TokenBalance is an easy to use public API and application that will output your ERC20 Token balance without any troubles. You can run TokenBalance on your local computer or you can use to easily parse your erc20 token balances. Connects to your local geth IPC and prints out a simple JSON response for ethereum token balances. Runs on port 8080 by default if you wish to run locally.

Server Status and Uptime

You can view the current status of Token Balance along with API latency information on our status page. This status page logs the Ethereum Mainnet, Ropsten testnet, and Rinkeby testnet.

Installing Token Balance

You don't need to compile Token Balance from source anymore! All you need to do is go to Releases in this repo and download the binary that is built for your OS. Once you've downloaded, rename the file to tokenbalance for ease if use. On Mac or Linux move this file with the command mv tokenbalance /usr/local/bin/tokenbalance, you should be able to run the application from anywhere now.

Token Balance and Token Info (/token)

To fetch information about your balance, token details, and ETH balance use the follow API call in a simple HTTP GET or CURL. The response is in JSON so you can easily parse what you need. Replace TOKEN_ADDRESS with the contract address of the ERC20 token, and replace ETH_ADDRESS with your address.

Ethereum Mainnet
Ethereum Ropsten Testnet
Ethereum Rinkeby Testnet
  • Response (JSON)
    "name": "Kin",
    "wallet": "0x393c82c7Ae55B48775f4eCcd2523450d291f2418",
    "symbol": "KIN",
    "decimals": 18,
    "balance": "15788648",
    "eth_balance": "0.217960852347180212",
    "block": 4274167

Only Token Balance (/balance)

This API response will only show you the ERC20 token balance in plain text. Perfect for ultra simple parsing.
  • Response (PLAIN TEXT)


Run with Docker

You can easily start Token Balance with Docker. Register for a free API Key to use Token Balance without downloading the ethereum blockchain.

docker run -p 8080:8080 -e GETH_SERVER= -d hunterlong/tokenbalance

Use as Golang Package

You can use Token Balance as a typical Go Language package if you you like to implement ERC20 functionality into your own application.

go get
First you'll want to connect to your Geth server or IPC
import (

func main() {
	// connect to your Geth Server
    configs = &tokenbalance.Config{
         GethLocation: "",
         Logs:         true,

    // insert a Token Contract address and Wallet address
    contract := "0x86fa049857e0209aa7d9e616f7eb3b3b78ecfdb0"
    wallet := "0xbfaa1a1ea534d35199e84859975648b59880f639"

    // query the blockchain and wallet details
    token, err := tokenbalance.New(contract, wallet)

    // Token Balance will respond back useful things
    token.BalanceString()  // "600000.0"
    token.ETHString()      // "1.020095885777777767"
    token.Name             // "OmiseGO"
    token.Symbol           // "OMG"
    token.Decimals         // 18
    token.Balance          // big.Int() (token balance)
    token.ETH              // big.Int() (ether balance)

Implement in Google Sheets

If your familiar with Google Sheets, you can easily fetch all of your cryptocurrency balances within 1 spreadsheet. All you need to do is make a cell with the value below.


Simple as that! Get creative an use Coin Market Cap's API to fetch the price and multiply with your balance to make a portfolio of your cryptocurrencies!

Implement in your App

Feel free to use the TokenBalance API server to fetch ERC20 token balances and details. We do have a header set that will allow you to call the API via AJAX. Access-Control-Allow-Origin "*" The server may limit your requests if you do more than 60 hits per minute.

Run Your Own Server

TokenBalance isn't just an API, it's an opensource HTTP server that you can run on your own computer or server.


Ubuntu 16.04
git clone
cd tokenbalance
go get && go build ./cmd

Start TokenBalance Server

tokenbalance start --geth="/ethereum/geth.ipc"

This will create a light weight HTTP server will respond balance information about a ethereum contract token.

Optional Config

tokenbalance start --geth="/ethereum/geth.ipc" --port 8080 --ip

CURL Request




    "name": "Kin",
    "wallet": "0x393c82c7Ae55B48775f4eCcd2523450d291f2418",
    "symbol": "KIN",
    "decimals": 18,
    "balance": "15788648",
    "eth_balance": "0.217960852347180212",
    "block": 4274167