For the best viewing experience, please turn your phone to portrait mode.

Lisk API 0.9 vs API 1.0

Important

Change of logic in API concerning chaining of parameters:
API 0.9: Most parameters join by OR by default, to join with AND specify AND: in front of the parameter.
API 1.0: All parameters join by AND by default, changing it to OR is not supported.

List of endpoints

Accounts

Query API 0.9 API 1.0
Get Information About All Accounts GET /api/accounts GET /api/accounts
Get Account Information POST /api/accounts/open

body:
{ "secret": "secret key of account" }
GET /api/accounts

Parameters:
address
publicKey
secondPublicKey
username
Get Account Information from Address GET /api/accounts?address={address} GET /api/accounts?address={address}
Get Account Balance GET /api/accounts/getBalance?address={address} GET /api/accounts?address={address}
Get Account Public Key GET /api/accounts/getPublicKey?address={address} GET /api/accounts?address={address}
Generate Public Key POST /api/accounts/generatePublicKey <Functionality is now part of Lisk Elements>
Get Vote Data Of An Account GET /api/accounts/delegates?address={address} Moved to Votes Endpoint
Vote Delegates PUT /api/accounts/delegates Moved to Transactions Endpoint
Request Multisignature Groups X GET /api/accounts/{address}/multisignature_groups
Request Members Of A Multisignature Group Moved from Multisignatures Endpoint GET /api/accounts/{address}/multisignature_memberships

Blocks

Query API 0.9 API 1.0
Get Blocks GET /api/blocks

Parameters:
generatorPublicKey
height
previousBlock
totalAmount
totalFee
GET /api/blocks

Parameters:
blockId
generatorPublicKey
height
Get Block by Id GET /api/blocks/get?id={id} GET /api/blocks?blockId={blockId}
Get Blockchain Fee GET /api/blocks/getFee Moved to Node Endpoint
Get Blockchain Fees Schedule GET /api/blocks/getFees Moved to Node Endpoint
Get Blockchain Reward Schedule GET /api/blocks/getReward Moved to Node Endpoint
Get Total Supply of Lisk Tokens (LSK) GET /api/blocks/getSupply Moved to Node Endpoint
Get Blockchain Height GET /api/blocks/getHeight Moved to Node Endpoint
Get Status of Height, Fee, Milestone,
Blockreward and Supply
GET /api/blocks/getStatus Moved to Node Endpoint
Get Blockchain Nethash GET /api/blocks/getNethash Moved to Node Endpoint
Get Blockchain Milestone GET /api/blocks/getMilestone Moved to Node Endpoint

Dapps

Query API 0.9 API 1.0
Dapp registration PUT /api/dapps Moved to Transactions Endpoint
Get Dapps GET /api/dapps?category={category}&name={name}&type={type}&link={link} GET /api/dapps
Get Dapp GET /api/dapps/get?id={id} GET /api/dapps?transactionId={transactionId}&name={name}
Search for Dapps GET /api/dapps/search?q=q&category={category}&installed={installed} X
Install Dapp POST /api/dapps/install X
Get Installed Dapps GET /api/dapps/installed X
Get Installed Dapps Ids GET /api/dapps/installedIds X
Uninstall Dapps POST /api/dapps/uninstall X
Launch Dapp POST /api/dapps/launch X
Get Installing Dapps GET /api/dapps/installing X
Get Uninstalling Dapps GET /api/dapps/uninstalling X
Get Launched Dapps GET /api/dapps/launched X
Get Dapps Categories GET /api/dapps/categories X
Stop Dapp POST /api/dapps/launch X

Delegates

Query API 0.9 API 1.0
Register Delegate on Account PUT /api/delegates Moved to Transactions Endpoint
Get Delegates GET /api/delegates

Parameters:
publicKey
username
GET /api/delegates

Parameters:
address
publicKey
secondPublicKey
username
search
Search for Delegates by Username or Part of Username GET /api/delegates/search?q={searcCriteria} GET api/delegates?search={searcCriteria}
Get Delegates Count GET /api/delegates/count X
Get Votes of an Account GET /api/accounts/delegates/?address={address} Moved to Votes Endpoint
Get Voters GET /api/delegates/voters?publicKey={publicKey} Moved to Voters Endpoint
Enable Forging on Delegate POST /api/delegates/forging/enable Moved to Node Endpoint
Disable Forging on Delegate POST /api/delegates/forging/disable Moved to Node Endpoint
Get Forged Amount by Account GET /api/delegates/forging/getForgedByAccount?generatorPublicKey={generatorPublicKey} GET /api/delegates/{address}/forging_stats
Get Next Forgers GET /api/delegates/getNextForgers GET /api/delegates/forgers

