Skip to main content
GET
/
core
/
portfolio
Get overview
curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/portfolio \
  --header 'Authorization: Bearer <token>'
{
  "summary": {
    "total": "68312.82",
    "available": "68312.82"
  },
  "holdings": [
    {
      "asset": "BTC",
      "total": "33.52",
      "available": "33.52"
    },
    {
      "asset": "ETH",
      "total": "1231.44",
      "available": "1231.44"
    },
    {
      "asset": "GBP",
      "total": "67047.86",
      "available": "67047.86"
    }
  ]
}

Denomination

The denomination query parameter allows you to denominate rates against another asset. If no value is set for this parameter, it defaults to USD. For a more detailed explanation of the denomination concept, check the Core Concepts page.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication.

Query Parameters

denomination
string
default:USD

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

Minimum string length: 1
includeBase
boolean
default:false

Whether to include total and available amounts denominated in the base asset, in addition to the selected denomination.

Response

Portfolio overview retrieved.

summary
object
required
holdings
object[]
required