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 | Description | Required | Example |
|---|---|---|---|
| page |
The number of the page that will be returned.
|
No | 1 |
| limit |
The number of resources per page.
|
No | 100 |
| offset |
The number of resources to be skipped.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
No | |
| address |
The address of the wallet to be retrieved.
|
No | |
| publicKey |
The public key of the wallet to be retrieved.
|
No | |
| balance |
The balance of the wallet to be retrieved.
|
No | |
| balance.from |
The minimum balance of the wallet to be retrieved.
|
No | |
| balance.to |
The maximum balance of the wallet to be retrieved.
|
No | |
| nonce |
The nonce of the wallet to be retrieved.
|
No | |
| nonce.from |
The minimum nonce of the wallet to be retrieved.
|
No | |
| nonce.to |
The maximum nonce of the wallet to be retrieved.
|
No | |
| attributes |
The attributes of the wallet to be retrieved.
|
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 | 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 | 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 with parameter address.
Endpoint
GET
Path Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| walletId |
The identifier of the wallet to be retrieved.
|
No |
| Name | walletId |
| 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 |
| offset |
The number of resources to be skipped.
|
No | |
| transform |
The structure of response to be retrieved.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
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 | 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 - totalOutgoingif 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 | 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 |
| offset |
The number of resources to be skipped.
|
No | |
| transform |
The structure of response to be retrieved.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
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 | 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 | 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 |
| offset |
The number of resources to be skipped.
|
No | |
| transform |
The structure of response to be retrieved.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
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 | 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 | 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 |
| offset |
The number of resources to be skipped.
|
No | |
| transform |
The structure of response to be retrieved.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
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 | 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 | Description | Required | Example |
|---|---|---|---|
| walletId |
The identifier of the wallet to be retrieved.
|
No |
| Name | walletId |
| 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 |
| offset |
The number of resources to be skipped.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
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 | 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 |
Last updated 4 years ago
Edit Page