Loader

Query API 0.9 API 1.0
Get Loading Status GET /api/loader/status Moved to Node Endpoint
Get Synchronization Status GET /api/loader/status/sync Moved to Node Endpoint
Get Block Receipt Status GET /api/loader/status/ping X

Multisignatures

Query API 0.9 API 1.0
Create Multi-signature Account PUT /api/multisignatures Moved to Transactions Endpoint
Get Members Of A Multisignature Account GET /api/multisignatures/accounts?publicKey={publicKey} Moved to Accounts Endpoint
Sign Multi-signature Transaction POST /api/multisignatures/sign Moved to Signatures Endpoint
Get Pending Multi-signature Transactions GET /api/multisignatures/pending?publicKey={publicKey} Moved to Node Endpoint

Node

Query API 0.9 API 1.0
Get Constants Data Moved from Loader Endpoint GET /api/node/constants
Get Status Data Moved from Loader Endpoint GET /api/node/status
Get Forging Status Of A Delegate X GET /api/node/status/forging?publicKey={publicKey}
Toggle Forging Status Of A Delegate Moved from Delegates Endpoint PUT /api/node/status/forging
Get List of Unprocessed Transactions <Moved from Multisignatures and Transactions Endpoint> GET /api/node/transactions/{state}

States:
unprocessed, usigned, unconfirmed
Get Specific Unprocessed Transaction Moved from Transactions Endpoint GET /api/node/transactions/{state}

Parameters:
id
recipientId
recipientPublicKey
senderId
senderPublicKey
type

Peers

Query API 0.9 API 1.0
Get Peers List GET /api/peers GET /api/peers

Parameters:
ip
httpPort
wsPort
os
version
state
height
broadhash
Get Peer GET /api/peers/get?ip={ip}&port={port} GET /api/peers?ip={ip}&wsPort={wsPort}
Get Peer Version/Build Time GET /api/peers/version Moved to Node Endpoint

Signatures

Query API 0.9 API 1.0
Get Signature Fees GET /api/signatures/fee Moved to Node Endpoint
Add Second Passphrase PUT /api/signatures Moved to Transactions Endpoint
Sign a Multisignature Transaction X POST /api/signatures

Transactions

Query API 0.9 API 1.0
Get List of Transactions GET /api/transactions

Parameters:
blockId
senderId
recipientId
GET /api/transactions

Parameters:
blockId
senderId
recipientId
senderIdOrRecipientId
id
recipientPublicKey
senderPublicKey
type
height
minAmount
maxAmount
fromTimestamp
toTimestamp
Send Transaction (Type 0) PUT /api/transactions POST /api/transactions

<See examples for all transaction types in the documentation of Lisk Elements>
Send Transaction (Type 0 with data) X POST /api/transactions

<See examples for all transaction types in the documentation of Lisk Elements>
Send Transaction (Type 1,2,3,4,5) <Moved from Accounts, Delegates, Dapps, Signatures and Multisignatures Endpoint> POST /api/transactions

<See examples for all transaction types in the documentation of Lisk Elements>
Get Transaction GET /api/transactions/get?id={id} GET /api/transactions?id={id}
Get Specific Unprocessed Transaction GET /api/transactions/queued/get?id={id} Moved to Node Endpoint
GET /api/transactions/unconfirmed/get?id={id} Moved to Node Endpoint
Get List of Unprocessed Transactions GET /api/transactions/queued Moved to Node Endpoint
GET /api/transactions/unconfirmed Moved to Node Endpoint

Voters

Query API 0.9 API 1.0
Get Voters Data Of A Delegate Moved from Delegates Endpoint GET /api/voters

Parameters:
username
address
publicKey
secondPublicKey

Votes

Query API 0.9 API 1.0
Get Vote Data Of An Account Moved from Delegates Endpoint GET /api/votes

Parameters:
username
address
publicKey
secondPublicKey