docs: clarify getAddressSummary results

QuantumExplorer · Jun 1, 2016 · 32a6b25 · 32a6b25
1 parent c897f62
commit 32a6b25
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/docs/services/bitcoind.md b/docs/services/bitcoind.md
@@ -270,13 +270,20 @@ The `summary` will have the format (values are in satoshis):
   totalSpent: 0,
   balance: 1000000000,
   unconfirmedBalance: 1000000000,
-  appearances: 1, // number of transactions
+  appearances: 1,
   unconfirmedAppearances: 0,
   txids: [
     '3f7d13efe12e82f873f4d41f7e63bb64708fc4c942eb8c6822fa5bd7606adb00'
   ]
 }
 ```
+**Notes**:
+- `totalReceived` does not exclude change *(the amount of satoshis originating from the same address)*
+- `unconfirmedBalance` is the delta that the unconfirmed transactions have on the total balance *(can be both positive and negative)*
+- `unconfirmedAppearances` is the total number of unconfirmed transactions
+- `appearances` is the total confirmed transactions
+- `txids` Are sorted in block order with the most recent at the beginning. A maximum of 1000 *(default)* will be returned, the `from` and `to` options can be used to get further values.
+
 
 ## Events
 The Bitcoin Service exposes two events via the Bus, and there are a few events that can be directly registered: