Retrieve account holdings

View current instruments by ledger, using the ledger identifier.

SecurityJWT
Request
path Parameters
ledgerIdentifier
required
string

Ledger identifier, can be found using /api/ledger endpoint

Example: 4b7375e9-79b0-4b8b-a89e-a21607f0239f
query Parameters
asset
boolean

If true, requests asset holdings, otherwise requests liability holdings.

Example: asset=true
onBehalfOfSrcAcctId
string

If permitted, allows the caller to request holdings for another account holder, identifying that account holder by their system-assigned srcAcctId.

Example: onBehalfOfSrcAcctId=4b7375e9-79b0-4b8b-a89e-a21607f0239f
transferTypeCode
string

If specified, only holdings that qualify for the specified transfer type will be returned

Example: transferTypeCode=RET
$skip
integer <int32>

Number of records to skip

$top
integer <int32>

Maximum number of records to return

$filter
string

OData-like filter expression

$apply
string

OData-like apply expression with groupby and aggregate only

$orderby
string

Comma-separated list of columns for sorting

$count
boolean

Whether to include the count of records with the result

Responses
200

Holdings retrieved

404

Not Found

get/api/ledger/{ledgerIdentifier}/holding
Response samples
application/json
{
  • "@count": 0,
  • "value": [
    ]
}