get-monitoring-historic-reserve-summary.rst (1253B)
1 .. http:get:: /monitoring/historic-reserve-summary 2 3 Get a list of historic reserve summary 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:`HistoricReserveSummary` objects. If no elements could be found, an empty array is returned 18 19 **Details:** 20 21 .. ts:def:: HistoricReserveSummary 22 23 interface HistoricReserveSummary { 24 25 // Unique row identifier 26 row_id : Integer; 27 28 // From when the summary starts 29 start_date : Timestamp; 30 31 // When the summary ends 32 end_date : Timestamp; 33 34 // Profits the exchange charged for the reserve 35 reserve_profits : Amount; 36 37 } 38 39 .. note:: 40 41 This endpoint is still experimental. The endpoint will be further developed as needed.