Corgi BankDocumentation
OpenAPI

Every approved lender's lendable value, advances outstanding and borrowing capacity

GET/ledger/collateral/capacity

Every 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 objectsRequired
14 child attributes
as_ofstring · dateRequired

A business date, YYYY-MM-DD

capacity_amountintegerRequired
gl_codestringRequired
horizonstring · dateRequired

A business date, YYYY-MM-DD

ineligible_pledgesintegerRequired
legal_namestringRequired
lendable_amountintegerRequired
lender_idintegerRequired
lender_kindstringRequired
outstanding_amountintegerRequired
pledged_value_amountintegerRequired
pledgesarray of objectsRequired
13 child attributes
assetobjectRequired

CollateralAsset is one bank-owned asset the register values.

12 child attributes
asset_classstringRequired
idintegerRequired
kindstringRequired

Securities_lot or loan

loanobject or nullOptional

LoanCollateralFacts are the lending service's facts about a loan as of a date.

maturity_datestring · date or nullOptional

A business date, YYYY-MM-DD

maturity_unresolvedbooleanRequired
referencestringRequired
updated_atstring · date-timeRequired
valuation_as_ofstring · dateRequired

A business date, YYYY-MM-DD

valuation_basisstringRequired
valuation_sha256stringOptional
value_amountintegerRequired
created_atstring · date-timeRequired
eligiblebooleanRequired
haircut_bpsintegerRequired
idintegerRequired
ineligibilityarray of stringsRequired
lendable_amountintegerRequired
lender_idintegerRequired
makerstringRequired
pledge_referencestringOptional
statestringRequired

Reserved, pledged, releasing or released

updated_atstring · date-timeRequired
value_amountintegerRequired
schedule_idintegerOptional
shortfall_amountintegerRequired
has_morebooleanRequired

Whether another page follows

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close