Account Ledger

GET

/v1/api/portfolio/:accountId/ledger

GET

/v1/api/portfolio/:accountId/ledger

curl https://localhost:5000/v1/api/portfolio/DU123456/ledger \
     -H "Authorization: Bearer <token>"

{
  "AUD": {
    "acctcode": "DU5240685",
    "cashbalance": 223911.11,
    "cashbalancefxsegment": 0,
    "commoditymarketvalue": 0,
    "corporatebondsmarketvalue": 0,
    "currency": "AUD",
    "dividends": 0,
    "exchangerate": 0.650378,
    "funds": 0,
    "futuremarketvalue": 0,
    "futureoptionmarketvalue": 0,
    "futuresonlypnl": 0,
    "interest": 83.04,
    "issueroptionsmarketvalue": 0,
    "key": "LedgerList",
    "moneyfunds": 0,
    "netliquidationvalue": 223994.16,
    "realizedpnl": 0,
    "secondkey": "AUD",
    "sessionid": 1,
    "settledcash": 223911.11,
    "severity": 0,
    "stockmarketvalue": 0,
    "stockoptionmarketvalue": 0,
    "tbillsmarketvalue": 0,
    "tbondsmarketvalue": 0,
    "timestamp": 1754948718,
    "unrealizedpnl": 0,
    "warrantsmarketvalue": 0,
    "cryptocurrencyvalue": 0
  },
  "BASE": {
    "acctcode": "DU5240685",
    "cashbalance": 218093824,
    "cashbalancefxsegment": 0,
    "commoditymarketvalue": 0,
    "corporatebondsmarketvalue": 2094.11,
    "currency": "BASE",
    "dividends": 0,
    "exchangerate": 1,
    "funds": 0,
    "futuremarketvalue": 2750.1,
    "futureoptionmarketvalue": 0,
    "futuresonlypnl": 2750.1,
    "interest": 150856.48,
    "issueroptionsmarketvalue": 0,
    "key": "LedgerList",
    "moneyfunds": 0,
    "netliquidationvalue": 219449280,
    "realizedpnl": 0,
    "secondkey": "BASE",
    "sessionid": 1,
    "settledcash": 218093824,
    "severity": 0,
    "stockmarketvalue": 1202347.1,
    "stockoptionmarketvalue": 906.95,
    "tbillsmarketvalue": 0,
    "tbondsmarketvalue": 0,
    "timestamp": 1754948718,
    "unrealizedpnl": 154673.2,
    "warrantsmarketvalue": 0,
    "cryptocurrencyvalue": 0
  },
  "USD": {
    "acctcode": "DU5240685",
    "cashbalance": 213375440,
    "cashbalancefxsegment": 0,
    "commoditymarketvalue": 0,
    "corporatebondsmarketvalue": 2094.11,
    "currency": "USD",
    "dividends": 0,
    "exchangerate": 1,
    "funds": 0,
    "futuremarketvalue": 2750.1,
    "futureoptionmarketvalue": 0,
    "futuresonlypnl": 2750.1,
    "interest": 150009.97,
    "issueroptionsmarketvalue": 0,
    "key": "LedgerList",
    "moneyfunds": 0,
    "netliquidationvalue": 214730048,
    "realizedpnl": 0,
    "secondkey": "USD",
    "sessionid": 1,
    "settledcash": 213375440,
    "severity": 0,
    "stockmarketvalue": 1202347.1,
    "stockoptionmarketvalue": 906.95,
    "tbillsmarketvalue": 0,
    "tbondsmarketvalue": 0,
    "timestamp": 1754948718,
    "unrealizedpnl": 154673.2,
    "warrantsmarketvalue": 0,
    "cryptocurrencyvalue": 0,
    "endofbundle": 1
  }
}

Get the given account's ledger data detailing its balances by currency.

Authentication

AuthorizationBearer

SSO bearer token.

Path parameters

accountIdstringRequired

Query parameters

modelstringOptional

Response

ledger

acctcodestringOptional

The Account ID of the requested account.

cashbalancedoubleOptional

The given account's cash balance in this currency.

cashbalancefxsegmentdoubleOptional

The given account's cash balance in its dedicated forex segment in this currency, if applicable.

commoditymarketvaluedoubleOptional

Market value of the given account's commodity positions in this currency.

corporatebondsmarketvaluedoubleOptional

Market value of the given account's corporate bond positions in this currency.

currencystringOptional

Three-letter name of the currency reflected by this object, or ‘BASE’ for the account’s base currency.

dividendsdoubleOptional

The given account’s receivable (not yet disbursed) dividend balance in this currency.

exchangeratelongOptional

Exchange rate of this currency relative to the account's base currency.

fundsdoubleOptional

The value of the given account's mutual fund holdings in this currency.

futuremarketvaluedoubleOptional

Market value of the given account's futures positions in this currency.

futureoptionmarketvaluedoubleOptional

Market value of the given account's futures options positions in this currency.

futuresonlypnldoubleOptional

PnL of the given account's futures positions in this currency.

interestdoubleOptional

The given account's receivable interest balance in this currency.

issueroptionsmarketvaluedoubleOptional

Market value of the given account's issuer options positions in this currency.

keyenumOptional

Identifies the nature of data. Always takes values 'LedgerList'.

Allowed values:

moneyfundsdoubleOptional

The value of the given account's money market fund holdings in this currency.

netliquidationvaluedoubleOptional

The given account's net liquidation value of positions in this currency.

realizedpnldoubleOptional

The given account's realized PnL for positions in this currency.

secondkeystringOptional

Additional identifier of the currency reflected in this object. Always matches 'currency' field.

sessionidlongOptional

settledcashdoubleOptional

The given account's settled cash balance in this currency.

severitylongOptional

stockmarketvaluedoubleOptional

Market value of the given account's stock positions in this currency.

stockoptionmarketvaluedoubleOptional

Market value of the given account's stock options positions in this currency.

tbillsmarketvaluedoubleOptional

Market value of the given account's treasury bill positions in this currency.

tbondsmarketvaluedoubleOptional

Market value of the given account's treasury bond positions in this currency.

timestamplongOptional

Timestamp of retrievable of this account ledger data.

unrealizedpnldoubleOptional

The given account's unrealied PnL for positions in this currency.

warrantsmarketvaluedoubleOptional

Market value of the given account's warrant positions in this currency.

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error