API specification

message
required

Error message containing details of the error
Minimum length : 1

string

address
required

The Lisk Address is the human readable representation of the accounts owners' public key. It consists of multiple numbers followed by a big 'L' at the end.
Example : "12668885769632475474L"

string (address)

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 owner’s private key.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

secondPublicKey
optional

The second public key is derived from the second private key of an account, if the owner activated a second passphrase for her/his account.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

address
required

The Lisk Address is the human readable representation of the accounts owners' public key. It consists of 21 numbers followed by a big '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
optional

Delegate

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 owner’s private key.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

secondPublicKey
optional

The second public key is derived from the second private key of an account, if the owner activated a second passphrase for her/his account.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

data
required

List of accounts

< AccountExtended > array

links
required

object

meta
required

Meta

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 get 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 th edelagte who forged the block.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

height
required

Height of the network, when the block got forged. The height of the networks represents the number of blocks, that have been forged on the network since 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 the block contains. For each type of transaction exists a different maximum size 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 have 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

data
required

< Block > array

links
required

object

meta
required

Meta

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

data
required

< Dapp > array

links
required

object

meta
required

Meta

approval
optional

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

number

missedBlocks
optional

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

integer

producedBlocks
optional

Total number of blocks 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

rewards
optional

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

string

username
required

The delegate’s 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)

voteWeight
required

The voters weight of the delegate. Represents the total amount of Lisk (in Beddows), that the delegates' voters own. The voters weight decides which rank the delegate gets in relation to the other delegates and their voters weights.
Example : "1081560729258"

string

account
required

Account

approval
optional

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

number

missedBlocks
optional

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

integer

producedBlocks
optional

Total number of blocks 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

rewards
optional

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

string

username
required

The delegate’s 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)

voteWeight
required

The voters weight of the delegate. This represents the total amount of Lisk (in Beddows), that the delegates' voters own. The voters weight decides which rank the delegate gets in relation to the other delegates and their voters weights.
Example : "1081560729258"

string

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

The voters weight of the delegate. Represents the total amount of Lisk (in Beddows) that the delegates' voters own. The voters weight decides which rank the delegate gets in relation to the other delegates and their voters weights.
Example : 108877

integer

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.

< Vote > array

votesAvailable
required

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

integer

votesUsed
required

Number of votes that are already placed by the queried account.
Example : 2

integer

data
required

List of delegates

< DelegateWithAccount > array

links
required

object

meta
required

meta

limit
required

Default : 10
Minimum value : 1
Maximum value : 101

integer (int32)

offset
required

Offset

dappDeposit
required

Example : "10000000"

string

dappRegistration
required

Example : "2500000000"

string

dappWithdrawal
required

Example : "10000000"

string

delegate
required

Example : "2500000000"

string

multisignature
required

Example : "500000000"

string

secondSignature
required

Example : "500000000"

string

send
required

Example : "10000000"

string

vote
required

Example : "100000000"

string

address
required

The Lisk Address is the human readable representation of the accounts owners' public key. It consists of 21 numbers followed by a big '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)

data
required

List of forgers

< Forger > array

links
required

object

meta
required

meta

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 : 101

integer (int32)

offset
required

Offset

count
required

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

string

fees
required

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

string

forged
required

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

string

rewards
required

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

string

data
required

ForgingStats

links
required

object

meta
required

meta

fromTimestamp
required

Starting unix timestamp
Example : 0

integer

toTimestamp
required

Ending unix timestamp
Example : 1525861914

integer

forging
required

True if the delegate enabled forging.
Example : true

boolean

publicKey
required

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

string (publicKey)

data
required

< ForgingStatus > array

links
required

object

meta
required

object

data
required

data

links
required

object

meta
required

meta

message
required

Minimum length : 1

string

status
required

Acceptance status for transactions
Example : true

boolean

limit
required

Limit

offset
required

Offset

address
required

The Lisk Address is the human readable representation of the accounts owners' public key. It consists of 21 numbers followed by a big 'L' at the end.
Example : "12668885769632475474L"

string (address)

balance
required

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

string

lifetime
required

The maximum amount of hours, that a transaction will wait for the minimum amount of signatures to be reached. If not enough members of a multisignature group sign the transaction in the defined lifespan, the transaction will be invalid.
Example : 72

integer

members
required

< Account > array

min
required

Minimum amount of signatures a transaction needs to be signed successfully by this multisignature account.
Example : 3

integer

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

string (publicKey)

secondPublicKey
optional

The second public key is derived from the second private key of an account, if the owner activated a second passphrase for her/his account.
Example : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"

string (publicKey)

data
required

List of multisignature groups

< MultisignatureGroup > array

links
required

object

meta
required

object

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)

fees
required

Fees

milestone
required

The Reward, each forger will get 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 get 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)

data
required

NodeConstants

links
required

object

meta
required

object

chainMaxHeightFinalized
required

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

integer

currentTime
required

Current time of the node in miliseconds, (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 syncing with other peers.
Example : false

boolean

data
required

NodeStatus

links
required

object

meta
required

object

message
required

Error message containing details of the error
Minimum length : 1