Skip to content

Commit a63fac3

Browse files
committed
Merge pull request #438 from braydonf/docs/clarify-summary
docs: clarify getAddressSummary results
2 parents 3a0ba64 + 32a6b25 commit a63fac3

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/services/bitcoind.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,13 +270,20 @@ The `summary` will have the format (values are in satoshis):
270270
totalSpent: 0,
271271
balance: 1000000000,
272272
unconfirmedBalance: 1000000000,
273-
appearances: 1, // number of transactions
273+
appearances: 1,
274274
unconfirmedAppearances: 0,
275275
txids: [
276276
'3f7d13efe12e82f873f4d41f7e63bb64708fc4c942eb8c6822fa5bd7606adb00'
277277
]
278278
}
279279
```
280+
**Notes**:
281+
- `totalReceived` does not exclude change *(the amount of satoshis originating from the same address)*
282+
- `unconfirmedBalance` is the delta that the unconfirmed transactions have on the total balance *(can be both positive and negative)*
283+
- `unconfirmedAppearances` is the total number of unconfirmed transactions
284+
- `appearances` is the total confirmed transactions
285+
- `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.
286+
280287
281288
## Events
282289
The Bitcoin Service exposes two events via the Bus, and there are a few events that can be directly registered:

0 commit comments

Comments
 (0)