> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get portfolio statement
> Retrieves the portfolio statement for a given period.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json get /core/statements/portfolio
openapi: 3.1.0
info:
version: 0.1.0
title: Core API
description: >-
The Core API provides essential building blocks that empower businesses to
embed financial services into their applications.
contact:
name: Uphold API Team
email: developers@uphold.com
url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
description: Sandbox
- url: https://api.enterprise.uphold.com
description: Production
security:
- OAuth2: []
tags:
- name: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/statements/portfolio:
get:
tags:
- Statements
summary: Get portfolio statement
description: Retrieves the portfolio statement for a given period.
operationId: core.get-portfolio-statement
parameters:
- $ref: '#/components/parameters/period'
- $ref: '#/components/parameters/year'
- $ref: '#/components/parameters/month'
- $ref: '#/components/parameters/denomination'
responses:
'200':
$ref: '#/components/responses/get-portfolio-statement-response'
'409':
$ref: '#/components/responses/get-portfolio-statement-conflict-response'
security:
- OAuth2:
- core.statements:read
components:
parameters:
period:
name: period
description: The statement period type.
in: query
required: true
schema:
type: string
enum:
- one-month
examples:
Period:
value: one-month
year:
name: year
description: The statement year.
in: query
required: true
schema:
type: integer
format: int32
minimum: 2010
maximum: 2100
examples:
Year:
value: 2026
month:
name: month
description: The statement month.
in: query
required: true
schema:
type: integer
format: int32
minimum: 1
maximum: 12
examples:
Month:
value: 3
denomination:
name: denomination
description: >-
Specifies the asset code to use as the denomination for value
conversion. If not provided, USD is used by default.
in: query
required: false
schema:
type: string
minLength: 1
default: USD
examples:
BTC Asset:
value: BTC
responses:
get-portfolio-statement-response:
description: Portfolio statement retrieved.
content:
application/json:
schema:
type: object
properties:
statement:
$ref: '#/components/schemas/portfolio-statement'
required:
- statement
examples:
Portfolio Statement Retrieved:
value:
statement:
period:
from: '2026-03-01T00:00:00.000Z'
to: '2026-03-31T23:59:59.999Z'
rates:
BTC-USD: '61728.00'
holdings:
- asset: BTC
total: '0.02'
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
get-portfolio-statement-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Denomination Asset Not Supported:
value:
code: asset_not_supported
message: The denomination asset is not supported
details:
context: query
property: denomination
Statement Period Not Complete:
value:
code: date_invalid
message: The statement period is not yet complete
details:
context: query
Statement Period Before User Creation:
value:
code: date_invalid
message: The statement period predates the user creation date
details:
context: query
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
schemas:
portfolio-statement:
type: object
properties:
period:
$ref: '#/components/schemas/statement-period'
rates:
type: object
description: >-
Exchange rates keyed by asset-denomination pair (e.g. BTC-USD,
USD-EUR).
additionalProperties:
type: string
holdings:
type: array
items:
$ref: '#/components/schemas/portfolio-statement-holding'
required:
- period
- rates
- holdings
error:
description: The error information.
type: object
properties:
code:
description: >-
A short string with a brief explanation about the error code
reported.
type: string
message:
description: A human-readable message providing more details about the error.
type: string
details:
description: Additional information about the error reported.
type: object
additionalProperties: true
required:
- code
- message
statement-period:
type: object
properties:
from:
type: string
format: date-time
description: The start of the statement period.
to:
type: string
format: date-time
description: The end of the statement period.
required:
- from
- to
portfolio-statement-holding:
type: object
properties:
asset:
type: string
description: The asset code.
total:
type: string
description: The total amount held at the end of the period.
required:
- asset
- total
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````