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

# Get performance

`GET /core/portfolio/performance`

## Request

- Base URL: `https://api.enterprise.sandbox.uphold.com`
- URL: `https://api.enterprise.sandbox.uphold.com/core/portfolio/performance`
- 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/performance/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the performance of the portfolio, including the average cost, total invested, and unrealized gains (gains and losses).

## Query parameters

- `denomination` string
- `interval` 'one-hour' | 'one-day' | 'all-time'

## 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 performance retrieved.

- object
  - `performance` PortfolioPerformanceOverview, required
    - `totalInvested` string, decimal, required: The total amount invested in the portfolio.
    - `unrealizedGains` string, decimal, required: The unrealized gains or losses of the portfolio.

## 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)