API specification

Check the Lisk Core API^ to make 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.

Version information

Version : 1.0.32

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

URI scheme

BasePath : /api
Schemes : HTTP, HTTPS

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

Description

Search for matching accounts in the system.

Parameters

Type Name Description Schema Default

Query

address
optional

Address of an account.

string (address)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

publicKey
optional

Public key to query.

string (publicKey)

Query

sort
optional

Fields to sort results by.

enum (balance:asc, balance:desc)

"balance:asc"

Query

username
optional

Delegate username to query.

string (username)

Responses

HTTP Code Description Schema

200

List of accounts.

400

Malformed query or parameters

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Accounts

Requests blocks data

GET /blocks

Description

Search for a specified block in the system.

Parameters

Type Name Description Schema Default

Query

blockId
optional

Block ID to query.

string (id)

Query

fromTimestamp
optional

Starting unix timestamp.

integer

Query

generatorPublicKey
optional

Public key of the forger of the block.

string (publicKey)

Query

height
optional

Current height of the network.

integer (int32)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

sort
optional

Fields to sort results by.

enum (height:asc, height:desc, totalAmount:asc, totalAmount:desc, totalFee:asc, totalFee:desc, timestamp:asc, timestamp:desc)

"height:desc"

Query

toTimestamp
optional

Ending unix timestamp.

integer

Responses

HTTP Code Description Schema

200

Search results matching criteria.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Blocks

Requests dapps data

GET /dapps

Description

Search for a specified dapp in the system.

Parameters

Type Name Description Schema Default

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

name
optional

Name to query - Fuzzy search.

string

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

sort
optional

Fields to sort results by.

enum (name:asc, name:desc)

"name:asc"

Query

transactionId
optional

Dapp registration transaction ID.

string (id)

Responses

HTTP Code Description Schema

200

Search results matching criteria.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Dapps

Requests delegates data.

GET /delegates

Description

Search for a specified delegate in the system.

Parameters

Type Name Description Schema Default

Query

address
optional

Address of an account.

string (address)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

publicKey
optional

Public key to query.

string (publicKey)

Query

search
optional

Fuzzy delegate username to query.

string

Query

sort
optional

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)

"totalVotesReceived:desc"

Query

username
optional

Delegate username to query.

string (username)

Responses

HTTP Code Description Schema

200

Search results matching criteria.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Delegates

Requests next forgers data.

GET /delegates/forgers

Description

Returns a list of the next forgers in this delegate round.

Parameters

Type Name Description Schema Default

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Responses

HTTP Code Description Schema

200

Search results matching criteria.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Delegates

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
required

Lisk address of a delegate.

string (address)

Query

fromTimestamp
optional

Starting unix timestamp.

integer

Query

toTimestamp
optional

Ending unix timestamp.

integer

Responses

HTTP Code Description Schema

200

Results matching specified delegate address.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Delegates

Requests constants data

GET /node/constants

Description

Returns all current constants data on the system, e.g. Lisk epoch time and version.

Responses

HTTP Code Description Schema

200

Node constants response.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Node

Requests status data

GET /node/status

Description

Returns all current status data of the node, e.g. height.

Responses

HTTP Code Description Schema

200

Node status response.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Node

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
optional

Forging status to filter.

boolean

Query

publicKey
optional

Public key to query.

string (publicKey)

Responses

HTTP Code Description Schema

200

Search results matching criteria.

400

Malformed query or parameters.

403

Access denied.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Node

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
required

Password for decrypting passphrase of delegate with corresponding public key.

data

Name Description Schema

forging
required

Forging status of the delegate.
Example : true

boolean

password
required

Password for decrypting passphrase of delegate.
Minimum length : 5
Example : "happy tree friends"

string

publicKey
required

Public key of the delegate.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

Responses

HTTP Code Description Schema

200

Delegate forging toggled on or off.

400

Malformed query or parameters.

403

Access denied.

404

Provided public key not found.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Consumes

  • application/json

Produces

  • application/json

Tags

  • Node

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
optional

Transaction ID to query.

string (id)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

senderId
optional

Senders Lisk address.

string (address)

Query

senderPublicKey
optional

Senders public key.

string (publicKey)

Query

sort
optional

