Brickken APIInstall

Summary

Retrieve the balance of a specified STO, optionally with whitelist status and token info using its symbol and ID.

Inputs

• tokenSymbol (required) — Symbol of the token associated with the STO (e.g., ETH, USDC).
• id (required) — Unique identifier of the STO whose balance is being fetched.
• requestOptions — Optional request configuration such as batching settings.
• allowUnauthorizedCerts — If true, accept responses with invalid SSL certificates.
• proxy — HTTP proxy URL, e.g., http://username:password@myproxy:3128.
• timeout — Request timeout in milliseconds.

Output shape

an object representing the STO balance, typically including balance and whitelistStatus fields.

The response may include additional metadata; balance is generally required, other fields are optional and may vary by endpoint version.

Examples

Example 1: Fetch balance for STO ID 12345 using token symbol ETH.

tokenSymbol=ETH, id=12345, requestOptions={}, timeout=10000

Example 2: Enable batching to throttle requests.

requestOptions.batchSize=100, requestOptions.batchInterval=500

Example 3: Ignore SSL certificate validation errors.

allowUnauthorizedCerts=true, proxy=http://myproxy:3128