API specification
- Access restrictions
- Requests
- Responses
- Date formats
- Pagination
- List of endpoints
- Paths
- Requests account data
- Requests blocks data
- Requests dapps data
- Requests delegates data.
- Requests next forgers data.
- Requests forging stats by delegate.
- Requests constants data
- Requests status data
- Requests forging status of a delegate.
- Toggles the forging status of a delegate.
- Requests unprocessed transactions data.
- Requests peers data
- Submits signed transaction for processing.
- Requests transactions data.
- Requests voters data for a delegate.
- Requests votes data for an account.
- Definitions
- AccessDeniedError
- Account
- AccountWithVotes
- AccountsResponse
- Block
- BlocksResponse
- Dapp
- DappsResponse
- Delegate
- DelegateWithVoters
- DelegatesResponse
- Forger
- ForgersResponse
- ForgingStats
- ForgingStatsResponse
- ForgingStatus
- ForgingStatusResponse
- GeneralStatusResponse
- Limit
- Meta
- MultisignatureAsset
- NodeConstants
- NodeConstantsResponse
- NodeStatus
- NodeStatusResponse
- NotFoundError
- Offset
- ParamError
- ParamErrorMessage
- ParamErrorResponse
- Peer
- PeersResponse
- ProcessingError
- RequestLimitError
- Transaction
- TransactionError
- TransactionRequest
- TransactionsResponse
- UnexpectedError
- Unlocking
- Vote
- VoteWithDelegateProperties
- Voter
- VotersResponse
- VotesResponse
Check the Lisk Core API to send live API requests to the Lisk public networks. |
Access restrictions
The API endpoints are by default restricted to a whitelist of IPs that can be found under modules.http_api.access.whiteList
in the config.
If it is required for your API to be accessible by the public, this can be achieved by changing modules.http_api.access.public
to true
.
This will allow anyone to make requests to your Lisk Core node.
However some endpoints will stay private, hence this means that only a list of whitelisted IPs can successfully make API calls to that particular endpoint;
this includes all forging related API calls.
By default, only the nodes' local IP is also included in the whitelist, nevertheless it is possible to change the setting in config
under modules.http_api.forging.access.whiteList
.
For more details, see the Lisk Core management docs or the descriptions at the respective endpoint below.
Requests
Chained filter parameters are logically connected with AND
.
HTTP
is the supported URL schema by default.
To enable HTTPS
, please adjust the modules.http_api.ssl
section in the config.
Responses
The general response format is JSON (application/json
).
The responses for each API request have a common basic structure as shown below:
{
"data": {}, //Contains the requested data.
"meta": {}, //Contains additional metadata, e.g. the values of `limit` and `offset`.
"links": {} //Will contain links to connected API calls from here, e.g. pagination links.
}
Date formats
Most of the timestamp parameters are in the Lisk timestamp format, which is similar to the Unix timestamp format.
The Lisk timestamp is the number of seconds that have elapsed since the Lisk epoch time (2016-05-24T17:00:00.000Z), not counting leap seconds.
The Lisk epoch time is returned in the ISO8601 format, combined with the date and time: YYYY-MM-DDThh:mm:ssZ
.
For details, see the descriptions and examples at the respective endpoint.
Pagination
It is possible to easily paginate through the results by providing limit
and offset
parameters to the requests.
limit
and offset
can be found in the meta
-object of the response of an API request.
If no limit and offset are provided they are set to 10 and 0 by default, which in turn will display the first 10 results.
List of endpoints
All possible API endpoints for Lisk Core are listed below. Click on an endpoint to show the descriptions, details, and examples.
Contact information
Contact Email : admin@lisk.io
License information
License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
Terms of service : null
Tags
-
Accounts : Account related API endpoints.
-
Blocks : Block related API endpoints.
-
Dapps : Dapps related API endpoints.
-
Delegates : Delegates related API endpoints.
-
Node : Node related API endpoints.
-
Peers : Peers related API endpoints.
-
Transactions : Transactions related API endpoints.
-
Voters : Votes related API endpoints.
-
Votes : Votes related API endpoints.
Paths
Requests account data
GET /accounts
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
address |
Address of an account. |
string (address) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
publicKey |
Public key to query. |
string (publicKey) |
|
Query |
sort |
Fields to sort results by. |
enum (balance:asc, balance:desc) |
|
Query |
username |
Delegate username to query. |
string (username) |
Requests blocks data
GET /blocks
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
blockId |
Block ID to query. |
string (id) |
|
Query |
fromTimestamp |
Starting unix timestamp. |
integer |
|
Query |
generatorPublicKey |
Public key of the forger of the block. |
string (publicKey) |
|
Query |
height |
Current height of the network. |
integer (int32) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
sort |
Fields to sort results by. |
enum (height:asc, height:desc, totalAmount:asc, totalAmount:desc, totalFee:asc, totalFee:desc, timestamp:asc, timestamp:desc) |
|
Query |
toTimestamp |
Ending unix timestamp. |
integer |
Requests dapps data
GET /dapps
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
name |
Name to query - Fuzzy search. |
string |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
sort |
Fields to sort results by. |
enum (name:asc, name:desc) |
|
Query |
transactionId |
Dapp registration transaction ID. |
string (id) |
Requests delegates data.
GET /delegates
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
address |
Address of an account. |
string (address) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
publicKey |
Public key to query. |
string (publicKey) |
|
Query |
search |
Fuzzy delegate username to query. |
string |
|
Query |
sort |
Fields to sort results by. |
enum (username:asc, username:desc, productivity:asc, productivity:desc, missedBlocks:asc, missedBlocks:desc, producedBlocks:asc, producedBlocks:desc, totalVotesReceived:asc, totalVotesReceived:desc) |
|
Query |
username |
Delegate username to query. |
string (username) |
Requests next forgers data.
GET /delegates/forgers
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Requests forging stats by delegate.
GET /delegates/{address}/forging_statistics
Description
By passing an existing delegate address and the desired unix timestamps, it is possible to acquire the forging statistics within the specified timespan. If no timestamps are provided, the timestamps from Lisk epoch to the current date will be used.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
address |
Lisk address of a delegate. |
string (address) |
Query |
fromTimestamp |
Starting unix timestamp. |
integer |
Query |
toTimestamp |
Ending unix timestamp. |
integer |
Requests constants data
GET /node/constants
Requests status data
GET /node/status
Requests forging status of a delegate.
GET /node/status/forging
Description
Attention! This is a *private endpoint only authorized to whitelisted IPs.
To edit the whitelist, please edit the modules.http_api.forging.access.whiteList
section in the config. *<br>
Responds with the forging status of a delegate on a node.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
forging |
Forging status to filter. |
boolean |
Query |
publicKey |
Public key to query. |
string (publicKey) |
Toggles the forging status of a delegate.
PUT /node/status/forging
Description
Attention! This is a *private endpoint only authorized to whitelisted IPs.
To edit the whitelist, please edit the modules.http_api.forging.access.whiteList
section in the config. *<br>
Upon passing the correct password and publicKey, forging will be enabled or disabled for the delegate of this particular node.
The password can be generated locally by encrypting your passphrase, either by using Lisk Commander or with Lisk Elements.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
data |
Password for decrypting passphrase of delegate with corresponding public key. |
data
Name | Description | Schema |
---|---|---|
forging |
Forging status of the delegate. |
boolean |
password |
Password for decrypting passphrase of delegate. |
string |
publicKey |
Public key of the delegate. |
string (publicKey) |
Requests unprocessed transactions data.
GET /node/transactions
Description
By specifying the state of the transactions, a list of unprocessed transactions matching this state can be seen. Search for specific transactions by providing the appropriate parameters. If a batch of transactions is posted, they will appear in the unprocessed list after a small delay depending on server load.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
id |
Transaction ID to query. |
string (id) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
senderId |
Senders Lisk address. |
string (address) |
|
Query |
senderPublicKey |
Senders public key. |
string (publicKey) |
|
Query |
sort |
Fields to sort results by.` |
enum (fee:asc, fee:desc, type:asc, type:desc) |
|
Query |
type |
Transaction type (0-*) |
integer |
Requests peers data
GET /peers
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
height |
Current height of the network. |
integer (int32) |
|
Query |
httpPort |
Http port of the node or delegate. |
integer (int32) |
|
Query |
ip |
IP of the node or delegate. |
string (ip) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
os |
OS of the node. |
string |
|
Query |
protocolVersion |
Protocol version of the node. |
string (protocolVersion) |
|
Query |
sort |
Fields to sort results by. |
enum (height:asc, height:desc, version:asc, version:desc) |
|
Query |
state |
Current state of the network. |
enum (connected, disconnected) |
|
Query |
version |
Lisk version of the node. |
string (version) |
|
Query |
wsPort |
Web socket port for the node or delegate. |
integer (int32) |
Submits signed transaction for processing.
POST /transactions
Description
Submits signed transaction object for processing by the transaction pool. Transaction objects can be generated locally either by using Lisk Commander or with Lisk Elements.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
transaction |
Transaction object to submit to the network. |
Requests transactions data.
GET /transactions
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
blockId |
Block ID to query. |
string (id) |
|
Query |
data |
Fuzzy additional data field to query. |
string (additionalData) |
|
Query |
height |
Current height of the network. |
integer (int32) |
|
Query |
id |
Transaction ID to query. |
string (id) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
maxAmount |
Maximum transaction amount in Beddows. |
integer |
|
Query |
minAmount |
Minimum transaction amount in Beddows. |
integer |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
recipientId |
Recipients Lisk address. |
string (address) |
|
Query |
senderId |
Senders Lisk address. |
string (address) |
|
Query |
senderIdOrRecipientId |
Lisk address. |
string (address) |
|
Query |
senderPublicKey |
Senders public key. |
string (publicKey) |
|
Query |
sort |
Fields to sort results by. |
enum (amount:asc, amount:desc, fee:asc, fee:desc, type:asc, type:desc) |
|
Query |
type |
Transaction type (0-*) |
integer |
Requests voters data for a delegate.
GET /voters
Description
Attention: At least *one of the filter parameters must be provided.* Returns all votes received by a delegate.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
address |
Address of an account. |
string (address) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
publicKey |
Public key to query. |
string (publicKey) |
|
Query |
sort |
Fields to sort results by. |
enum (publicKey:asc, publicKey:desc, balance:asc, balance:desc, username:asc, username:desc) |
|
Query |
username |
Delegate username to query. |
string (username) |
Requests votes data for an account.
GET /votes
Description
Attention: At least *one of the filter parameters must be provided.* Returns all votes placed by an account.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
address |
Address of an account. |
string (address) |
|
Query |
limit |
Limit applied to results. |
integer (int32) |
|
Query |
offset |
Offset value for results. |
integer (int32) |
|
Query |
publicKey |
Public key to query. |
string (publicKey) |
|
Query |
sort |
Fields to sort results by. |
enum (username:asc, username:desc, balance:asc, balance:desc) |
|
Query |
username |
Delegate username to query. |
string (username) |
Definitions
AccessDeniedError
Name | Description | Schema |
---|---|---|
message |
Error message containing details of the error. |
string |
Account
Name | Description | Schema |
---|---|---|
address |
The Lisk address is the human readable representation of the account owners public key.
It consists of 21 numbers followed by a capital 'L' at the end. |
string (address) |
asset |
Any JSON stored in the account’s asset field. |
object |
balance |
The current balance of the account in Beddows. |
string |
delegate |
||
isDelegate |
The value indicating if the account is a delegate or not. |
boolean |
keys |
||
missedBlocks |
Total number of blocks that the delegate has missed. |
integer |
nonce |
The current nonce associated to account for transaction processing. |
string |
producedBlocks |
Total number of blocks that the delegate has forged. |
integer |
productivity |
Productivity rate.
Percentage of successfully forged blocks (not missed), by the delegate. |
number |
publicKey |
The public key is derived from the private key of the owner of the account.
It can be used to validate that the private key belongs to the owner, but does not provide access to the owners private key. |
string (publicKey) |
rewards |
Total sum of block rewards that the delegate has forged. |
string |
totalVotesReceived |
The total votes received by the delegate.
Represents the total amount of Lisk (in Beddows), that the delegates voters voted for this delegate. |
string |
unlocking |
< Unlocking > array |
|
username |
If the account is a delegate, it displays the username for it. |
string |
votes |
< Vote > array |
AccountWithVotes
Name | Description | Schema |
---|---|---|
address |
The Lisk address of the queried account. |
string (address) |
balance |
The balance of the queried account. |
string |
publicKey |
Public key of the queried account. |
string (publicKey) |
username |
Username of the account, if the queried account is a delegate. |
string (username) |
votes |
List of placed votes by the queried account. |
< VoteWithDelegateProperties > array |
votesAvailable |
Number of votes that are available for the queried account.
Derives from 101(max possible votes) - votesUsed(already used votes). |
integer |
AccountsResponse
Name | Description | Schema |
---|---|---|
data |
List of accounts. |
< Account > array |
links |
object |
|
meta |
Block
Name | Description | Schema |
---|---|---|
blockSignature |
Derived from a SHA-256 hash of the block header,
that is signed by the private key of the delegate who forged the block. |
string (signature) |
confirmations |
Number of times that this block has been confirmed by the network.
By forging a new block on a chain, all former blocks in the chain are then confirmed by the forging delegate. |
integer |
generatorAddress |
Lisk address of the delegate who forged the block. |
string (address) |
generatorPublicKey |
Public key of the delegate who forged the block. |
string (publicKey) |
height |
Height of the network, when the block was forged.
The height of the network represents the number of blocks
that have been forged on the network since the genesis block. |
integer |
id |
Unique identifier of the block.
Derived from the block signature. |
string (id) |
maxHeightPreviouslyForged |
Largest height of any block previously forged by the generatorPublicKey as defined in the Lisk BFT Protocol.
See https://github.com/LiskHQ/lips/blob/master/proposals/lip-0014.md |
integer |
maxHeightPrevoted |
Largest height of an ancestor block with at least 68 prevotes as defined in the Lisk BFT Protocol.
See https://github.com/LiskHQ/lips/blob/master/proposals/lip-0014.md |
integer |
numberOfTransactions |
The number of transactions processed in the block. |
integer |
payloadHash |
Hash of the payload of the block.
The payload of a block is comprised of the transactions that the block contains.
For each type of transaction there is a different maximum size which exists for the payload. |
string (hex) |
payloadLength |
Bytesize of the payload hash. |
integer |
previousBlockId |
The ID of the previous block of the chain. |
string (id) |
reward |
The Lisk reward for the delegate. |
string |
timestamp |
Unix timestamp. |
integer |
totalAmount |
The total amount of Lisk transferred. |
string |
totalFee |
The total amount of fees associated with the block. |
string |
totalForged |
Total amount of LSK that has been forged in this block.
Consists of fees and the reward. |
string |
version |
Versioning for future upgrades of the Lisk protocol. |
integer |
BlocksResponse
Blocks response.
Name | Schema |
---|---|
data |
< Block > array |
links |
object |
meta |
Dapp
Name | Description | Schema |
---|---|---|
category |
The category of the Dapp. |
number |
description |
Description of the Dapp. |
string |
icon |
Dapp icon.
A link to the icon can be provided in the Register Dapp Transaction object. |
string |
link |
Example : |
string |
name |
Name of the Dapp. |
string |
tags |
Tags of the Dapp. |
string |
transactionId |
Unique identifier of the Register Dapp Transaction.
Derived from the transaction signature. |
string (id) |
type |
The type of the Dapp. |
number |
DappsResponse
Dapps endpoint response.
Name | Schema |
---|---|
data |
< Dapp > array |
links |
object |
meta |
Delegate
Name | Description | Schema |
---|---|---|
approval |
Percentage of the voters weight that the delegate owns in relation to the total supply of Lisk. |
number |
consecutiveMissedBlocks |
Number of blocks that the delegate missed consecutively. |
integer |
isBanned |
Whether the delegate is banned or not. |
boolean |
lastForgedHeight |
Height of the block after the latest forging that was executed by the delegate. |
integer |
pomHeights |
Height of blocks where the delegate has been reported for misbehavior. |
< integer > array |
DelegateWithVoters
Name | Description | Schema |
---|---|---|
address |
The Lisk address of a delegate. |
string (address) |
balance |
Account balance.
Amount of Lisk the delegate account owns. |
string |
publicKey |
The public key of the delegate. |
string (publicKey) |
username |
The delegates username.
A delegate chooses the username by registering a delegate on the Lisk network.
It is unique and cannot be changed later. |
string (username) |
voters |
List of accounts that voted for the queried delegate. |
< Voter > array |
votes |
Accounts which this delegate voted for. |
< Vote > array |
DelegatesResponse
Name | Description | Schema |
---|---|---|
data |
List of delegates. |
< Account > array |
links |
object |
|
meta |
meta
Name | Description | Schema |
---|---|---|
limit |
Default : |
integer (int32) |
offset |
Forger
Name | Description | Schema |
---|---|---|
address |
The Lisk address is the human readable representation of the accounts owners public key.
It consists of 21 numbers followed by a capital 'L' at the end. |
string (address) |
nextSlot |
Returns the slot number in which the forger will be able to forge the next block.
Each slot has a timespan of 10 seconds.
The first slot began directly after the Lisk epoch time. |
number |
publicKey |
The public key is derived from the private key of the owner of the account.
It can be used to validate that the private key belongs to the owner, but not provide access to the owners private key. |
string (publicKey) |
username |
The delegates username.
A delegate chooses the username by registering a delegate on the Lisk network.
It is unique and cannot be changed later. |
string (username) |
ForgersResponse
Name | Description | Schema |
---|---|---|
data |
List of forgers. |
< Forger > array |
links |
object |
|
meta |
meta
Name | Description | Schema |
---|---|---|
currentSlot |
Currently active slot. |
integer |
lastBlock |
ID of the last processed block. |
integer |
lastBlockSlot |
Slot of the last processed block. |
integer |
limit |
Default : |
integer (int32) |
offset |
ForgingStats
Name | Description | Schema |
---|---|---|
count |
Amount of blocks that the delegate has forged during the timespan. |
string |
fees |
Amount of fees that the delegate earned during the timespan. |
string |
forged |
Amount of Lisk that has been transferred inside the forged blocks of a delegate, during the timespan. |
string |
rewards |
Amount of rewards that the delegate earned during the timespan. |
string |
ForgingStatsResponse
Name | Schema |
---|---|
data |
|
links |
object |
meta |
meta
Name | Description | Schema |
---|---|---|
fromTimestamp |
Starting unix timestamp. |
integer |
toTimestamp |
Ending unix timestamp. |
integer |
ForgingStatus
Name | Description | Schema |
---|---|---|
forging |
True if the delegate enabled forging. |
boolean |
publicKey |
Public key of the queried delegate. |
string (publicKey) |
ForgingStatusResponse
Name | Schema |
---|---|
data |
< ForgingStatus > array |
links |
object |
meta |
object |
GeneralStatusResponse
Name | Schema |
---|---|
data |
|
links |
object |
meta |
data
Name | Description | Schema |
---|---|---|
message |
Minimum length : |
string |
meta
Name | Description | Schema |
---|---|---|
status |
Acceptance status for transactions. |
boolean |
MultisignatureAsset
Name | Description | Schema |
---|---|---|
mandatoryKeys |
Mandatory multi-signature account members. |
< string > array |
numberOfSignatures |
Number of required signatures. |
number |
optionalKeys |
Optional multi-signature account members. |
< string > array |
NodeConstants
Name | Description | Schema |
---|---|---|
build |
The build number.
Consists of |
string |
commit |
The last commit that was added to the codebase. |
string |
epoch |
Timestamp of first block on the network. |
string (date-time) |
milestone |
The reward that each forger will receive for forging a block at the current slot.
After a certain amount of slots, the reward will be reduced. |
string |
networkId |
Unique identifier for the network.
The networkId that the node is connecting to, see LIP-0009 for more details. |
string |
protocolVersion |
The Lisk Core protocol version that the node is running on. |
string (protocolVersion) |
reward |
The reward a delegate will receive for forging a block.
Depends on the slot height. |
string |
supply |
Total supply of LSK in the network. |
string |
version |
The Lisk Core version that the node is running on. |
string (version) |
NodeStatus
Name | Description | Schema |
---|---|---|
chainMaxHeightFinalized |
The largest height with precommits by at least 68 delegates.
See https://github.com/LiskHQ/lips/blob/master/proposals/lip-0014.md |
integer |
currentTime |
Current time of the node in milliseconds (Unix timestamp). |
integer |
height |
Current block height of the node.
Represents the current number of blocks in the chain on the node. |
integer |
secondsSinceEpoch |
Number of seconds that have elapsed since the Lisk epoch time (Lisk timestamp). |
integer |
syncing |
True if the node is syncing with other peers. |
boolean |
unconfirmedTransactions |
Number of unprocessed transactions in the pool. |
integer |
NotFoundError
Name | Description | Schema |
---|---|---|
message |
Error message containing details of the error. |
string |
ParamError
Collection of errors in a specific parameter.
Name | Description | Schema |
---|---|---|
code |
Valid error code explaining error. |
string |
errors |
Array of individual validation error for a particular param. |
< ParamErrorMessage > array |
in |
Where the param was specified, e.g. path, query, form-data. |
string |
message |
Detailed message explaining the error. |
string |
name |
Parameter name for which error was triggered. |
string |
ParamErrorMessage
Singular error detail for a parameter.
Name | Description | Schema |
---|---|---|
code |
Valid error code explaining error. |
string |
description |
Param description specified in schema. |
string |
message |
Detailed message explaining error. |
string |
path |
The array/object paths which identify the param associated with the error. |
< string > array |
ParamErrorResponse
Response generated in case of parameters validation.
Name | Description | Schema |
---|---|---|
errors |
Array of individual parameter errors. |
< ParamError > array |
message |
Message stating a validation error occurred. |
string |
Peer
Name | Description | Schema |
---|---|---|
height |
Network height on the peer node.
Represents the current number of blocks in the chain on the peer node. |
integer |
httpPort |
The port the peer node uses for HTTP requests, e.g. API calls. |
integer (int32) |
ip |
IPv4 address of the peer node. |
string (ip) |
networkId |
The network identifier as per LIP-0009. |
string |
os |
The operating system that the peer node runs on. |
string |
protocolVersion |
The protocol version of Lisk Core that the peer node runs on. |
string (protocolVersion) |
state |
The state of the peer. |
enum (connected, disconnected) |
version |
The version of Lisk Core that the peer node runs on. |
string (version) |
wsPort |
The port the peer node uses for websocket connections, e.g. P2P broadcasts. |
integer (int32) |
PeersResponse
Peers response.
Name | Schema |
---|---|
data |
< Peer > array |
links |
object |
meta |
meta
Name | Description | Schema |
---|---|---|
count |
Number of peers in the response. |
integer |
limit |
||
offset |
ProcessingError
Name | Description | Schema |
---|---|---|
code |
Error code containing details on status. |
integer |
errors |
Array containing TransactionError objects. |
< TransactionError > array |
message |
Error message containing details of the error. |
string |
RequestLimitError
Name | Description | Schema |
---|---|---|
error |
Example : |
string |
Transaction
Name | Description | Schema |
---|---|---|
asset |
object |
|
blockId |
The ID of the block which this transaction is included in. |
string (id) |
confirmations |
Number of times that this transaction has been confirmed by the network.
By forging a new block on a chain, all former blocks and their contained transactions in the chain get confirmed by the forging delegate. |
integer |
fee |
Transaction fee associated with this transaction. |
string |
height |
The height of the network, at the exact point in time when this transaction was included in the blockchain. |
integer |
id |
Unique identifier of the transaction.
Derived from the transaction signature. |
string (id) |
nonce |
Unique sequence of number per account. |
string |
ready |
Only present in transactions sent from a multisignature account, or transactions type 4 (multisignature registration).
False, if the minimum amount of signatures to sign this transaction has not been reached yet.
True, if the minimum amount of signatures has been reached. |
boolean |
receivedAt |
The timestamp of the exact point in time where a node discovered a transaction for the first time. |
string (date-time) |
senderId |
Lisk Address of the Senders account. |
string (address) |
senderPublicKey |
The public key of the Senders account. |
string (publicKey) |
signatures |
< string (signature) > array |
|
type |
Describes the Transaction type. |
integer |
TransactionError
Name | Description | Schema |
---|---|---|
dataPath |
Transaction field with error. |
string |
id |
Transaction ID. |
string |
message |
Error message. |
string |
name |
Type of Error. |
string |
TransactionRequest
Name | Description | Schema |
---|---|---|
asset |
Displays additional transaction data. For example, this can include the vote data or delegate username. |
|
fee |
Fee for the transaction. |
string |
nonce |
Unique sequence of number per account. |
string |
senderPublicKey |
The public key of the Senders account. |
string (publicKey) |
signatures |
Derived from a SHA-256 hash of the transaction object, that is signed by the private key of the account who created the transaction. |
< string (signature) > array |
type |
Describes the Transaction type. |
integer |
asset
Name | Description | Schema |
---|---|---|
amount |
Amount of Lisk to be transferred in this transaction. |
string |
recipientId |
Lisk address of the recipients account. |
string (address) |
TransactionsResponse
Transactions response.
Name | Schema |
---|---|
data |
< Transaction > array |
links |
object |
meta |
meta
Name | Description | Schema |
---|---|---|
count |
Number of transactions in the response. |
integer |
limit |
||
offset |
UnexpectedError
Name | Description | Schema |
---|---|---|
message |
Error message containing details of the error. |
string |
Unlocking
Name | Description | Schema |
---|---|---|
amount |
Amount the account voted the delegate for in multiples of 10 Lisk. |
string |
delegateAddress |
Lisk address of the delegate the queried account unvoted. |
string (address) |
unvoteHeight |
Height at which the unvote should be valid. |
number |
Vote
Name | Description | Schema |
---|---|---|
amount |
Amount the account voted the delegate for in multiples of 10 Lisk. |
string |
delegateAddress |
Lisk address of the delegate the queried account voted for. |
string (address) |
VoteWithDelegateProperties
Name | Description | Schema |
---|---|---|
amount |
Amount the account voted the delegate for in multiples of 10 Lisk. |
string |
delegate |
Delegate properties of the delegate for this vote. |
object |
delegateAddress |
Lisk address of the delegate the queried account voted for. |
string (address) |
Voter
Name | Description | Schema |
---|---|---|
address |
The Lisk address of the account that voted for the queried delegate. |
string (address) |
publicKey |
Public key of the account that voted for the queried delegate. |
string (publicKey) |
votes |
All votes the voter for the queried delegate voted for. |
< Vote > array |
VotersResponse
Voters endpoint response.
Name | Schema |
---|---|
data |
|
links |
object |
meta |