HTTP API plugin

address
required

The binary address in hex format as defined in LIP-0018.
Example : "9d0149b0962d44bfc08a9f64d5afceb6281d7fb5"

string

dpos
required

dpos

keys
required

keys

sequence
required

sequence

token
required

token

delegate
required

delegate

sentVotes
required

< sentVotes > array

unlocking
required

< unlocking > array

consecutiveMissedBlocks
required

number

isBanned
required

boolean

lastForgedHeight
required

number

pomHeights
required

< number > array

totalVotesReceived
required

string

username
required

string

amount
required

string

delegateAddress
required

string

amount
required

string

delegateAddress
required

string

unvoteHeight
required

number

mandatoryKeys
required

Hex encoded value of mandatory multi-signature account members public keys

< string > array

numberOfSignatures
required

Number of required signatures

number

optionalKeys
required

Hex encoded value of optional multi-signature account members public keys

< string > array

nonce
required

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

string

balance
required

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

string

data
required

Account

meta
optional

object

maxHeightPreviouslyForged
required

The largest height of any block previously forged by the forging delegate.

number

maxHeightPrevoted
required

The largest height of any block previously prevoted by the forging delegate.

number

seedReveal
required

Hex encoded value that contains the new seed value revealed each round by the forging delegate.

string

asset
required

Object stored in the block header as defined by the application

BlockAsset

generatorPublicKey
required

Hex encoded value of public key of the delegate who forged the block.

string

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.

number

id
required

Hex encoded value of the unique identifier of the block.

string

previousBlockID
required

Hex encoded value of the ID of the previous block of the chain.

string

reward
required

The reward for the delegate.

string

signature
optional

Hex encoded value of the signature for the block.

string

timestamp
required

Unix timestamp of block created in second

number

transactionRoot
required

Hex encoded value of Merkle tree root of transaction IDs

string

version
required

Versioning for future upgrades of the Lisk protocol.

number

data
required

data

meta
optional

object

header
required

BlockHeader

payload
required

< Transaction > array

data
required

< data > array

meta
optional

object

header
required

BlockHeader

payload
required

< Transaction > array

data
required

< Account > array

meta
optional

Meta

errors
required

< errors > array

message
optional

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

string

address
required

The binary address in hex format as defined in LIP-0018.
Example : "9d0149b0962d44bfc08a9f64d5afceb6281d7fb5"

string

nextForgingTime
required

Returns the unix timestamp in second in which the forger will be able to forge the next block. Each slot has a timespan of 10 seconds.
Example : 4368793.0

number

totalVotesReceived
optional

The total votes received by the delegate. Represents the total amount of token that the delegates voters voted this delegate.
Example : "1081560729258"

string

username
required

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

string

data
required

List of forgers.

< Forger > array

meta
optional

object

accounts
required

Array of of initial forging delegate accounts.

< Account > array

initDelegates
required

Array of public keys of initial forging delegates.

< string > array

initRounds
required

Number of rounds for bootstrapping period.

number

limit
required

Limit applied to results.
Minimum value : 1

integer

offset
required

Offset value for results.
Default : 0
Minimum value : 0

integer (int32)

finalizedHeight
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

genesisConfig
required

genesisConfig

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

lastBlockID
required

ID of the last processed block.
Example : "vPFBr0ZTsyP9hUwKaQD8dW2lKBpgMWkRdgrTUUmBBCE="

string

networkIdentifier
required

Hex encoded value of the network identifier as per LIP-0009.
Example : "93d00fe5be70d90e7ae247936a2e7d83b50809c79b73fa14285f02c842348b3e"

string

networkVersion
required

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

string

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

version
required

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

string (version)

activeDelegates
required

Number of active delegates per round.
Example : 101

integer

blockTime
required

Block time interval in seconds.
Minimum value : 2
Example : 10

integer

communityIdentifier
optional

The unique name of the relevant community as a string encoded in UTF-8 format.
Example : "Lisk"

string

delegateListRoundOffset
required

Number of rounds before in which the list of delegates will be used for the current round.
Example : 2

integer

maxPayloadLength
required

Maximum size of transactions allowed per block.
Example : 15360

integer

rewards
required

rewards

standbyDelegates
required

Number of standby delegates per round.
Example : 2

integer

totalAmount
optional

Total amount of LSK available in network before rewards milestone started
Example : "10000000000000000"

string

distance
required

Distance in height between each milestone.
Example : 3000000

integer

milestones
required

Array of rewards.

< string > array

offset
required

height in which reward distribution starts.
Minimum value : 1
Example : 2160

integer

data
required

NodeInfo

meta
optional

object

ipAddress
required

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

string

networkIdentifier
required

Hex encoded value of the network identifier as per LIP-0009.
Example : "93d00fe5be70d90e7ae247936a2e7d83b50809c79b73fa14285f02c842348b3e"

string

networkVersion
required

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

string

options
required

Optional field defined by application

object

port
required

The port the peer node uses for P2P communication.
Minimum value : 1
Maximum value : 65535
Example : 8001

integer

state
required

The state of the peer.
Example : "connected"

enum (connected, disconnected)

data
required

< Peer > array

meta
optional

Meta

asset
required

Object stored per transaction type

object

assetID
optional

Asset Id for transaction asset

number

fee
required

Transaction fee associated with this transaction.

string

id
required

Hex encoded value of the unique identifier of the transaction.

string

moduleID
optional

Module Id for transaction asset

number

nonce
required

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

string

senderPublicKey
required

Hex encoded value of the public key of the Senders account.

string

signatures
required

< string > array

data
required

data

meta
optional

object

transactionId
required

string

asset
required

Object stored per transaction type

object

assetID
required

Asset Id for transaction asset

number

fee
required

Transaction fee associated with this transaction.

string

moduleID
required

Module Id for transaction asset

number

nonce
required

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

string

senderPublicKey
required

Hex encoded value of the public key of the Senders account.

string

signatures
required

< string > array

data
required

Transaction

meta
optional

object

data
required

< Transaction > array

meta
optional

Meta