get-monitoring-purses.rst (1286B)
1 .. http:get:: /monitoring/purses 2 3 Get a list of purses 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:`Purses` objects. If no elements could be found, an empty array is returned 18 19 **Details:** 20 21 .. ts:def:: Purses 22 23 interface Purses { 24 25 // Unique row identifier 26 auditor_purses_rowid : Integer; 27 28 // Public key of the purse 29 purse_pub : EddsaPublicKey; 30 31 // Amount currently stored in the purse 32 balance : Amount; 33 34 // Amount the purse is intended for / the maximum amount that can be in the purse 35 target : Amount; 36 37 // When the purse expires 38 expiration_date : Timestamp; 39 40 } 41 42 .. note:: 43 44 This endpoint is still experimental. The endpoint will be further developed as needed.