---
title: "Fetch User Portfolio"
method: GET
path: "/api/portfolio"
tags: ["Portfolio Reporting"]
---

# Fetch User Portfolio

`GET /api/portfolio`

## Request

- Base URL: `https://powered-by-bamboo-sandbox.investbamboo.com`
- URL: `https://powered-by-bamboo-sandbox.investbamboo.com/api/portfolio`
- Auth: none declared. Required headers: `content-type`, `accept-language`, `x-user-id`, `x-subject-type`, `x-client-token`

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

## Headers

- `content-type` string, required
- `accept-language` string, required
- `x-user-id` string, required
- `x-subject-type` string, required
- `currency` string
- `x-client-token` string, required

## Response `200`

Portfolio

- PortfolioResponse
  - `withdrawal_cash` integer, required: Withdrawal cash
  - `withdraw_details` object[], required: withdraw details
    - `country` string: country required for mobile money details i.e only for GHA users
    - `name` string: name required for mobile money details i.e only for GHA users
    - `network` string: network required for mobile money details i.e only for GHA users
    - `phone_number` string: phone_number required for mobile money details i.e only for GHA users
    - `user_id` integer: user_id required for mobile money details i.e only for GHA users
    - `bank_code` string: bank_code for bank details i.e for NGA users
    - `bank_fw_id` string: bank_fw_id required for bank details i.e for NGA users
    - `bank_name` string: bank_name required for bank details i.e for NGA users
    - `account_number` string: account_number required for bank details i.e for NGA users
    - `beneficiary_name` string: beneficiary_name for bank details i.e for NGA users
  - `value_percent_change` integer, required: Equity value percent change
  - `value_change` integer, required: Equity value change
  - `value` integer, required: Portfolio value cash + equity value
  - `user_currency_to_usd` integer, required: User currency to USD exchange rate
  - `user_currency_symbol` string, required: User currency symbol based on residence country
  - `usd_to_user_currency` integer, required: USD to user currency exchange rate
  - `usd_to_naira` integer, 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_cash` integer, required: The amount of Unsettled cash a user has after stock sale
  - `total_cash` integer, required: Total cash
  - `residence_country` string, required: Residence country of user: GHA, NGA or KEN
  - `reserved_cash` integer, required: Reserved cash (mostly unsettled cash)
  - `referral_cashback_blocked_value` integer, required: Non-withdrawal referral cashback until after 30 days
  - `processing_withdrawal` integer, required: Processing withdrawal money
  - `processing_gift_sent` integer, required: Processing gift sent
  - `processing_gift_received` integer, required: Processing gift received
  - `pending_deposit` integer, required: Pending deposit money
  - `naira_to_usd` integer, required: Naira to USD exchange rate
  - `dollar_cash` integer, required: Cash available to invest aka buying power always in $
  - `dollar_balance` integer, required: dollar balance
  - `currency_symbol` string, required: Prices currency symbol
  - `currency_name` string, required: Naira, Shilling or Cedi
  - `currency_code` string, required: NGN, KES or GHS
  - `cash` number, required: Total cash in user's brokerage account. (Also the cash available for user to invest aka buying power)
  - `carrot_held_value` number, required: Carrot held value most likely for liquidation
  - `base_wallet_balance` number, required: Base wallet Balance
  - `actual_value` number, 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_restricted` boolean, required: Account restricted

## Other responses

- `401`: Token have expired or invalid token
- `404`: Resource not found
- `422`: Error response

---

[API](https://skmtc.dev/investbamboo/apis/investbamboo-bamboo-api.md) - [All operations](https://skmtc.dev/investbamboo/apis/investbamboo-bamboo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/investbamboo/apis/investbamboo-bamboo-api/revisions/063521e8d924?raw)