Skip to main content
GET
Get Balance and Whitelist Status
Reads the on-chain token balance and whitelist flag of the wallet associated with an investor or owner email.

Query Parameters

  • tokenSymbol (required): Token symbol
  • investorEmail (required): Email of the investor or owner

Example

Response

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.
Both the balance and the whitelist flag are read from the token contract, so 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

x-api-key
string
header
required

Query Parameters

tokenSymbol
string
required

The symbol of the token.

investorEmail
string
required

The email of the investor.

Response

200 - application/json

Successful response

walletAddress
string

Checksummed wallet address resolved from the email.

tokenAddress
string

Token contract address the balance was read from.

tokenDecimals
integer

Decimals of the token contract.

tokenBalanceRaw
string

Balance in the smallest unit, as returned by the contract.

tokenBalance
string

Balance formatted with tokenDecimals.

isWhitelisted
boolean

Whether the wallet is whitelisted on the token contract.

balanceSource
enum<string>

Origin of the value. Always blockchain.

Available options:
blockchain
bknFees
string

Deprecated. Always "0", kept for backward compatibility.

senderBalance
string

Deprecated. Always "0", kept for backward compatibility. Use tokenBalance.