Accounts

This is a resource for interacting with the accounts endpoint provided by the Lisk public API. Each of the following methods can be accessed via the accounts property of an APIClient instance.

get

Searches for matching accounts in the system.

Syntax

get([options])

Parameters

options: See the options available by accessing the following link: Core API documentation^.

Return value

Promise: Resolves to an API response object.

Examples

client.accounts.get({ username: 'oliver' })
    .then(res => {
        console.log(res.data);
    })

getMultisignatureGroups

This searches for the specified account in the system, and responds with a list of the multisignature groups that include the afore-mentioned specified account.

Syntax

getMultisignatureGroups(address, [options])

Parameters

address: A Lisk address string.

options: Please see the options in the following link: Core API documentation^.

Return value

Promise: Resolves to an API response object.

Examples

client.accounts.getMultisignatureGroups('15434119221255134066L')
    .then(res => {
        console.log(res.data);
    })

getMultisignatureMemberships

This searches for the specified multisignature group and responds with a list of all members of this particular multisignature group.

Syntax

getMultisignatureMemberships(address, [options])

Parameters

address: A Lisk address string.

options: Please see the options in the following link: Core API documentation^.

Return value

Promise: Resolves to an API response object.

Examples

client.accounts.getMultisignatureMemberships('15434119221255134066L')
    .then(res => {
        console.log(res.data);
    })