Skip to main content
GET
/
get-balance-whitelist
Get Balance and Whitelist Status
curl --request GET \
  --url https://api.sandbox.brickken.com/get-balance-whitelist \
  --header 'x-api-key: <api-key>'
{
  "bknFees": "<string>",
  "senderBalance": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.brickken.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves token balance data for an investor/owner associated with an email.

​
Query Parameters

  • tokenSymbol (required): Token symbol
  • investorEmail (required): Email of the investor/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

{
  "bknFees": "0",
  "senderBalance": "500000000000000000"
}

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

​
bknFees
string

Amount of BKN fees.

​
senderBalance
string

Balance of the sender.