---
title: "Get overview"
method: GET
path: "/core/portfolio"
tags: ["Portfolio"]
---

# Get overview

`GET /core/portfolio`

## Request

- Base URL: `https://api.enterprise.sandbox.uphold.com`
- URL: `https://api.enterprise.sandbox.uphold.com/core/portfolio`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/core/oauth2/token` scopes: `core.portfolio:read`
- TypeScript: <https://skmtc.dev/uphold/apis/core-api/docs/core/portfolio/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves an overview of the portfolio, including the total portfolio value and a breakdown of individual holdings.

## Query parameters

- `denomination` string
- `includeBase` boolean

## Headers

- `X-On-Behalf-Of` string
- `X-Uphold-User-Ip` union
  - string, ipv4
  - string, ipv6
- `X-Uphold-User-Agent` string
- `X-Uphold-User-Origin` string
- `X-Uphold-User-Country` string
- `X-Uphold-User-Subdivision` string
- `X-Uphold-User-City` string

## Response `200`

Portfolio overview retrieved.

- PortfolioOverview
  - `summary` object, required
    - `total` string, required: Total portfolio value.
    - `available` string, required: Available portfolio value.
  - `holdings` PortfolioHolding[], required
    - `asset` string, required: Asset code.
    - `total` string, required: Total amount of the asset.
    - `available` string, required: Available amount of the asset.
    - `baseTotal` string: Base asset total amount.
    - `baseAvailable` string: Base asset available amount.

## Other responses

- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Resource not found.
- `409`: Business logic error.
- `429`: Too Many Requests.

---

[API](https://skmtc.dev/uphold/apis/core-api.md) - [All operations](https://skmtc.dev/uphold/apis/core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uphold/apis/core-api/revisions/6c663575c57a?raw)