Portfolio Reporting
Fetch User Portfolio Breakdown
This endpoint provides information about the user's good faith violation status, account restrictions, money available for investment or withdrawal, and overall investment performance metrics.
Advanced portfolio analytics include:
- Good faith violations: showing trading rule violation count and impact
- Available to invest: Exact buying power for new trades
- Withdrawable cash: showing funds eligible for withdrawal
- Total return analysis: with comprehensive performance metrics
- Equity Value: Current value of all stock holdings
Risk management information covers day trading restrictions based on account equity levels, violation tracking for pattern day trader rule compliance, and overall account health status.
get/api/portfolio/breakdown
Request
- Base URLhttps://powered-by-bamboo-sandbox.investbamboo.com
- Authnone declared. Required headers: content-type, accept-language, x-user-id, x-subject-type, x-client-token
Headers
content-typestring required
Acceptable content type
accept-languagestring required
Acceptable language; 'en' for English
x-user-idstring required
Required for user authentication
x-subject-typestring required
For user request -> 'tenant'.
currencystring
NGN - to get prices in Naira
x-client-tokenstring required
API consumer token
Response
Portfolio breakdown
Example response
{
"currency_symbol": "$"
}Changes
No recorded changes to this operation across all 1 revision of this API.