Wallets

A Wallet resource is reachable using an associated Address or PublicKey.

Note that a PublicKey might not yet be associated with a Wallet if a particular Address has never sent funds.

Endpoints

List All Wallets

A paginated API is provided to obtain all wallets, including empty ones.

Endpoint

GET

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example
Name address
Description
The address of the wallet to be retrieved.
Required No
Example
Name publicKey
Description
The public key of the wallet to be retrieved.
Required No
Example
Name balance
Description
The balance of the wallet to be retrieved.
Required No
Example
Name balance.from
Description
The minimum balance of the wallet to be retrieved.
Required No
Example
Name balance.to
Description
The maximum balance of the wallet to be retrieved.
Required No
Example
Name nonce
Description
The nonce of the wallet to be retrieved.
Required No
Example
Name nonce.from
Description
The minimum nonce of the wallet to be retrieved.
Required No
Example
Name nonce.to
Description
The maximum nonce of the wallet to be retrieved.
Required No
Example
Name attributes
Description
The attributes of the wallet to be retrieved.
Required No
Example

Retrieve a Wallet

Specific wallets can be obtained either by their publicKey or address.

Endpoint

GET

Path Parameters

Name id
Description
The identifier of the wallet to be retrieved.
Required No
Example

List All Transactions of a Wallet

All transactions belonging to a wallet can be obtained using this API. Equivalent to /transactions with parameter address.

Endpoint

GET

Path Parameters

Name walletId
Description
The identifier of the wallet to be retrieved.
Required No
Example

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name transform
Description
The structure of response to be retrieved.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example

List All Sent Transactions of a Wallet

Outgoing transactions can be obtained as well, Equivalent to /transactions with parameter senderId set.

Note that the balance of a wallet does not equal totalIncoming - totalOutgoing if the wallet is a Delegate. You must then also add the total reward from transaction fees and forged blocks to their balance.

Endpoint

GET

Path Parameters

Name id
Description
The identifier of the wallet to be retrieved.
Required No
Example

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name transform
Description
The structure of response to be retrieved.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example

List All Received Transactions of a Wallet

Incoming transactions can be obtained as well, Equivalent to /transactions with parameter recipientId set.

Endpoint

GET

Path Parameters

Name id
Description
The identifier of the wallet to be retrieved.
Required No
Example

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name transform
Description
The structure of response to be retrieved.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example

List All Votes of a Wallet

Returns all votes made by the wallet. Often users create a new wallet instead of recasting their vote, as the former was historically cheaper. Equivalent to /transactions with parameter senderId and vote type set.

Endpoint

GET

Path Parameters

Name id
Description
The identifier of the wallet to be retrieved.
Required No
Example

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name transform
Description
The structure of response to be retrieved.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example

List All Lock Transactions of a Wallet

All lock transactions belonging to a wallet can be obtained using this API. Equivalent to /locks with parameter senderPublicKey.

Endpoint

GET

Path Parameters

Name walletId
Description
The identifier of the wallet to be retrieved.
Required No
Example

Query Parameters

Name page
Description
The number of the page that will be returned.
Required No
Example 1
Name limit
Description
The number of resources per page.
Required No
Example 100
Name offset
Description
The number of resources to be skipped.
Required No
Example
Name orderBy
Description
The column by which the resources will be sorted.
Required No
Example
2021 © ARK.io | All rights reserved An ARK.io Product