Brickken APIInstall

Summary

Retrieve investor information for a specified investor email and token symbol

Inputs

• tokenSymbol (required) — Symbol of the token
• email (required) — Email of the investor
• requestOptions — Collection of request options such as batching settings
• allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
• proxy — HTTP proxy to use (e.g., http://username:password@myproxy:3128)
• timeout — Timeout in milliseconds for the request

Output shape

a JSON object representing the investor's information

The response may include fields such as investorId, email, investment history; optional fields may be omitted and the shape is defined by the API endpoint.

Examples

Example 1: Fetch investor details for a known investor email

email: 'john.doe@example.com', tokenSymbol: 'REAL'

Example 2: Retrieve investor info with batching enabled

email: 'jane.smith@example.com', requestOptions: { batch: { batchSize: 50 } }