INinvestbamboo
Portfolio Reporting

Fetch User Portfolio

This endpoint returns summarized information about a user's total portfolio value, gains and losses, cash positions, and pending deposits and withdrawals with regards to the US market.

The portfolio overview includes:
  • Current valuation: with real-time portfolio value and daily changes
  • Comprehensive cash positions: breaking down all cash types and availability
  • Currency conversion: showing values in both USD and the user's local currency
  • Deposit and withdrawal status: for pending money movement operations
  • Account restrictions: indicating any limitations on account activities
get/api/portfolio

Request

  • Base URL
    https://powered-by-bamboo-sandbox.investbamboo.com
  • Auth
    none 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

withdrawal_cashinteger required

Withdrawal cash

value_percent_changeinteger required

Equity value percent change

value_changeinteger required

Equity value change

valueinteger required

Portfolio value cash + equity value

user_currency_to_usdinteger required

User currency to USD exchange rate

user_currency_symbolstring required

User currency symbol based on residence country

usd_to_user_currencyinteger required

USD to user currency exchange rate

usd_to_nairainteger required

USD to Naira exchange rate

extended_hours_status'ENABLED' | 'DISABLED' nullable required

Indicates the user's extended hours trading status.

  • null: Returned for existing users or when extended_hours_opt_in was not included during onboarding.
  • ENABLED: Returned when the user's brokerage account is successfully created or they later opt in via the extended_hours opt_in endpoint.
  • DISABLED: Returned when the user opts out via the extended_hours opt_in endpoint.
unsettled_cashinteger required

The amount of Unsettled cash a user has after stock sale

total_cashinteger required

Total cash

residence_countrystring required

Residence country of user: GHA, NGA or KEN

reserved_cashinteger required

Reserved cash (mostly unsettled cash)

referral_cashback_blocked_valueinteger required

Non-withdrawal referral cashback until after 30 days

processing_withdrawalinteger required

Processing withdrawal money

processing_gift_sentinteger required

Processing gift sent

processing_gift_receivedinteger required

Processing gift received

pending_depositinteger required

Pending deposit money

naira_to_usdinteger required

Naira to USD exchange rate

dollar_cashinteger required

Cash available to invest aka buying power always in $

dollar_balanceinteger required

dollar balance

currency_symbolstring required

Prices currency symbol

currency_namestring required

Naira, Shilling or Cedi

currency_codestring required

NGN, KES or GHS

cashnumber required

Total cash in user's brokerage account. (Also the cash available for user to invest aka buying power)

carrot_held_valuenumber required

Carrot held value most likely for liquidation

base_wallet_balancenumber required

Base wallet Balance

actual_valuenumber required

Total sum of a user's portfolio. i.e, a sum of the amount of US Stocks they own, amount in unsettled cash and amount in their brokerage account

account_restrictedboolean required

Account restricted

Example response

{
  "withdraw_details": [
    {
      "country": "Nigeria",
      "name": "John",
      "bank_name": "Sterling Bank",
      "account_number": "0211873910",
      "beneficiary_name": "John Doe"
    }
  ],
  "user_currency_symbol": "₦",
  "usd_to_user_currency": 868,
  "usd_to_naira": 868,
  "residence_country": "NGA",
  "currency_symbol": "₦",
  "currency_name": "Nigerian Naira",
  "currency_code": "NGN"
}

Changes

No recorded changes to this operation across all 1 revision of this API.