Brickken APIInstall

Summary

Fetch token balance and whitelist status for an investor

Inputs

• tokenSymbol (required) — Symbol of the token (e.g., USDT)
• investorEmail (required) — Email of the investor to check whitelist status
• requestOptions — Optional request configuration such as batching settings
• allowUnauthorizedCerts — Whether to skip SSL certificate validation
• proxy — HTTP proxy URL to use for the request
• timeout — Request timeout in milliseconds

Output shape

a JSON object with fields "balance" (numeric) and "whitelisted" (boolean) indicating the token balance and whether the investor is on the whitelist

Response contains only these fields on success; errors return a standard error envelope but are not part of the successful shape

Examples

Example 1: Check balance and whitelist for USDT token of investor@example.com

tokenSymbol=USDT, investorEmail=investor@example.com

Example 2: Check balance for token X with batching enabled

tokenSymbol=X, investorEmail=john@example.com, requestOptions={"batch":{"batchSize":100}}

Example 3: Perform request with custom proxy and SSL verification disabled

tokenSymbol=TOK, investorEmail=user@example.com, proxy=http://proxy:3128, allowUnauthorizedCerts=true