Wallets
Wallets are addresses containing, or previously having contained ARK. A wallet’s public key may be unknown to the network, in that case, it is referred to as a cold wallet
.
Endpoints
List All Wallets
A paginated API is provided to obtain all wallets, including empty ones.
Endpoint
Query Parameters
Name | Description | Required | Example |
---|---|---|---|
page |
The number of the page that will be returned.
|
No | 1 |
limit |
The number of resources per page.
|
No | 100 |
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 |
Retrieve a Wallet
Specific wallets can be obtained either by their publicKey
or address
.
Endpoint
Path Parameters
Name | Description | Required | Example |
---|---|---|---|
id |
The identifier of the wallet to be retrieved.
|
No |
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/search
with parameters senderId
and recipientId
.
Endpoint
Path Parameters
Name | Description | Required | Example |
---|---|---|---|
id |
The identifier of the wallet to be retrieved.
|
No |
Name | id |
Description |
The identifier of the wallet to be retrieved.
|
Required | No |
Example |
Query Parameters
Name | Description | Required | Example |
---|---|---|---|
page |
The number of the page that will be returned.
|
No | 1 |
limit |
The number of resources per page.
|
No | 100 |
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 |
List All Sent Transactions of a Wallet
Outgoing transactions can be obtained as well, Equivalent to transactions/search
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
Path Parameters
Name | Description | Required | Example |
---|---|---|---|
id |
The identifier of the wallet to be retrieved.
|
No |
Name | id |
Description |
The identifier of the wallet to be retrieved.
|
Required | No |
Example |
Query Parameters
Name | Description | Required | Example |
---|---|---|---|
page |
The number of the page that will be returned.
|
No | 1 |
limit |
The number of resources per page.
|
No | 100 |
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 |
List All Received Transactions of a Wallet
Incoming transactions can be obtained as well, Equivalent to transactions/search
with parameter recipientId
set.
Endpoint
Path Parameters
Name | Description | Required | Example |
---|---|---|---|
id |
The identifier of the wallet to be retrieved.
|
No |
Name | id |
Description |
The identifier of the wallet to be retrieved.
|
Required | No |
Example |
Query Parameters
Name | Description | Required | Example |
---|---|---|---|
page |
The number of the page that will be returned.
|
No | 1 |
limit |
The number of resources per page.
|
No | 100 |
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 |
Search All Wallets
Searching for specific wallets is possible as well. A direct database query usually is more performant when the query expression becomes complicated.
Endpoint
Path Parameters
Name | Description | Required | Example |
---|---|---|---|
address |
TODO
|
No | |
publicKey |
TODO
|
No | |
secondPublicKey |
TODO
|
No | |
vote |
TODO
|
No | |
username |
TODO
|
No | |
balance |
TODO
|
No | |
balance.from |
TODO
|
No | |
balance.to |
TODO
|
No | |
votebalance |
TODO
|
No | |
votebalance.from |
TODO
|
No | |
votebalance.to |
TODO
|
No |
Name | address |
Description |
TODO
|
Required | No |
Example |
Name | publicKey |
Description |
TODO
|
Required | No |
Example |
Name | secondPublicKey |
Description |
TODO
|
Required | No |
Example |
Name | vote |
Description |
TODO
|
Required | No |
Example |
Name | username |
Description |
TODO
|
Required | No |
Example |
Name | balance |
Description |
TODO
|
Required | No |
Example |
Name | balance.from |
Description |
TODO
|
Required | No |
Example |
Name | balance.to |
Description |
TODO
|
Required | No |
Example |
Name | votebalance |
Description |
TODO
|
Required | No |
Example |
Name | votebalance.from |
Description |
TODO
|
Required | No |
Example |
Name | votebalance.to |
Description |
TODO
|
Required | No |
Example |
Query Parameters
Name | Description | Required | Example |
---|---|---|---|
page |
The number of the page that will be returned.
|
No | 1 |
limit |
The number of resources per page.
|
No | 100 |
orderBy |
The number of resources per page.
|
No |
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 | orderBy |
Description |
The number of resources per page.
|
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.
Endpoint
Path Parameters
Name | Description | Required | Example |
---|---|---|---|
id |
The identifier of the wallet to be retrieved.
|
No |
Name | id |
Description |
The identifier of the wallet to be retrieved.
|
Required | No |
Example |
Query Parameters
Name | Description | Required | Example |
---|---|---|---|
page |
The number of the page that will be returned.
|
No | 1 |
limit |
The number of resources per page.
|
No | 100 |
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 |