---
title: "Get portfolio"
method: GET
path: "/v0/portfolios/"
tags: ["Portfolios"]
---

# Get portfolio

`GET /v0/portfolios/`

## Request

- Base URL: `https://distributor-api.spiko.io`
- URL: `https://distributor-api.spiko.io/v0/portfolios/`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/portfolios/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a view of an investor's investment portfolio, including current asset values, asset allocation, and performance metrics.

## Query parameters

- `investorId` string, uuid, required: a Universally Unique Identifier

## Response `200`

Success

- object
  - `items` object[], required
    - `investorId` string, uuid, required: a Universally Unique Identifier
    - `accountId` string, uuid, required: a Universally Unique Identifier
    - `shareClassId` string, uuid, required: a Universally Unique Identifier
    - `network` 'Ethereum' | 'Polygon' | 'Base' | 'Arbitrum' | 'ArbitrumUk' | 'Etherlink' | 'Starknet' | 'Stellar' | 'Solana', required: a blockchain network e.g. "Ethereum", "Polygon", "Arbitrum", "Starknet"
    - `walletAddress` union, required
      - string
      - string
      - string
      - string
      - string: a valid Solana address, consisting of 32 to 44 base58 characters
    - `totalNumberOfShares` string, required
    - `currentValue` NonNegativeAmount, required
      - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
      - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
    - `isCustodialWallet` boolean, required
    - `pending` object, required
      - `credit` object, required
        - `numberOfSubscriptions` integer, required
        - `amount` NonNegativeAmount, required
          - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
        - `approximated` boolean, required
      - `debit` object, required
        - `numberOfRedemptions` integer, required
        - `approximated` boolean, required
        - `amount` NonNegativeAmount, required
          - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
          - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
    - `projectedBalance` NonNegativeAmount, required
      - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
      - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
    - `projectedBalanceInShares` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
    - `withdrawableBalance` NonNegativeAmount, required
      - `value` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
      - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"
    - `withdrawableBalanceInShares` string, required: a string representation of a non-negative decimal number e.g. "10000", "0.00" or "3420.92"
    - `virtualIban` string: a valid IBAN (International Bank Account Number)
    - `bic` string
    - `depositIbanLines` object[]
      - `label` string, required
      - `value` string, required
      - `tooltip` string
    - `cashCollectionBankAccountBeneficiaryName` string
  - `totalGainSinceStart` object[], required
    - `investorId` string, uuid, required: a Universally Unique Identifier
    - `accountId` string, uuid, required: a Universally Unique Identifier
    - `shareClassId` string, uuid, required: a Universally Unique Identifier
    - `totalGainAmount` Amount, required
      - `value` string, required: a string representation of a decimal number e.g. "10000", "0.00" or "-7432092.04"
      - `currency` 'EUR' | 'USD' | 'GBP' | 'CHF' | 'JPY' | 'SGD' | 'SEK' | 'NOK' | 'DKK' | 'PLN' | 'HUF' | 'CZK', required: a currency code among "EUR", "USD", "GBP", "CHF", "JPY", "SGD", "SEK", "NOK", "DKK", "PLN", "HUF", "CZK"

## Other responses

- `400`: The request did not match the expected schema
- `401`: Authentication failed. Two bodies are possible: the schema below when the API rejects the credentials, and `{ "error": { "code", "status", "request", "message" } }` when the API gateway rejects them first. Only the former carries a `_tag`.
- `403`: Forbidden
- `404`: NotFound
- `503`: The investor is undergoing a scheduled upgrade, access is temporarily paused to ensure data safety.

---

[API](https://skmtc.dev/spiko/apis/spiko-distributor-api.md) - [All operations](https://skmtc.dev/spiko/apis/spiko-distributor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spiko/apis/spiko-distributor-api/revisions/ad85137fd00b?raw)