Statements

Get portfolio statement

Retrieves the portfolio statement for a given period.

get/core/statements/portfolio

Request

Base URL
https://api.enterprise.sandbox.uphold.com
Auth
OAuth 2
Client credentials
Token URL/core/oauth2/token
Scopescore.statements:read
TypeScript
https://skmtc.dev/uphold/apis/core-api/docs/core/statements/portfolio/get.ts
A function with typed inputs. Its response is checked against the schema.

period'one-month' required

The statement period type.

yearinteger required

The statement year.

monthinteger required

The statement month.

denominationstring

Specifies the asset code to use as the denomination for value conversion. If not provided, USD is used by default.

X-On-Behalf-Ofstring

The subject on whose behalf the operation is being performed.

string ipv4

string ipv6

Contains the IP of the end user that is requesting the operation.

X-Uphold-User-Agentstring

Contains the user agent of the end user that is requesting the operation.

X-Uphold-User-Originstring

Contains the origin of the request made by the end user.

X-Uphold-User-Countrystring

Contains the code of the country of the end user that is requesting the operation.

X-Uphold-User-Subdivisionstring

Contains the code of the subdivision of the end user that is requesting the operation.

X-Uphold-User-Citystring

Contains the name of the city of the end user that is requesting the operation.

Portfolio statement retrieved.

No recorded changes to this operation across all 1 revision of this API.