Skip to main content
GET
/
core
/
portfolio
/
accounts
/
{accountId}
/
historical-balance
Get account historical balance
curl --request GET \
  --url https://api.enterprise.sandbox.uphold.com/core/portfolio/accounts/{accountId}/historical-balance \
  --header 'Authorization: Bearer <token>'
{
  "historicalBalance": [
    {
      "timestamp": "2020-01-01T00:00:00Z",
      "balance": {
        "total": "1000.00",
        "available": "950.00"
      }
    },
    {
      "timestamp": "2020-01-02T00:00:00Z",
      "balance": {
        "total": "1200.00",
        "available": "1150.00"
      }
    }
  ]
}

​
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. There is a specific set of assets allowed, including but not limited to: USD, EUR, GBP, AUD, CAD, NZD, MXN, and BTC. If you need a particular asset added to this list, please reach out to your Account Manager. For a more detailed explanation of the denomination concept, check the Core Concepts page.

​
Interval

The interval query parameter determines the overall timespan of historical data and the frequency of the data points (rollup frequency). Each interval value defines how far back in time the data spans, and how granular each returned data point is within that range:
IntervalDescriptionRollup Frequency
one-hourPast hour of historical data30 seconds
one-dayPast day of historical data10 minutes
one-weekPast week of historical data1 hour
one-monthPast month of historical data6 hours
one-yearPast year of historical data2 days

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication.

Path Parameters

​
accountId
string<uuid>
required

The account id.

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 length: 1
​
interval
enum<string>
default:one-day

The interval for the portfolio historical data.

Available options:
one-hour,
one-day,
one-week,
one-month,
one-year
​
includeBase
boolean
default:false

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

Response

Portfolio account historical balance retrieved.

​
historicalBalance
object[]
required
Minimum length: 1