Every approved lender's lendable value, advances outstanding and borrowing capacity
GET
/ledger/collateral/capacityEvery approved lender's position; reporting reads the Reserve Bank's lendable value from it for the Fed position. A read needs ledger:read or ledger:post.
Returns
200 OK
dataarray of objectsRequired14 child attributes
as_ofstring · dateRequiredA business date, YYYY-MM-DD
capacity_amountintegerRequiredgl_codestringRequiredhorizonstring · dateRequiredA business date, YYYY-MM-DD
ineligible_pledgesintegerRequiredlegal_namestringRequiredlendable_amountintegerRequiredlender_idintegerRequiredlender_kindstringRequiredoutstanding_amountintegerRequiredpledged_value_amountintegerRequiredpledgesarray of objectsRequired13 child attributes
assetobjectRequiredCollateralAsset is one bank-owned asset the register values.
12 child attributes
asset_classstringRequiredidintegerRequiredkindstringRequiredSecurities_lot or loan
loanobject or nullOptionalLoanCollateralFacts are the lending service's facts about a loan as of a date.
maturity_datestring · date or nullOptionalA business date, YYYY-MM-DD
maturity_unresolvedbooleanRequiredreferencestringRequiredupdated_atstring · date-timeRequiredvaluation_as_ofstring · dateRequiredA business date, YYYY-MM-DD
valuation_basisstringRequiredvaluation_sha256stringOptionalvalue_amountintegerRequiredcreated_atstring · date-timeRequiredeligiblebooleanRequiredhaircut_bpsintegerRequiredidintegerRequiredineligibilityarray of stringsRequiredlendable_amountintegerRequiredlender_idintegerRequiredmakerstringRequiredpledge_referencestringOptionalstatestringRequiredReserved, pledged, releasing or released
updated_atstring · date-timeRequiredvalue_amountintegerRequiredschedule_idintegerOptionalshortfall_amountintegerRequiredhas_morebooleanRequiredWhether another page follows
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503