Get native token balance for address

Lightweight endpoint to just get the native token balance for an EVM address.

GET /v1/{chainName}/address/{walletAddress}/balances_native/

GoldRush SDK

TypeScript

import { GoldRushClient } from "@covalenthq/client-sdk";

const ApiServices = async () => {
    const client = new GoldRushClient("<GOLDRUSH_API_KEY>");
    const resp = await client.BalanceService.getNativeTokenBalance({chainName: "chainName", walletAddress: "walletAddress"});
    console.log(resp.data);
};

ApiServices();

curl --request GET \
  --url https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/balances_native/ \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/balances_native/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/balances_native/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/balances_native/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/balances_native/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/balances_native/")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.covalenthq.com/v1/{chainName}/address/{walletAddress}/balances_native/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "address": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "quote_currency": "<string>",
  "chain_id": 123,
  "chain_name": "<string>",
  "items": [
    {
      "contract_decimals": 123,
      "contract_name": "<string>",
      "contract_ticker_symbol": "<string>",
      "contract_address": "<string>",
      "supports_erc": [
        "<string>"
      ],
      "logo_url": "<string>",
      "block_height": 123,
      "balance": "<string>",
      "quote_rate": 123,
      "quote": 123,
      "pretty_quote": "<string>"
    }
  ]
}

Credit Cost

0.5 per call

Processing

Realtime

Estimate your monthly cost for this API using the Pricing Calculator.

Not supported on non-EVM chains such as Bitcoin and Solana.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form: Bearer <token>, where <token> is your GoldRush API Key.

Path Parameters

chainName · string · required

The chain name eg: eth-mainnet.

walletAddress · string · required

The requested address. Passing in an ENS, RNS, Lens Handle, or an Unstoppable Domain resolves automatically.

Query Parameters

quote-currency · string

The currency to convert. Supports USD, CAD, EUR, SGD, INR, JPY, VND, CNY, KRW, RUB, TRY, NGN, ARS, AUD, CHF, and GBP.

block-height · integer

Ending block to define a block range. Omitting this parameter defaults to the latest block height.

Response

200 - application/json

Successful response

address · string

The requested address.

updated_at · string<date-time>

The timestamp when the response was generated. Useful to show data staleness to users.

quote_currency · string

The requested quote currency eg: USD.

chain_id · integer

The requested chain ID eg: 1.

chain_name · string

The requested chain name eg: eth-mainnet.

items · object[]

List of response items.

Show child attributes