get-monitoring-denomination-pending.rst (1965B)
1 .. http:get:: /monitoring/denomination-pending 2 3 Get a list of denomination pending 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 With the default settings, the endpoint returns at most the 20 latest elements. 13 14 **Response:** 15 16 :http:statuscode:`200 OK`: 17 The auditor responds with a top level array of :ts:type:`DenominationPending` objects. If no elements could be found, an empty array is returned 18 19 **Details:** 20 21 .. ts:def:: DenominationPending 22 23 interface DenominationPending { 24 25 // Unique row identifier 26 row_id : Integer; 27 28 // Hash of the denomination public key 29 denom_pub_hash : HashCode; 30 31 // Total value of coins remaining in circulation (excluding 32 // the value of coins that were recouped, those are always 33 // just under recoup_loss). 34 denom_balance : Amount; 35 36 // Total value of coins redeemed that exceeds the amount we 37 // put into circulation. Basically, this value grows if we 38 // wanted to reduce denom_balance (because a coin was deposited) 39 // but we could not because the denom_balance was already zero. 40 denom_loss : Amount; 41 42 // Total number of coins of this denomination that were 43 // put into circulation. 44 num_issued : Integer; 45 46 // Total value of the coins put into circulation. 47 denom_risk : Amount; 48 49 // Losses the exchange had from this denomination due to coins 50 // that were recouped (after the denomination was revoked). 51 recoup_loss : Amount; 52 53 } 54 55 .. note:: 56 57 This endpoint is still experimental. The endpoint will be further developed as needed.