curl --request GET \
--url https://api.sandbox.brickken.com/get-balance-whitelist \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-balance-whitelist"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.brickken.com/get-balance-whitelist', 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.sandbox.brickken.com/get-balance-whitelist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.sandbox.brickken.com/get-balance-whitelist"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.sandbox.brickken.com/get-balance-whitelist")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-balance-whitelist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"walletAddress": "<string>",
"tokenAddress": "<string>",
"tokenDecimals": 123,
"tokenBalanceRaw": "<string>",
"tokenBalance": "<string>",
"isWhitelisted": true,
"balanceSource": "blockchain",
"bknFees": "<string>",
"senderBalance": "<string>"
}Get Balance and Whitelist Status
Description: Reads the on-chain token balance and whitelist flag of the wallet associated with an investor or owner email.
bknFees and senderBalance are deprecated legacy fields and are always returned as "0". Read tokenBalance or tokenBalanceRaw instead.
Headers:
x-api-key:YOUR_API_KEY
Query Parameters:
tokenSymbol(string): The symbol of the token.investorEmail(string): Email of the investor or owner.
curl --request GET \
--url https://api.sandbox.brickken.com/get-balance-whitelist \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sandbox.brickken.com/get-balance-whitelist"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.brickken.com/get-balance-whitelist', 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.sandbox.brickken.com/get-balance-whitelist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.sandbox.brickken.com/get-balance-whitelist"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.sandbox.brickken.com/get-balance-whitelist")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.brickken.com/get-balance-whitelist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"walletAddress": "<string>",
"tokenAddress": "<string>",
"tokenDecimals": 123,
"tokenBalanceRaw": "<string>",
"tokenBalance": "<string>",
"isWhitelisted": true,
"balanceSource": "blockchain",
"bknFees": "<string>",
"senderBalance": "<string>"
}Query Parameters
tokenSymbol(required): Token symbolinvestorEmail(required): Email of the investor or owner
Example
curl --request GET \
--url 'https://api.sandbox.brickken.com/get-balance-whitelist?tokenSymbol=EXMPL&investorEmail=investor@example.com' \
--header 'x-api-key: YOUR_API_KEY'
Response
{
"walletAddress": "0x1111111111111111111111111111111111111111",
"tokenAddress": "0x2222222222222222222222222222222222222222",
"tokenDecimals": 18,
"tokenBalanceRaw": "500000000000000000000",
"tokenBalance": "500.0",
"isWhitelisted": true,
"balanceSource": "blockchain",
"bknFees": "0",
"senderBalance": "0"
}
bknFees and senderBalance are deprecated. They are kept in the response for backward compatibility and are
always "0", whatever the real balance is. Read tokenBalance (formatted with tokenDecimals) or
tokenBalanceRaw (smallest unit) instead.balanceSource is always
blockchain. If you already know the wallet address and only need the whitelist flag, use
GET /get-whitelist-status — it does not require the address to
be registered as an investor under an email.Authorizations
Query Parameters
The symbol of the token.
The email of the investor.
Response
Successful response
Checksummed wallet address resolved from the email.
Token contract address the balance was read from.
Decimals of the token contract.
Balance in the smallest unit, as returned by the contract.
Balance formatted with tokenDecimals.
Whether the wallet is whitelisted on the token contract.
Origin of the value. Always blockchain.
blockchain Deprecated. Always "0", kept for backward compatibility.
Deprecated. Always "0", kept for backward compatibility. Use tokenBalance.