mirror of
https://github.com/Xahau/xahau.js.git
synced 2026-04-29 15:37:50 +00:00
26 lines
645 B
Plaintext
26 lines
645 B
Plaintext
## getBalanceSheet
|
|
|
|
`getBalanceSheet(address: string, options: object): Promise<object>`
|
|
|
|
Returns aggregate balances by currency plus a breakdown of assets and obligations for a specified account.
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema('input/get-balance-sheet.json') %>
|
|
|
|
### Return Value
|
|
|
|
This method returns a promise that resolves with an object with the following structure:
|
|
|
|
<%- renderSchema('output/get-balance-sheet.json') %>
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
|
|
return api.getBalanceSheet(address).then(balanceSheet =>
|
|
{/* ... */});
|
|
```
|
|
|
|
<%- renderFixture('responses/get-balance-sheet.json') %>
|