Skip to main content
GET
Get Liquidation Desk
Returns, in one read, what a lender of record needs to work the market’s liquidations: the loans that can be realized now, the loans close to it, the running and ended Dutch auctions, the records awaiting sale, how the records compare with the chain, and whether the lender of record’s liquidator is ready. Every figure is read from the chain. A part that could not be read says so; it never reads as an all-clear. Poll it with the cursor the previous read returned. While nothing on the market moved and nothing needs work, the answer is unchanged: true with no body, which costs one small batched read. pollSeconds says when to read again: 120 on a quiet desk, 30 while anything needs work.

Path Parameters

string
required
The market’s record ID, as id on List Markets, not its contract address. At most 100 characters.

Query Parameters

string
The cursor of the previous read. Ignored when longer than 64 characters.
number
default:"1.25"
Health factor below which a loan is listed in loans.watchLoans, from 1.01 to 3. Other values fall back to the default.
integer
default:"7"
Days ahead in which a termed loan whose grace period ends is listed in loans.watchLoans, from 0 to 90.

Response Fields

object

Error Codes