Every pledge live at the close of a business date that has ended (as_of), replayed from the retained pledge events, with pledges whose undated history cannot be placed
GET
/ledger/collateral/pledge-positionsReplays every retained pledge event to the close of as_of, a business date that has ended (409 conflict otherwise): each pledge reserved, pledged or releasing at that close, with the business date its state began. A pledge released on or before the date is absent. Events retained before ledger migration 0059 carry no business date; a pledge whose undated events could fall on either side of the date is listed in undated_pledges instead of placed. A read needs ledger:read or ledger:post.
Query parameters
as_ofstringOptionalReturns
200 OK
as_ofstring · dateRequiredA business date, YYYY-MM-DD
business_datestring · dateRequiredA business date, YYYY-MM-DD
positionsarray of objectsRequired10 child attributes
asset_classstringRequiredasset_kindstringRequiredevent_sequenceintegerRequiredlender_idintegerRequiredlender_kindstringRequiredpledge_idintegerRequiredpledge_referencestringOptionalreferencestringRequiredsincestring · dateRequiredA business date, YYYY-MM-DD
statestringRequiredReserved, pledged or releasing
undated_pledgesarray of integersRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503