get-monitoring-balances.rst (720B)
1 .. http:get:: /monitoring/balances 2 3 Get a list of balances 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 balance_key: a string identifying a balance. If specified, only returns the balance with this exact key. The default value is NULL. 10 11 **Response:** 12 13 :http:statuscode:`200 OK`: 14 The auditor responds with a top level array of :ts:type:`Balances` objects. If no elements could be found, an empty array is returned 15 16 **Details:** 17 18 .. ts:def:: Balances 19 20 interface Balances { 21 22 // String identifying a balance 23 balance_key : string; 24 25 // Amount of the balance 26 balance_value : Amount; 27 28 }