Fields to sort results by.`

enum (fee:asc, fee:desc, type:asc, type:desc)

"fee:desc"

Query

type
optional

Transaction type (0-*)

integer

Responses

HTTP Code Description Schema

200

Transactions list.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Node

Requests peers data

GET /peers

Description

Search for specified peers.

Parameters

Type Name Description Schema Default

Query

height
optional

Current height of the network.

integer (int32)

Query

httpPort
optional

Http port of the node or delegate.

integer (int32)

Query

ip
optional

IP of the node or delegate.

string (ip)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

os
optional

OS of the node.

string

Query

protocolVersion
optional

Protocol version of the node.

string (protocolVersion)

Query

sort
optional

Fields to sort results by.

enum (height:asc, height:desc, version:asc, version:desc)

"height:desc"

Query

state
optional

Current state of the network.

enum (connected, disconnected)

Query

version
optional

Lisk version of the node.

string (version)

Query

wsPort
optional

Web socket port for the node or delegate.

integer (int32)

Responses

HTTP Code Description Schema

200

List of peers.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Peers

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
required

Transaction object to submit to the network.

Responses

HTTP Code Description Schema

200

Transaction accepted by the node for processing.

400

Malformed query or parameters.

409

Some error related to processing of request.

429

Too many requests, exceeded rate limit.

Consumes

  • application/json

Produces

  • application/json

Tags

  • Transactions

Requests transactions data.

GET /transactions

Description

Search for a specified transaction in the system.

Parameters

Type Name Description Schema Default

Query

blockId
optional

Block ID to query.

string (id)

Query

data
optional

Fuzzy additional data field to query.

string (additionalData)

Query

height
optional

Current height of the network.

integer (int32)

Query

id
optional

Transaction ID to query.

string (id)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

maxAmount
optional

Maximum transaction amount in Beddows.

integer

Query

minAmount
optional

Minimum transaction amount in Beddows.

integer

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

recipientId
optional

Recipients Lisk address.

string (address)

Query

senderId
optional

Senders Lisk address.

string (address)

Query

senderIdOrRecipientId
optional

Lisk address.

string (address)

Query

senderPublicKey
optional

Senders public key.

string (publicKey)

Query

sort
optional

Fields to sort results by.

enum (amount:asc, amount:desc, fee:asc, fee:desc, type:asc, type:desc)

"amount:asc"

Query

type
optional

Transaction type (0-*)

integer

Responses

HTTP Code Description Schema

200

Transactions list.

400

Malformed query or parameters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Transactions

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
optional

Address of an account.

string (address)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

publicKey
optional

Public key to query.

string (publicKey)

Query

sort
optional

Fields to sort results by.

enum (publicKey:asc, publicKey:desc, balance:asc, balance:desc, username:asc, username:desc)

"publicKey:asc"

Query

username
optional

Delegate username to query.

string (username)

Responses

HTTP Code Description Schema

200

Voters list.

400

Malformed query or parameters.

404

Requested resource not found based on provided filters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Voters

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
optional

Address of an account.

string (address)

Query

limit
optional

Limit applied to results.

integer (int32)

10

Query

offset
optional

Offset value for results.

integer (int32)

0

Query

publicKey
optional

Public key to query.

string (publicKey)

Query

sort
optional

Fields to sort results by.

enum (username:asc, username:desc, balance:asc, balance:desc)

"username:asc"

Query

username
optional

Delegate username to query.

string (username)

Responses

HTTP Code Description Schema

200

Votes list.

400

Malformed query or parameters.

404

Requested resource not found based on provided filters.

429

Too many requests, exceeded rate limit.

500

Unexpected error.

Produces

  • application/json

Tags

  • Votes

Definitions

AccessDeniedError

Name Description Schema

message
required

Error message containing details of the error.
Minimum length : 1

string

Account

Name Description Schema

address
required

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.
Example : "12668885769632475474L"

string (address)

asset
optional

Any JSON stored in the account’s asset field.
Example : { "custom" : true, "field" : true }

object

balance
required

The current balance of the account in Beddows.
Example : "1081560729258"

string

delegate
required

isDelegate
optional

The value indicating if the account is a deleage or not.

boolean

keys
required

missedBlocks
optional

Total number of blocks that the delegate has missed.
Example : 427

integer

nonce
required

The current nonce associated to account for transaction processing.
Example : "154"

string

producedBlocks
optional

Total number of blocks that the delegate has forged.
Example : 20131

integer

productivity
optional

Productivity rate. Percentage of successfully forged blocks (not missed), by the delegate.
Example : 96.41

number

publicKey
required

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.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

rewards
optional

Total sum of block rewards that the delegate has forged.
Example : "510000000"

string

totalVotesReceived
optional

The total votes received by the delegate. Represents the total amount of Lisk (in Beddows), that the delegates voters voted for this delegate.
Example : "1081560729258"

string

unlocking
required

< Unlocking > array

username
optional

If the account is a delegate, it displays the username for it.
Example : "onedelegate"

string

votes
required

< Vote > array

AccountWithVotes

Name Description Schema

address
required

The Lisk address of the queried account.
Example : "12668885769632475474L"

string (address)

balance
required

The balance of the queried account.
Example : "1081560729258"

string

publicKey
optional

Public key of the queried account.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

username
required

Username of the account, if the queried account is a delegate.
Example : "isabella"

string (username)

votes
required

List of placed votes by the queried account.

votesAvailable
required

Number of votes that are available for the queried account. Derives from 101(max possible votes) - votesUsed(already used votes).
Example : 8

integer

AccountsResponse

Name Description Schema

data
required

List of accounts.

< Account > array

links
required

object

meta
required

Block

Name Description Schema

blockSignature
optional

Derived from a SHA-256 hash of the block header, that is signed by the private key of the delegate who forged the block.
Example : "a3733254aad600fa787d6223002278c3400be5e8ed4763ae27f9a15b80e20c22ac9259dc926f4f4cabdf0e4f8cec49308fa8296d71c288f56b9d1e11dfe81e07"

string (signature)

confirmations
optional

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.
Example : 200

integer

generatorAddress
optional

Lisk address of the delegate who forged the block.
Example : "12668885769632475474L"

string (address)

generatorPublicKey
required

Public key of the delegate who forged the block.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

height
required

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.
Minimum value : 1
Example : 123

integer

id
required

Unique identifier of the block. Derived from the block signature.
Length : 1 - 20
Example : "6258354802676165798"

string (id)

maxHeightPreviouslyForged
optional

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
Example : 123

integer

maxHeightPrevoted
optional

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
Example : 123

integer

numberOfTransactions
required

The number of transactions processed in the block.
Example : 15

integer

payloadHash
optional

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.
Example : "4e4d91be041e09a2e54bb7dd38f1f2a02ee7432ec9f169ba63cd1f193a733dd2"

string (hex)

payloadLength
optional

Bytesize of the payload hash.
Minimum value : 0
Example : 117

integer

previousBlockId
optional

The ID of the previous block of the chain.
Example : "15918760246746894806"

string (id)

reward
required

The Lisk reward for the delegate.
Example : "50000000"

string

timestamp
required

Unix timestamp.
Example : 28227090

integer

totalAmount
required

The total amount of Lisk transferred.
Example : "150000000"

string

totalFee
required

The total amount of fees associated with the block.
Example : "15000000"

string

totalForged
required

Total amount of LSK that has been forged in this block. Consists of fees and the reward.
Example : "65000000"

string

version
optional

Versioning for future upgrades of the Lisk protocol.
Minimum value : 0
Example : 0

integer

BlocksResponse

Blocks response.

Name Schema

data
required

< Block > array

links
required

object

meta
required

Dapp

Name Description Schema

category
optional

The category of the Dapp.
Example : 8.0

number

description
optional

Description of the Dapp.
Example : "Smart Gun Network"

string

icon
optional

Dapp icon. A link to the icon can be provided in the Register Dapp Transaction object.
Example : "http://www.blocksafefoundation.com/header.jpg"

string

link
optional

Example : "https://github.com/blocksafe/SDK-notice/archive/master.zip"

string

name
required

Name of the Dapp.
Example : "Blocksafe"

string

tags
optional

Tags of the Dapp.
Example : "Smartgun"

string

transactionId
required

Unique identifier of the Register Dapp Transaction. Derived from the transaction signature.
Length : 1 - 20
Example : "15359945250124697273"

string (id)

type
required

The type of the Dapp.
Example : 8.0

number

DappsResponse

Dapps endpoint response.

Name Schema

data
required

< Dapp > array

links
required

object

meta
required

Delegate

Name Description Schema

approval
optional

Percentage of the voters weight that the delegate owns in relation to the total supply of Lisk.
Example : 14.22

number

consecutiveMissedBlocks
optional

Number of blocks that the delegate missed consecutively.
Example : 10

integer

isBanned
optional

Whether the delegate is banned or not.
Example : false

boolean

lastForgedHeight
optional

Height of the block after the latest forging that was executed by the delegate.
Example : 100

integer

pomHeights
optional

Height of blocks where the delegate has been reported for misbehavior.

< integer > array

DelegateWithVoters

Name Description Schema

address
required

The Lisk address of a delegate.
Example : "12668885769632475474L"

string (address)

balance
required

Account balance. Amount of Lisk the delegate account owns.
Example : "1081560729258"

string

publicKey
optional

The public key of the delegate.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

username
required

The delegates username. A delegate chooses the username by registering a delegate on the Lisk network. It is unique and cannot be changed later.
Example : "isabella"

string (username)

voters
required

List of accounts that voted for the queried delegate.

< Voter > array

votes
required

Accounts which this delegate voted for.

< Vote > array

DelegatesResponse

Name Description Schema

data
required

List of delegates.

< Account > array

links
required

object

meta
required

meta

Name Description Schema

limit
required

Default : 10
Minimum value : 1
Maximum value : 103

integer (int32)

offset
required

Forger

Name Description Schema

address
required

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.
Example : "6251001604903637008L"

string (address)

nextSlot
required

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.
Example : 4368793.0

number

publicKey
required

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.
Example : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079"

string (publicKey)

username
required

The delegates username. A delegate chooses the username by registering a delegate on the Lisk network. It is unique and cannot be changed later.
Example : "isabella"

string (username)

ForgersResponse

Name Description Schema

data
required

List of forgers.

< Forger > array

links
required

object

meta
required

meta

Name Description Schema

currentSlot
required

Currently active slot.
Example : 10

integer

lastBlock
required

ID of the last processed block.
Example : 10

integer

lastBlockSlot
required

Slot of the last processed block.
Example : 10

integer

limit
required

Default : 10
Minimum value : 1
Maximum value : 103

integer (int32)

offset
required

ForgingStats

Name Description Schema

count
required

Amount of blocks that the delegate has forged during the timespan.
Example : "100"

string

fees
required

Amount of fees that the delegate earned during the timespan.
Example : "15000000"

string

forged
required

Amount of Lisk that has been transferred inside the forged blocks of a delegate, during the timespan.
Example : "65000000"

string

rewards
required

Amount of rewards that the delegate earned during the timespan.
Example : "50000000"

string

ForgingStatsResponse

Name Schema

data
required

links
required

object

meta
required

meta

Name Description Schema

fromTimestamp
required

Starting unix timestamp.
Example : 0

integer

toTimestamp
required

Ending unix timestamp.
Example : 1525861914

integer

ForgingStatus

Name Description Schema

forging
required

True if the delegate enabled forging.
Example : true

boolean

publicKey
required

Public key of the queried delegate.
Example : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079"

string (publicKey)

ForgingStatusResponse

Name Schema

data
required

< ForgingStatus > array

links
required

object

meta
required

object

GeneralStatusResponse

Name Schema

data
required

links
required

object

meta
required

data

Name Description Schema

message
required

Minimum length : 1

string

meta

Name Description Schema

status
required

Acceptance status for transactions.
Example : true

boolean

Limit

Limit applied to results.

Type : integer (int32)

Meta

Name Schema

limit
required

offset
required

MultisignatureAsset

Name Description Schema

mandatoryKeys
optional

Mandatory multi-signature account members

< string > array

numberOfSignatures
optional

Number of required signatures

number

optionalKeys
optional

Optional multi-signature account members

< string > array

NodeConstants

Name Description Schema

build
required

The build number. Consists of v + the date and time of the build of the node.
Example : "v09:54:35 12/04/2017"

string

commit
required

The last commit that was added to the codebase.
Length : 40
Example : "7199d4b67c3575d5f99d1c29436a02977eeb01a7"

string

epoch
required

Timestamp of first block on the network.
Example : "2016-05-24T17:00:00.000Z"

string (date-time)

milestone
required

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.
Example : "500000000"

string

networkId
required

Unique identifier for the network. The networkId that the node is connecting to, see LIP-0009 for more details.
Example : "ed14889723f24ecc54871d058d98ce91ff2f973192075c0155ba2b7b70ad2511"

string

protocolVersion
optional

The Lisk Core protocol version that the node is running on.
Example : "1.0"

string (protocolVersion)

reward
required

The reward a delegate will receive for forging a block. Depends on the slot height.
Example : "500000000"

string

supply
required

Total supply of LSK in the network.
Example : "10575384500000000"

string

version
required

The Lisk Core version that the node is running on.
Example : "v0.8.0"

string (version)

NodeConstantsResponse

Name Schema

data
required

links
required

object

meta
required

object

NodeStatus

Name Description Schema

chainMaxHeightFinalized
required

The largest height with precommits by at least 68 delegates. See https://github.com/LiskHQ/lips/blob/master/proposals/lip-0014.md
Example : 123

integer

currentTime
required

Current time of the node in milliseconds (Unix timestamp).
Example : 1533558858128

integer

height
required

Current block height of the node. Represents the current number of blocks in the chain on the node.
Minimum value : 1
Example : 123

integer

secondsSinceEpoch
required

Number of seconds that have elapsed since the Lisk epoch time (Lisk timestamp).
Example : 1533558858

integer

syncing
required

True if the node is syncing with other peers.
Example : false

boolean

unconfirmedTransactions
required

Number of unprocessed transactions in the pool.
Minimum value : 0
Example : 1

integer

NodeStatusResponse

Name Schema

data
required

links
required

object

meta
required

object

NotFoundError

Name Description Schema

message
required

Error message containing details of the error.
Minimum length : 1

string

Offset

Offset value for results.

Type : integer (int32)

ParamError

Collection of errors in a specific parameter.

Name Description Schema

code
required

Valid error code explaining error.
Example : "INVALID_REQUEST_PARAMETER"

string

errors
optional

Array of individual validation error for a particular param.

< ParamErrorMessage > array

in
optional

Where the param was specified, e.g. path, query, form-data.
Example : "query"

string

message
required

Detailed message explaining the error.
Example : "Invalid parameter (offset), value failed JSON schema validation."

string

name
required

Parameter name for which error was triggered.
Example : "offset"

string

ParamErrorMessage

Singular error detail for a parameter.

Name Description Schema

code
optional

Valid error code explaining error.
Example : "MINIMUM"

string

description
optional

Param description specified in schema.

string

message
required

Detailed message explaining error.
Example : "Value -1 is less than minimum 0"

string

path
optional

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
required

Array of individual parameter errors.

< ParamError > array

message
required

Message stating a validation error occurred.
Example : "Validation errors."

string

Peer

Name Description Schema

height
optional

Network height on the peer node. Represents the current number of blocks in the chain on the peer node.
Example : 123

integer

httpPort
optional

The port the peer node uses for HTTP requests, e.g. API calls.
Minimum value : 1
Maximum value : 65535
Example : 8000

integer (int32)

ip
optional

IPv4 address of the peer node.
Example : "127.0.0.1"

string (ip)

networkId
optional

The network identifier as per LIP-0009.
Example : "93d00fe5be70d90e7ae247936a2e7d83b50809c79b73fa14285f02c842348b3e"

string

os
optional

The operating system that the peer node runs on.
Example : "debian"

string

protocolVersion
optional

The protocol version of Lisk Core that the peer node runs on.
Example : "1.0"

string (protocolVersion)

state
required

The state of the peer.
Example : "connected"

enum (connected, disconnected)

version
optional

The version of Lisk Core that the peer node runs on.
Example : "v0.8.0"

string (version)

wsPort
required

The port the peer node uses for websocket connections, e.g. P2P broadcasts.
Minimum value : 1
Maximum value : 65535
Example : 8001

integer (int32)

PeersResponse

Peers response.

Name Schema

data
required

< Peer > array

links
required

object

meta
required

meta

Name Description Schema

count
required

Number of peers in the response.
Example : 100

integer

limit
required

offset
required

ProcessingError

Name Description Schema

code
optional

Error code containing details on status.

integer

errors
optional

Array containing TransactionError objects.

< TransactionError > array

message
required

Error message containing details of the error.
Minimum length : 1

string

RequestLimitError

Name Description Schema

error
optional

Example : "Request limit exceeded. Please try again later."

string

Transaction

Name Description Schema

asset
required

object

blockId
optional

The ID of the block which this transaction is included in.
Length : 1 - 20
Example : "6258354802676165798"

string (id)

confirmations
optional

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.
Minimum value : 0

integer

fee
required

Transaction fee associated with this transaction.
Example : "1000000"

string

height
optional

The height of the network, at the exact point in time when this transaction was included in the blockchain.
Minimum value : 1

integer

id
required

Unique identifier of the transaction. Derived from the transaction signature.
Length : 1 - 20
Example : "222675625422353767"

string (id)

nonce
required

Unique sequence of number per account.
Example : "1"

string

ready
optional

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.
Example : false

boolean

receivedAt
optional

The timestamp of the exact point in time where a node discovered a transaction for the first time.

string (date-time)

senderId
optional

Lisk Address of the Senders account.
Example : "12668885769632475474L"

string (address)

senderPublicKey
required

The public key of the Senders account.
Example : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079"

string (publicKey)

signatures
required

< string (signature) > array

type
required

Describes the Transaction type.
Minimum value : 0

integer

TransactionError

Name Description Schema

dataPath
required

Transaction field with error.

string

id
required

Transaction ID.
Minimum length : 1

string

message
required

Error message.

string

name
optional

Type of Error.

string

TransactionRequest

Name Description Schema

asset
required

Displays additional transaction data. For example, this can include the vote data or delegate username.

fee
required

Fee for the transaction.
Example : "1000000"

string

nonce
required

Unique sequence of number per account.
Example : "0"

string

senderPublicKey
required

The public key of the Senders account.
Example : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079"

string (publicKey)

signatures
required

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
required

Describes the Transaction type.
Minimum value : 0

integer

asset

Name Description Schema

amount
optional

Amount of Lisk to be transferred in this transaction.
Example : "150000000"

string

recipientId
optional

Lisk address of the recipients account.
Example : "12668885769632475474L"

string (address)

TransactionsResponse

Transactions response.

Name Schema

data
required

< Transaction > array

links
required

object

meta
required

meta

Name Description Schema

count
required

Number of transactions in the response.
Example : 100

integer

limit
required

offset
required

UnexpectedError

Name Description Schema

message
required

Error message containing details of the error.
Minimum length : 1

string

Unlocking

Name Description Schema

amount
required

Amount the account voted the delegate for in multiples of 10 Lisk.
Example : "1000000000000"

string

delegateAddress
required

Lisk address of the delegate the queried account unvoted.
Example : "12668885769632475474L"

string (address)

unvoteHeight
required

Height at which the unvote should be valid.
Example : 50000.0

number

Vote

Name Description Schema

amount
required

Amount the account voted the delegate for in multiples of 10 Lisk.
Example : "1000000000000"

string

delegateAddress
required

Lisk address of the delegate the queried account voted for.
Example : "12668885769632475474L"

string (address)

VoteWithDelegateProperties

Name Description Schema

amount
required

Amount the account voted the delegate for in multiples of 10 Lisk.
Example : "1000000000000"

string

delegate
required

Delegate properties of the delegate for this vote.

object

delegateAddress
required

Lisk address of the delegate the queried account voted for.
Example : "12668885769632475474L"

string (address)

Voter

Name Description Schema

address
required

The Lisk address of the account that voted for the queried delegate.
Example : "12668885769632475474L"

string (address)

publicKey
required

Public key of the account that voted for the queried delegate.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

votes
required

All votes the voter for the queried delegate voted for.

< Vote > array

VotersResponse

Voters endpoint response.

Name Schema

data
required

links
required

object

meta
required

VotesResponse

Votes endpoint response.

Name Schema

data
required

links
required

object

meta
required

meta

Name Description Schema

limit
required

Default : 10
Minimum value : 1
Maximum value : 10

integer (int32)

offset
required