get-monitoring-reserves.rst (2103B)
1 .. http:get:: /monitoring/reserves 2 3 Get a list of reserves stored by the auditor. 4 5 The following query parameters are optional, and can be used to customise the response: 6 7 **Request:** 8 9 :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20. 10 :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX. 11 12 13 With the default settings, the endpoint returns at most the 20 latest elements. 14 15 **Response:** 16 17 :http:statuscode:`200 OK`: 18 The auditor responds with a top level array of :ts:type:`Reserves` objects. If no elements could be found, an empty array is returned 19 20 21 **Details:** 22 23 .. ts:def:: Reserves 24 25 interface Reserves { 26 27 // Unique row identifier 28 auditor_reserves_rowid : Integer; 29 30 // Public key of the reserve 31 reserve_pub : EddsaPublicKey; 32 33 // Amount in the balance 34 reserve_balance : Amount; 35 36 // Reserve losses are incurred if (a) a reserve is 37 // incorrectly credited from a recoup for a non-revoked 38 // coin, or (b) if the exchange allowed more digital cash 39 // to be withdrawn from a reserve than the balance of the 40 // reserve should have permitted. FIXME: We may want to 41 // distinguish these two cases in the future. 42 reserve_loss : Amount; 43 44 // Amount earned by charging withdraw fees 45 withdraw_fee_balance : Amount; 46 47 // Amount earned by charging a closing fee on the reserve 48 close_fee_balance : Amount; 49 50 // Total purse fees earned from this reserve 51 purse_fee_balance : Amount; 52 53 // Total reserve open fees earned from the reserve 54 open_fee_balance : Amount; 55 56 // Total reserve history fees earned from this reserve 57 history_fee_balance : Amount; 58 59 // When the purse expires 60 expiration_date : Timestamp; 61 62 // Who created the account 63 origin_account : string; 64 65 } 66 67 .. note:: 68 69 This endpoint is still experimental. The endpoint will be further developed as needed.