Skip to main content

Holding report

Returns a time series of a customer's cash balance and token holdings. Only cash and gold balances are being retrieved. The amount retrieved is then used to plot the chart showing the portfolio's value over time.

Path Parameters
accountId string REQUIRED

Account identifier defined by the customer (i.e. Cust. Ref. No.)

Query Parameters
interval int32

Possible values: [1, 60, 1440, 10080, -1]

Time intervals, expressed in minutes. Integer value represents the member's equivalent number of minutes (except for Month (-1) and Year (-2)

Accepts "Minute"/"Hour"/"Day"(-1) or the equivalent no. of minutes unless otherwise bracketed. Determines the interval between spots we are concerned with.

currency string

The fiat currency that we want to query for gold prices in (e.g. SGD). Defaults to system defined base currency if not provided.

intervalSize int32

The gap between each intervals. (e.g. X minutes, X hours, X days)

Responses
200

Success

Schema
object[]
Holdings object

Used to describe

AuGrams object

Represents the gold holdings of a customer, by currency, by day

AccumulatedStorage double

Storage fee accrued for the day

Amount double

Grams of the product held

Valuation double

Value of the product held for the day

WeightedCost double

The weighted average cost paid by the customer across all of his/her purchases, multiplied by Amount

AuGramsBonus object

Represents the gold holdings of a customer, by currency, by day

AccumulatedStorage double

Storage fee accrued for the day

Amount double

Grams of the product held

Valuation double

Value of the product held for the day

WeightedCost double

The weighted average cost paid by the customer across all of his/her purchases, multiplied by Amount

Time date-time

The time of the record