diff --git a/doc/README.md b/doc/README.md index 927ebe93aaf557fc974182bececee28505b0f3cf..dcbdde8306e0d6d906527cab9d53dc27a6cd7284 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2102,6 +2102,31 @@ hive.broadcast.fillTransferFromSavings(wif, from, to, amount, requestId, memo, f console.log(err, result); }); ``` +### Get Savings Withdraw From +Gets a list of savings withdraws from `account`. + +```js +hive.api.getSavingsWithdrawFrom(account, callback); +``` + +|Parameter|Datatype|Description| +|---------|--------|-----------| +|account|string|a hive username| +|callback|function|function(err, data) {/*code*/}| + + +Call Example: +```js +hive.api.getSavingsWithdrawFrom("username", function(err, data) { + console.log(err, data); +}); +``` + +Return Example: +```js + [ /* list of withdraws from savings */ ] +``` + ### Comment Payout ```js hive.broadcast.commentPayout(wif, author, permlink, payout, function(err, result) {