json lisk-的OpenAPI
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了json lisk-的OpenAPI相关的知识，希望对你有一定的参考价值。
{
"swagger" : "2.0",
"info" : {
"description" : "# Welcome!\n\n## Access Restrictions\nThe API endpoints are by default restricted to a whitelist of IPs that can be found in `config.json` in the section [`api.access.whitelist`](https://github.com/LiskHQ/lisk/blob/1.0.0/config.json#L35).\nIf you want your API to be accessable by the public, you can do this by changing `api.access.public` to `true`.\nThis will allow anyone to make requests to your Lisk Core node.\nHowever some endpoints stay private, that means only a list of whitelisted IPs can successfully make API calls to that particular endpoint;\nThis includes all forging related API calls.\nBy default, only the nodes' local IP is included in the whitelist, you can change the setting in `config.json` in the section [`forging.access.whitelist`](https://github.com/LiskHQ/lisk/blob/1.0.0/config.json#L114).\nFor more details, see the descriptions at the respective endpoint.\n\n## Requests\nChained filter parameters are logically connected with `AND`.\n`HTTP` is the supported URL schema by default.\nTo enable `HTTPS`, please adjust the the [`ssl`](https://github.com/LiskHQ/lisk/blob/1.0.0/config.json#L124) section in `config.json`.\n\n## Responses\nThe general response format is JSON (`application/json`).\nThe responses for each API request have a common basic structure:\n```javascript\n{\n\t\"data\": {}, //Contains the requested data\n\t\"meta\": {}, //Contains additional metadata, e.g. the values of `limit` and `offset`\n\t\"links\": {} //Will contain links to connected API calls from here, e.g. pagination links\n}\n```\n\n## Date Formats\nMost of the timestamp parameters are in the Lisk Timestamp format, which is similar to the Unix Timestamp format.\nThe **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.\nThe **Lisk Epoch Time** is returned in the [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format, combined date and time: `YYYY-MM-DDThh:mm:ssZ`.\nFor details, see the descriptions and examples at the respective endpoint.\n\n## Pagination\nOne can paginate nicely through the results by providing `limit` and `offset` parameters to the requests.\n`limit` and `offset` can be found in the `meta`-object of the response of an API request.\nIf no limit and offset are provided, they are set to 10 and 0 by default, what will display the first 10 results.\n\n## List of Endpoints\nAll possible API endpoints for Lisk Core are listed below.\nClick on an endpoint to show descriptions, details and examples.\n",
"version" : "1.0.30",
"title" : "Lisk API Documentation",
"contact" : {
"email" : "admin@lisk.io"
},
"license" : {
"name" : "GPL v3.0",
"url" : "https://www.gnu.org/licenses/gpl-3.0.en.html"
}
},
"basePath" : "/api",
"tags" : [ {
"name" : "Accounts",
"description" : "Account related API calls"
}, {
"name" : "Blocks",
"description" : "Block related API calls"
}, {
"name" : "Dapps",
"description" : "Dapps related API calls"
}, {
"name" : "Delegates",
"description" : "Delegates related API calls"
}, {
"name" : "Node",
"description" : "Node related API calls"
}, {
"name" : "Peers",
"description" : "Peers related API Calls"
}, {
"name" : "Signatures",
"description" : "Signatures related API calls"
}, {
"name" : "Transactions",
"description" : "Transactions related API calls"
}, {
"name" : "Voters",
"description" : "Votes related API calls"
}, {
"name" : "Votes",
"description" : "Votes related API calls"
} ],
"schemes" : [ "http", "https" ],
"paths" : {
"/accounts" : {
"get" : {
"tags" : [ "Accounts" ],
"summary" : "Requests account data",
"description" : "Search for matching accounts in the system.",
"operationId" : "getAccounts",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "address",
"in" : "query",
"description" : "Address of an account",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 2,
"format" : "address"
}, {
"name" : "publicKey",
"in" : "query",
"description" : "Public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "secondPublicKey",
"in" : "query",
"description" : "Second public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "username",
"in" : "query",
"description" : "Delegate username to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "username"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "balance:asc",
"enum" : [ "balance:asc", "balance:desc" ]
} ],
"responses" : {
"200" : {
"description" : "List of accounts",
"schema" : {
"$ref" : "#/definitions/AccountsResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "accounts"
},
"/accounts/{address}/multisignature_groups" : {
"get" : {
"tags" : [ "Accounts" ],
"summary" : "Requests multisignature groups data",
"description" : "Searches for the specified account in the system and responds with a list of the multisignature groups that this account is member of.",
"operationId" : "getMultisignatureGroups",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "address",
"in" : "path",
"description" : "Lisk address of an account",
"required" : true,
"type" : "string",
"maxLength" : 22,
"minLength" : 2,
"format" : "address"
} ],
"responses" : {
"200" : {
"description" : "List of multisignature accounts",
"schema" : {
"$ref" : "#/definitions/MultisignatureGroupsResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"404" : {
"description" : "Multisignature account not found",
"schema" : {
"$ref" : "#/definitions/NotFoundError"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "accounts"
},
"/accounts/{address}/multisignature_memberships" : {
"get" : {
"tags" : [ "Accounts" ],
"summary" : "Requests multisignature membership data",
"description" : "Searches for the specified multisignature group and responds with a list of all members of this particular multisignature group.",
"operationId" : "getMultisignatureMemberships",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "address",
"in" : "path",
"description" : "Lisk address of a multisignature account",
"required" : true,
"type" : "string",
"maxLength" : 22,
"minLength" : 2,
"format" : "address"
} ],
"responses" : {
"200" : {
"description" : "List of multisignature accounts",
"schema" : {
"$ref" : "#/definitions/MultisignatureGroupsResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "accounts"
},
"/dapps" : {
"get" : {
"tags" : [ "Dapps" ],
"summary" : "Requests dapps data",
"description" : "Search for a specified dapp in the system.",
"operationId" : "getDapps",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "transactionId",
"in" : "query",
"description" : "Dapp registration transaction ID",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "id"
}, {
"name" : "name",
"in" : "query",
"description" : "Name to query - Fuzzy search",
"required" : false,
"type" : "string",
"maxLength" : 32,
"minLength" : 1
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "name:asc",
"enum" : [ "name:asc", "name:desc" ]
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "Search results matching criteria",
"schema" : {
"$ref" : "#/definitions/DappsResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "dapps"
},
"/peers" : {
"get" : {
"tags" : [ "Peers" ],
"summary" : "Requests peers data",
"description" : "Search for specified peers.",
"operationId" : "getPeers",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "ip",
"in" : "query",
"description" : "IP of the node or delegate",
"required" : false,
"type" : "string",
"format" : "ip"
}, {
"name" : "httpPort",
"in" : "query",
"description" : "Http port of the node or delegate",
"required" : false,
"type" : "integer",
"maximum" : 65535,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "wsPort",
"in" : "query",
"description" : "Web socket port for the node or delegate",
"required" : false,
"type" : "integer",
"maximum" : 65535,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "os",
"in" : "query",
"description" : "OS of the node",
"required" : false,
"type" : "string"
}, {
"name" : "version",
"in" : "query",
"description" : "Lisk version of the node",
"required" : false,
"type" : "string",
"format" : "version"
}, {
"name" : "state",
"in" : "query",
"description" : "Current state of the network",
"required" : false,
"type" : "integer",
"maximum" : 2,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "height",
"in" : "query",
"description" : "Current height of the network",
"required" : false,
"type" : "integer",
"minimum" : 1,
"format" : "int32"
}, {
"name" : "broadhash",
"in" : "query",
"description" : "Broadhash of the network",
"required" : false,
"type" : "string",
"format" : "hex"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "height:desc",
"enum" : [ "height:asc", "height:desc", "version:asc", "version:desc" ]
} ],
"responses" : {
"200" : {
"description" : "List of peers",
"schema" : {
"$ref" : "#/definitions/PeersResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "peers"
},
"/node/constants" : {
"get" : {
"tags" : [ "Node" ],
"summary" : "Requests constants data",
"description" : "Returns all current constants data on the system, e.g. Lisk epoch time and version.",
"operationId" : "getConstants",
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "Node constants response",
"schema" : {
"$ref" : "#/definitions/NodeConstantsResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "node"
},
"/node/status" : {
"get" : {
"tags" : [ "Node" ],
"summary" : "Requests status data",
"description" : "Returns all current status data of the node, e.g. height and broadhash.",
"operationId" : "getStatus",
"produces" : [ "application/json" ],
"parameters" : [ ],
"responses" : {
"200" : {
"description" : "Node status response",
"schema" : {
"$ref" : "#/definitions/NodeStatusResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "node"
},
"/node/status/forging" : {
"get" : {
"tags" : [ "Node" ],
"summary" : "Requests forging status of a delegate",
"description" : "*Attention! This is a **private endpoint only authorized to whitelisted IPs.**\nTo edit the whitelist, please edit the `forging.access.whitelist` section in `config.json`*<br>\nResponds with the forging status of a delegate on a node.\n",
"operationId" : "getForgingStatus",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "publicKey",
"in" : "query",
"description" : "Public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
} ],
"responses" : {
"200" : {
"description" : "Search results matching criteria",
"schema" : {
"$ref" : "#/definitions/ForgingStatusResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"403" : {
"description" : "Access denied",
"schema" : {
"$ref" : "#/definitions/AccessDeniedError"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"put" : {
"tags" : [ "Node" ],
"summary" : "Toggles the forging status of a delegate",
"description" : "*Attention! This is a **private endpoint only authorized to whitelisted IPs.**\nTo edit the whitelist, please edit the `forging.access.whitelist` section in `config.json`*<br>\nUpon passing the correct password and publicKey, forging will be enabled or disabled for the delegate of this particular node.\nThe password can be generated locally by encrypting your passphrase, either by using Lisk Commander or with Lisk Elements.\n",
"operationId" : "updateForgingStatus",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "data",
"description" : "Password for decrypting passphrase of delegate with corresponding public key",
"required" : true,
"schema" : {
"$ref" : "#/definitions/data"
}
} ],
"responses" : {
"200" : {
"description" : "Delegate forging toggled on or off",
"schema" : {
"$ref" : "#/definitions/ForgingStatusResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"403" : {
"description" : "Access denied",
"schema" : {
"$ref" : "#/definitions/AccessDeniedError"
}
},
"404" : {
"description" : "Provided public key not found",
"schema" : {
"$ref" : "#/definitions/NotFoundError"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "node"
},
"/node/transactions/{state}" : {
"get" : {
"tags" : [ "Node" ],
"summary" : "Requests unprocessed transactions data",
"description" : "By specifying the state of the transactions, you get a list of unprocessed transactions matching this state.\nSearch for specific transactions by providing the appropriate parameters.\nIf you post a batch of transactions, they will appear in the unprocessed list after a small delay, depending on server load.\n",
"operationId" : "getPooledTransactions",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "state",
"in" : "path",
"description" : "State of transactions to query",
"required" : true,
"type" : "string",
"default" : "unprocessed",
"enum" : [ "unprocessed", "unconfirmed", "unsigned" ]
}, {
"name" : "id",
"in" : "query",
"description" : "Transaction id to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "id"
}, {
"name" : "recipientId",
"in" : "query",
"description" : "Recipient lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
}, {
"name" : "recipientPublicKey",
"in" : "query",
"description" : "Recipient public key",
"required" : false,
"type" : "string",
"minLength" : 1,
"format" : "publicKey"
}, {
"name" : "senderId",
"in" : "query",
"description" : "Sender lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
}, {
"name" : "senderPublicKey",
"in" : "query",
"description" : "Sender public key",
"required" : false,
"type" : "string",
"minLength" : 1,
"format" : "publicKey"
}, {
"name" : "type",
"in" : "query",
"description" : "Transaction type (0-7)",
"required" : false,
"type" : "integer",
"maximum" : 7,
"minimum" : 0
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "amount:desc",
"enum" : [ "amount:asc", "amount:desc", "fee:asc", "fee:desc", "type:asc", "type:desc", "timestamp:asc", "timestamp:desc" ]
} ],
"responses" : {
"200" : {
"description" : "Transactions list",
"schema" : {
"$ref" : "#/definitions/TransactionsResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "node"
},
"/delegates" : {
"get" : {
"tags" : [ "Delegates" ],
"summary" : "Requests delegates data",
"description" : "Search for a specified delegate in the system.",
"operationId" : "getDelegates",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "address",
"in" : "query",
"description" : "Address of an account",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 2,
"format" : "address"
}, {
"name" : "publicKey",
"in" : "query",
"description" : "Public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "secondPublicKey",
"in" : "query",
"description" : "Second public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "username",
"in" : "query",
"description" : "Delegate username to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "username"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 101,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "search",
"in" : "query",
"description" : "Fuzzy delegate username to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "rank:desc",
"enum" : [ "username:asc", "username:desc", "rank:asc", "rank:desc", "productivity:asc", "productivity:desc", "missedBlocks:asc", "missedBlocks:desc" ]
} ],
"responses" : {
"200" : {
"description" : "Search results matching criteria",
"schema" : {
"$ref" : "#/definitions/DelegatesResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
},
"x-lisk-cache-enabled" : true
},
"x-swagger-router-controller" : "delegates"
},
"/delegates/forgers" : {
"get" : {
"tags" : [ "Delegates" ],
"summary" : "Requests next forgers data",
"description" : "Returns a list of the next forgers in this delegate round.\n",
"operationId" : "getForgers",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 101,
"minimum" : 1,
"format" : "int32"
} ],
"responses" : {
"200" : {
"description" : "Search results matching criteria",
"schema" : {
"$ref" : "#/definitions/ForgersResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "delegates"
},
"/delegates/{address}/forging_statistics" : {
"get" : {
"tags" : [ "Delegates" ],
"summary" : "Requests forging stats by delegate",
"description" : "By passing an existing delegate address and the desired unix timestamps, you can get its forging statistics within the specified timespan.\nIf no timestamps are provided, it will use the timestamps from Lisk epoch to current date.\n",
"operationId" : "getForgingStatistics",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "address",
"in" : "path",
"description" : "Lisk address of a delegate",
"required" : true,
"type" : "string",
"format" : "address"
}, {
"name" : "fromTimestamp",
"in" : "query",
"description" : "Starting unix timestamp",
"required" : false,
"type" : "integer",
"minimum" : 0
}, {
"name" : "toTimestamp",
"in" : "query",
"description" : "Ending unix timestamp",
"required" : false,
"type" : "integer",
"minimum" : 1
} ],
"responses" : {
"200" : {
"description" : "Results matching specified delegate address",
"schema" : {
"$ref" : "#/definitions/ForgingStatsResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
},
"x-lisk-cache-enabled" : true
},
"x-swagger-router-controller" : "delegates"
},
"/blocks" : {
"get" : {
"tags" : [ "Blocks" ],
"summary" : "Requests blocks data",
"description" : "Search for a specified block in the system.\n",
"operationId" : "getBlocks",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "blockId",
"in" : "query",
"description" : "Block id to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "id"
}, {
"name" : "height",
"in" : "query",
"description" : "Current height of the network",
"required" : false,
"type" : "integer",
"minimum" : 1,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "generatorPublicKey",
"in" : "query",
"description" : "Public key of the forger of the block",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "height:desc",
"enum" : [ "height:asc", "height:desc", "totalAmount:asc", "totalAmount:desc", "totalFee:asc", "totalFee:desc", "timestamp:asc", "timestamp:desc" ]
} ],
"responses" : {
"200" : {
"description" : "Search results matching criteria",
"schema" : {
"$ref" : "#/definitions/BlocksResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
},
"x-lisk-cache-enabled" : true
},
"x-swagger-router-controller" : "blocks"
},
"/voters" : {
"get" : {
"tags" : [ "Voters" ],
"summary" : "Requests voters data for a delegate",
"description" : "*Attention: At least **one of the filter parameters must be provided.***\nReturns all votes received by a delegate.\n",
"operationId" : "getVoters",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "username",
"in" : "query",
"description" : "Delegate username to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "username"
}, {
"name" : "address",
"in" : "query",
"description" : "Address of an account",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 2,
"format" : "address"
}, {
"name" : "publicKey",
"in" : "query",
"description" : "Public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "secondPublicKey",
"in" : "query",
"description" : "Second public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "username:asc",
"enum" : [ "username:asc", "username:desc", "balance:asc", "balance:desc" ]
} ],
"responses" : {
"200" : {
"description" : "Voters list",
"schema" : {
"$ref" : "#/definitions/VotersResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"404" : {
"description" : "Requested resource not found based on provided filters",
"schema" : {
"$ref" : "#/definitions/NotFoundError"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "voters"
},
"/votes" : {
"get" : {
"tags" : [ "Votes" ],
"summary" : "Requests votes data for an account",
"description" : "*Attention: At least **one of the filter parameters must be provided.***\nReturns all votes placed by an account.\n",
"operationId" : "getVotes",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "username",
"in" : "query",
"description" : "Delegate username to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "username"
}, {
"name" : "address",
"in" : "query",
"description" : "Address of an account",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 2,
"format" : "address"
}, {
"name" : "publicKey",
"in" : "query",
"description" : "Public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "secondPublicKey",
"in" : "query",
"description" : "Second public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 101,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "username:asc",
"enum" : [ "username:asc", "username:desc", "balance:asc", "balance:desc" ]
} ],
"responses" : {
"200" : {
"description" : "Votes list",
"schema" : {
"$ref" : "#/definitions/VotesResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"404" : {
"description" : "Requested resource not found based on provided filters",
"schema" : {
"$ref" : "#/definitions/NotFoundError"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "voters"
},
"/signatures" : {
"post" : {
"tags" : [ "Signatures" ],
"summary" : "Submits a signature object to sign multisignature transactions",
"description" : "Submits signature to sign a multisignature transaction.\nSignature objects can be generated locally either by using Lisk Commander or with Lisk Elements.\n",
"operationId" : "postSignature",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "signature",
"description" : "Signature object to submit to the network",
"required" : true,
"schema" : {
"$ref" : "#/definitions/Signature"
}
} ],
"responses" : {
"200" : {
"description" : "Signature is accepted by the node for processing",
"schema" : {
"$ref" : "#/definitions/SignatureResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"409" : {
"description" : "Some error related to processing of request",
"schema" : {
"$ref" : "#/definitions/ProcessingError"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
}
},
"x-swagger-router-controller" : "signatures"
},
"/transactions" : {
"get" : {
"tags" : [ "Transactions" ],
"summary" : "Requests transactions data",
"description" : "Search for a specified transaction in the system.\n",
"operationId" : "getTransactions",
"produces" : [ "application/json" ],
"parameters" : [ {
"name" : "id",
"in" : "query",
"description" : "Transaction id to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "id"
}, {
"name" : "recipientId",
"in" : "query",
"description" : "Recipient lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
}, {
"name" : "recipientPublicKey",
"in" : "query",
"description" : "Recipient public key",
"required" : false,
"type" : "string",
"minLength" : 1,
"format" : "publicKey"
}, {
"name" : "senderId",
"in" : "query",
"description" : "Sender lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
}, {
"name" : "senderPublicKey",
"in" : "query",
"description" : "Sender public key",
"required" : false,
"type" : "string",
"minLength" : 1,
"format" : "publicKey"
}, {
"name" : "senderIdOrRecipientId",
"in" : "query",
"description" : "Lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
}, {
"name" : "type",
"in" : "query",
"description" : "Transaction type (0-7)",
"required" : false,
"type" : "integer",
"maximum" : 7,
"minimum" : 0
}, {
"name" : "height",
"in" : "query",
"description" : "Current height of the network",
"required" : false,
"type" : "integer",
"minimum" : 1,
"format" : "int32"
}, {
"name" : "minAmount",
"in" : "query",
"description" : "Minimum transaction amount in Beddows",
"required" : false,
"type" : "integer",
"minimum" : 0
}, {
"name" : "maxAmount",
"in" : "query",
"description" : "Maximum transaction amount in Beddows",
"required" : false,
"type" : "integer",
"minimum" : 0
}, {
"name" : "fromTimestamp",
"in" : "query",
"description" : "Starting unix timestamp",
"required" : false,
"type" : "integer",
"minimum" : 0
}, {
"name" : "toTimestamp",
"in" : "query",
"description" : "Ending unix timestamp",
"required" : false,
"type" : "integer",
"minimum" : 1
}, {
"name" : "blockId",
"in" : "query",
"description" : "Block id to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "id"
}, {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
}, {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
}, {
"name" : "sort",
"in" : "query",
"description" : "Fields to sort results by",
"required" : false,
"type" : "string",
"default" : "amount:asc",
"enum" : [ "amount:asc", "amount:desc", "fee:asc", "fee:desc", "type:asc", "type:desc", "timestamp:asc", "timestamp:desc" ]
} ],
"responses" : {
"200" : {
"description" : "Transactions list",
"schema" : {
"$ref" : "#/definitions/TransactionsResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
},
"500" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/UnexpectedError"
}
}
},
"x-lisk-cache-enabled" : true
},
"post" : {
"tags" : [ "Transactions" ],
"summary" : "Submits signed transaction for processing",
"description" : "Submits signed transaction object for processing by the transaction pool.\nTransaction objects can be generated locally either by using Lisk Commander or with Lisk Elements.\n",
"operationId" : "postTransaction",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "transaction",
"description" : "Transaction object to submit to the network",
"required" : true,
"schema" : {
"$ref" : "#/definitions/TransactionRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Transaction accepted by the node for processing",
"schema" : {
"$ref" : "#/definitions/GeneralStatusResponse"
}
},
"400" : {
"description" : "Malformed query or parameters",
"schema" : {
"$ref" : "#/definitions/ParamErrorResponse"
}
},
"409" : {
"description" : "Some error related to processing of request",
"schema" : {
"$ref" : "#/definitions/ProcessingError"
}
},
"429" : {
"description" : "Too many requests, exceeded rate limit",
"schema" : {
"$ref" : "#/definitions/RequestLimitError"
}
}
}
},
"x-swagger-router-controller" : "transactions"
},
"/spec" : {
"x-swagger-pipe" : "swagger_raw_pipe"
}
},
"definitions" : {
"Meta" : {
"type" : "object",
"required" : [ "limit", "offset" ],
"properties" : {
"limit" : {
"$ref" : "#/definitions/Limit"
},
"offset" : {
"$ref" : "#/definitions/Offset"
}
},
"example" : {
"offset" : { },
"limit" : { }
}
},
"Limit" : {
"type" : "integer",
"minimum" : 1,
"maximum" : 100.0,
"format" : "int32",
"description" : "Limit applied to results",
"default" : 10
},
"Offset" : {
"type" : "integer",
"minimum" : 0,
"format" : "int32",
"description" : "Offset value for results",
"default" : 0
},
"TransactionRequest" : {
"type" : "object",
"required" : [ "amount", "asset", "fee", "id", "recipientId", "senderPublicKey", "signature", "timestamp", "type" ],
"properties" : {
"id" : {
"type" : "string",
"format" : "id",
"example" : "222675625422353767",
"description" : "Unique identifier of the transaction.\nDerived from the transaction signature.\n",
"minLength" : 1,
"maxLength" : 20
},
"amount" : {
"type" : "string",
"example" : "150000000",
"description" : "Amount of Lisk to be transferred in this transaction.\n"
},
"fee" : {
"type" : "string",
"example" : "1000000",
"description" : "Transaction fee associated with this transaction.\n"
},
"type" : {
"type" : "integer",
"description" : "Describes the Transaction type.\n",
"minimum" : 0,
"maximum" : 7
},
"timestamp" : {
"type" : "integer",
"example" : 28227090,
"description" : "Time when the transaction was created.\nUnix Timestamp.\n"
},
"senderId" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "Lisk Address of the Senders' account.\n"
},
"senderPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "The public key of the Senders' account.\n"
},
"senderSecondPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "The second public key of the Senders' account, if it exists.\n"
},
"recipientId" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "Lisk Address of the Recipients' account.\n"
},
"signature" : {
"type" : "string",
"format" : "signature",
"example" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"description" : "Derived from a SHA-256 hash of the transaction object,\nthat is signed by the private key of the account who created the transaction.\n"
},
"signSignature" : {
"type" : "string",
"format" : "signature",
"example" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"description" : "Contains the second signature, if the transaction is sent from an account with second passphrase activated."
},
"signatures" : {
"type" : "array",
"description" : "If the transaction is a multisignature transaction, all signatures of the members of the corresponding multisignature group will be listed here.",
"items" : {
"type" : "string",
"format" : "signature",
"example" : "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a"
}
},
"asset" : {
"type" : "object",
"description" : "Displays additional transaction data.\nCan include e.g. vote data or delegate username.\n",
"properties" : { }
}
},
"example" : {
"senderPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"signSignature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"amount" : "150000000",
"signature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"fee" : "1000000",
"type" : 0,
"signatures" : [ "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a", "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a" ],
"senderId" : "12668885769632475474L",
"recipientId" : "12668885769632475474L",
"id" : "222675625422353767",
"senderSecondPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"asset" : "{}",
"timestamp" : 28227090
}
},
"NodeStatusResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/NodeStatus"
},
"meta" : {
"type" : "object",
"properties" : { }
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : {
"consensus" : 95,
"loaded" : true,
"broadhash" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea",
"networkHeight" : 123,
"syncing" : false,
"transactions" : {
"unconfirmed" : 5,
"total" : 15,
"unprocessed" : 3,
"unsigned" : 2,
"confirmed" : 5
},
"height" : 123
},
"meta" : "{}",
"links" : "{}"
}
},
"NodeConstantsResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/NodeConstants"
},
"meta" : {
"type" : "object",
"properties" : { }
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : {
"reward" : "500000000",
"nethash" : "ed14889723f24ecc54871d058d98ce91ff2f973192075c0155ba2b7b70ad2511",
"fees" : {
"delegate" : "2500000000",
"secondSignature" : "500000000",
"dappDeposit" : "10000000",
"send" : "10000000",
"vote" : "100000000",
"dappWithdrawal" : "10000000",
"dappRegistration" : "2500000000",
"multisignature" : "500000000"
},
"milestone" : "500000000",
"build" : "v09:54:35 12/04/2017",
"commit" : "7199d4b67c3575d5f99d1c29436a02977eeb01a7",
"epoch" : "2016-05-24T17:00:00.000Z",
"version" : "v0.8.0",
"supply" : "10575384500000000",
"nonce" : "cJmXK66xxz644d67"
},
"meta" : "{}",
"links" : "{}"
}
},
"PeersResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Peer"
}
},
"meta" : {
"$ref" : "#/definitions/PeersResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Peers response",
"example" : {
"data" : [ {
"os" : "debian",
"broadhash" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea",
"httpPort" : 8000,
"wsPort" : 8001,
"ip" : "127.0.0.1",
"state" : 2,
"version" : "v0.8.0",
"nonce" : "sYHEDBKcScaAAAYg",
"height" : 123
}, {
"os" : "debian",
"broadhash" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea",
"httpPort" : 8000,
"wsPort" : 8001,
"ip" : "127.0.0.1",
"state" : 2,
"version" : "v0.8.0",
"nonce" : "sYHEDBKcScaAAAYg",
"height" : 123
} ],
"meta" : {
"offset" : { },
"limit" : { },
"count" : 100
},
"links" : "{}"
}
},
"AccountsResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"description" : "List of accounts",
"items" : {
"$ref" : "#/definitions/AccountExtended"
}
},
"meta" : {
"$ref" : "#/definitions/Meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : [ {
"unconfirmedBalance" : "0",
"delegate" : {
"productivity" : 96.41,
"missedBlocks" : 427,
"approval" : 14.22,
"rank" : 70,
"producedBlocks" : 20131,
"vote" : "1081560729258",
"rewards" : "510000000",
"username" : "isabella"
},
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}, {
"unconfirmedBalance" : "0",
"delegate" : {
"productivity" : 96.41,
"missedBlocks" : 427,
"approval" : 14.22,
"rank" : 70,
"producedBlocks" : 20131,
"vote" : "1081560729258",
"rewards" : "510000000",
"username" : "isabella"
},
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
} ],
"meta" : {
"offset" : { },
"limit" : { }
},
"links" : "{}"
}
},
"MultisignatureGroupsResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"description" : "List of multisignature groups",
"items" : {
"$ref" : "#/definitions/MultisignatureGroup"
}
},
"meta" : {
"type" : "object",
"properties" : { }
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : [ {
"unconfirmedBalance" : "0",
"address" : "12668885769632475474L",
"min" : 3,
"balance" : "1081560729258",
"members" : [ {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}, {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
} ],
"lifetime" : 72,
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}, {
"unconfirmedBalance" : "0",
"address" : "12668885769632475474L",
"min" : 3,
"balance" : "1081560729258",
"members" : [ {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}, {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
} ],
"lifetime" : 72,
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
} ],
"meta" : "{}",
"links" : "{}"
}
},
"DappsResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Dapp"
}
},
"meta" : {
"$ref" : "#/definitions/Meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Dapps endpoint response",
"example" : {
"data" : [ {
"icon" : "http://www.blocksafefoundation.com/header.jpg",
"link" : "https://github.com/blocksafe/SDK-notice/archive/master.zip",
"name" : "Blocksafe",
"description" : "Smart Gun Network",
"category" : 8.0,
"type" : 8.0,
"transactionId" : "15359945250124697273",
"tags" : "Smartgun"
}, {
"icon" : "http://www.blocksafefoundation.com/header.jpg",
"link" : "https://github.com/blocksafe/SDK-notice/archive/master.zip",
"name" : "Blocksafe",
"description" : "Smart Gun Network",
"category" : 8.0,
"type" : 8.0,
"transactionId" : "15359945250124697273",
"tags" : "Smartgun"
} ],
"meta" : {
"offset" : { },
"limit" : { }
},
"links" : "{}"
}
},
"DelegatesResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"description" : "List of delegates",
"items" : {
"$ref" : "#/definitions/DelegateWithAccount"
}
},
"meta" : {
"$ref" : "#/definitions/DelegatesResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : [ {
"productivity" : 96.41,
"missedBlocks" : 427,
"approval" : 14.22,
"rank" : 70,
"producedBlocks" : 20131,
"vote" : "1081560729258",
"rewards" : "510000000",
"account" : {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
},
"username" : "isabella"
}, {
"productivity" : 96.41,
"missedBlocks" : 427,
"approval" : 14.22,
"rank" : 70,
"producedBlocks" : 20131,
"vote" : "1081560729258",
"rewards" : "510000000",
"account" : {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
},
"username" : "isabella"
} ],
"meta" : {
"offset" : { },
"limit" : 9
},
"links" : "{}"
}
},
"ForgersResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"description" : "List of forgers",
"items" : {
"$ref" : "#/definitions/Forger"
}
},
"meta" : {
"$ref" : "#/definitions/ForgersResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : [ {
"address" : "6251001604903637008L",
"nextSlot" : 4368793.0,
"publicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"username" : "isabella"
}, {
"address" : "6251001604903637008L",
"nextSlot" : 4368793.0,
"publicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"username" : "isabella"
} ],
"meta" : {
"currentSlot" : 10,
"lastBlock" : 10,
"offset" : { },
"limit" : 9,
"lastBlockSlot" : 10
},
"links" : "{}"
}
},
"ForgingStatusResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/ForgingStatus"
}
},
"meta" : {
"type" : "object",
"properties" : { }
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : [ {
"forging" : true,
"publicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079"
}, {
"forging" : true,
"publicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079"
} ],
"meta" : "{}",
"links" : "{}"
}
},
"ForgingStatsResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/ForgingStats"
},
"meta" : {
"$ref" : "#/definitions/ForgingStatsResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : {
"fees" : "15000000",
"forged" : "65000000",
"count" : "100",
"rewards" : "50000000"
},
"meta" : {
"fromTimestamp" : 0,
"toTimestamp" : 1525861914
},
"links" : "{}"
}
},
"BlocksResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Block"
}
},
"meta" : {
"$ref" : "#/definitions/Meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Blocks response",
"example" : {
"data" : [ {
"reward" : "50000000",
"payloadLength" : 117,
"generatorPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"payloadHash" : "4e4d91be041e09a2e54bb7dd38f1f2a02ee7432ec9f169ba63cd1f193a733dd2",
"previousBlockId" : "15918760246746894806",
"blockSignature" : "a3733254aad600fa787d6223002278c3400be5e8ed4763ae27f9a15b80e20c22ac9259dc926f4f4cabdf0e4f8cec49308fa8296d71c288f56b9d1e11dfe81e07",
"confirmations" : 200,
"numberOfTransactions" : 15,
"version" : 0,
"generatorAddress" : "12668885769632475474L",
"totalAmount" : "150000000",
"totalForged" : "65000000",
"totalFee" : "15000000",
"id" : "6258354802676165798",
"height" : 123,
"timestamp" : 28227090
}, {
"reward" : "50000000",
"payloadLength" : 117,
"generatorPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"payloadHash" : "4e4d91be041e09a2e54bb7dd38f1f2a02ee7432ec9f169ba63cd1f193a733dd2",
"previousBlockId" : "15918760246746894806",
"blockSignature" : "a3733254aad600fa787d6223002278c3400be5e8ed4763ae27f9a15b80e20c22ac9259dc926f4f4cabdf0e4f8cec49308fa8296d71c288f56b9d1e11dfe81e07",
"confirmations" : 200,
"numberOfTransactions" : 15,
"version" : 0,
"generatorAddress" : "12668885769632475474L",
"totalAmount" : "150000000",
"totalForged" : "65000000",
"totalFee" : "15000000",
"id" : "6258354802676165798",
"height" : 123,
"timestamp" : 28227090
} ],
"meta" : {
"offset" : { },
"limit" : { }
},
"links" : "{}"
}
},
"SignatureResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/SignatureResponse_data"
},
"meta" : {
"$ref" : "#/definitions/SignatureResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Signature response",
"example" : {
"data" : {
"message" : "message"
},
"meta" : {
"status" : true
},
"links" : "{}"
}
},
"TransactionsResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Transaction"
}
},
"meta" : {
"$ref" : "#/definitions/TransactionsResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Transactions response",
"example" : {
"data" : [ {
"senderPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"signSignature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"amount" : "150000000",
"signature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"fee" : "1000000",
"recipientPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"relays" : 5,
"type" : 0,
"confirmations" : 0,
"receivedAt" : "2000-01-23T04:56:07.000+00:00",
"signatures" : [ "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a", "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a" ],
"blockId" : "6258354802676165798",
"senderId" : "12668885769632475474L",
"ready" : false,
"recipientId" : "12668885769632475474L",
"id" : "222675625422353767",
"senderSecondPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"asset" : "{}",
"height" : 1,
"timestamp" : 28227090
}, {
"senderPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"signSignature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"amount" : "150000000",
"signature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"fee" : "1000000",
"recipientPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"relays" : 5,
"type" : 0,
"confirmations" : 0,
"receivedAt" : "2000-01-23T04:56:07.000+00:00",
"signatures" : [ "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a", "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a" ],
"blockId" : "6258354802676165798",
"senderId" : "12668885769632475474L",
"ready" : false,
"recipientId" : "12668885769632475474L",
"id" : "222675625422353767",
"senderSecondPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"asset" : "{}",
"height" : 1,
"timestamp" : 28227090
} ],
"meta" : {
"offset" : { },
"limit" : { },
"count" : 100
},
"links" : "{}"
}
},
"GeneralStatusResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/SignatureResponse_data"
},
"meta" : {
"$ref" : "#/definitions/GeneralStatusResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"example" : {
"data" : {
"message" : "message"
},
"meta" : {
"status" : true
},
"links" : "{}"
}
},
"Transaction" : {
"type" : "object",
"required" : [ "amount", "asset", "fee", "id", "recipientId", "senderPublicKey", "signature", "timestamp", "type" ],
"properties" : {
"id" : {
"type" : "string",
"format" : "id",
"example" : "222675625422353767",
"description" : "Unique identifier of the transaction.\nDerived from the transaction signature.\n",
"minLength" : 1,
"maxLength" : 20
},
"amount" : {
"type" : "string",
"example" : "150000000",
"description" : "Amount of Lisk to be transferred in this transaction.\n"
},
"fee" : {
"type" : "string",
"example" : "1000000",
"description" : "Transaction fee associated with this transaction.\n"
},
"type" : {
"type" : "integer",
"description" : "Describes the Transaction type.\n",
"minimum" : 0,
"maximum" : 7
},
"height" : {
"type" : "integer",
"description" : "The height of the network, at the moment where this transaction was included in the blockchain.\n",
"minimum" : 1
},
"blockId" : {
"type" : "string",
"format" : "id",
"example" : "6258354802676165798",
"description" : "The Id of the block, this transaction is included in.\n",
"minLength" : 1,
"maxLength" : 20
},
"timestamp" : {
"type" : "integer",
"example" : 28227090,
"description" : "Time when the transaction was created.\nUnix Timestamp.\n"
},
"senderId" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "Lisk Address of the Senders' account.\n"
},
"senderPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "The public key of the Senders' account.\n"
},
"senderSecondPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "The second public key of the Senders' account, if it exists.\n"
},
"recipientId" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "Lisk Address of the Recipients' account.\n"
},
"recipientPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "The public key of the Recipients' account.\n"
},
"signature" : {
"type" : "string",
"format" : "signature",
"example" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"description" : "Derived from a SHA-256 hash of the transaction object,\nthat is signed by the private key of the account who created the transaction.\n"
},
"signSignature" : {
"type" : "string",
"format" : "signature",
"example" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"description" : "Contains the second signature, if the transaction is sent from an account with second passphrase activated."
},
"signatures" : {
"type" : "array",
"items" : {
"type" : "string",
"format" : "signature",
"example" : "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a",
"description" : "If the transaction is a multisignature transaction, all signatures of the members of the corresponding multisignature group will be listed here."
}
},
"confirmations" : {
"type" : "integer",
"description" : "Number of times that this transaction has been confirmed by the network.\nBy forging a new block on a chain, all former blocks and their contained transactions in the chain get confirmed by the forging delegate.\n",
"minimum" : 0
},
"asset" : {
"type" : "object",
"properties" : { }
},
"receivedAt" : {
"type" : "string",
"format" : "date-time",
"description" : "The timestamp of the moment, where a node discovered a transaction for the first time."
},
"relays" : {
"type" : "integer",
"description" : "Number of times, a single transaction object has been broadcasted to another peer."
},
"ready" : {
"type" : "boolean",
"example" : false,
"description" : "Only present in transactions sent from a multisignature account, or transactions type 4 (multisignature registration).\nFalse, if the minimum amount of signatures to sign this transaction has not been reached yet.\nTrue, if the minimum amount of signatures has been reached.\n"
}
},
"example" : {
"senderPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"signSignature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"amount" : "150000000",
"signature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"fee" : "1000000",
"recipientPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"relays" : 5,
"type" : 0,
"confirmations" : 0,
"receivedAt" : "2000-01-23T04:56:07.000+00:00",
"signatures" : [ "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a", "72c9b2aa734ec1b97549718ddf0d4737fd38a7f0fd105ea28486f2d989e9b3e399238d81a93aa45c27309d91ce604a5db9d25c9c90a138821f2011bc6636c60a" ],
"blockId" : "6258354802676165798",
"senderId" : "12668885769632475474L",
"ready" : false,
"recipientId" : "12668885769632475474L",
"id" : "222675625422353767",
"senderSecondPublicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"asset" : "{}",
"height" : 1,
"timestamp" : 28227090
}
},
"Signature" : {
"type" : "object",
"required" : [ "publicKey", "signature", "transactionId" ],
"properties" : {
"transactionId" : {
"type" : "string",
"format" : "id",
"example" : "222675625422353767",
"description" : "Unique identifier of the multisignature transaction to sign.",
"minLength" : 1,
"maxLength" : 20
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "Public key of the account that intends to sign the multisignature transaction."
},
"signature" : {
"type" : "string",
"format" : "signature",
"example" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"description" : "Signature to sign the transaction.\nThe signature can be generated locally, either by using Lisk Commander or with Lisk Elements.\n"
}
},
"example" : {
"signature" : "2821d93a742c4edf5fd960efad41a4def7bf0fd0f7c09869aed524f6f52bf9c97a617095e2c712bd28b4279078a29509b339ac55187854006591aa759784c205",
"publicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"transactionId" : "222675625422353767"
}
},
"Block" : {
"type" : "object",
"required" : [ "generatorPublicKey", "height", "id", "numberOfTransactions", "reward", "timestamp", "totalAmount", "totalFee", "totalForged" ],
"properties" : {
"id" : {
"type" : "string",
"format" : "id",
"example" : "6258354802676165798",
"description" : "Unique identifier of the block.\nDerived from the block signature.\n",
"minLength" : 1,
"maxLength" : 20
},
"version" : {
"type" : "integer",
"example" : 0,
"description" : "Versioning for future upgrades of the lisk protocol.",
"minimum" : 0
},
"height" : {
"type" : "integer",
"example" : 123,
"description" : "Height of the network, when the block got forged.\nThe height of the networks represents the number of blocks,\nthat have been forged on the network since Genesis Block.\n",
"minimum" : 1
},
"timestamp" : {
"type" : "integer",
"example" : 28227090,
"description" : "Unix Timestamp"
},
"generatorAddress" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "Lisk Address of the delegate who forged the block."
},
"generatorPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "Public key of th edelagte who forged the block."
},
"payloadLength" : {
"type" : "integer",
"example" : 117,
"description" : "Bytesize of the payload hash.",
"minimum" : 0
},
"payloadHash" : {
"type" : "string",
"format" : "hex",
"example" : "4e4d91be041e09a2e54bb7dd38f1f2a02ee7432ec9f169ba63cd1f193a733dd2",
"description" : "Hash of the payload of the block.\nThe payload of a block is comprised of the transactions the block contains.\nFor each type of transaction exists a different maximum size for the payload.\n"
},
"blockSignature" : {
"type" : "string",
"format" : "signature",
"example" : "a3733254aad600fa787d6223002278c3400be5e8ed4763ae27f9a15b80e20c22ac9259dc926f4f4cabdf0e4f8cec49308fa8296d71c288f56b9d1e11dfe81e07",
"description" : "Derived from a SHA-256 hash of the block header,\nthat is signed by the private key of the delegate who forged the block.\n"
},
"confirmations" : {
"type" : "integer",
"example" : 200,
"description" : "Number of times that this Block has been confirmed by the network.\nBy forging a new block on a chain, all former blocks in the chain get confirmed by the forging delegate.\n"
},
"previousBlockId" : {
"type" : "string",
"format" : "id",
"example" : "15918760246746894806",
"description" : "The id of the previous block of the chain."
},
"numberOfTransactions" : {
"type" : "integer",
"example" : 15,
"description" : "The number of transactions processed in the block."
},
"totalAmount" : {
"type" : "string",
"example" : "150000000",
"description" : "The total amount of Lisk transferred."
},
"totalFee" : {
"type" : "string",
"example" : "15000000",
"description" : "The total amount of fees associated with the block."
},
"reward" : {
"type" : "string",
"example" : "50000000",
"description" : "The Lisk reward for the delegate."
},
"totalForged" : {
"type" : "string",
"example" : "65000000",
"description" : "Total amount of LSK that have been forged in this Block.\nConsists of fees and the reward.\n"
}
},
"example" : {
"reward" : "50000000",
"payloadLength" : 117,
"generatorPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"payloadHash" : "4e4d91be041e09a2e54bb7dd38f1f2a02ee7432ec9f169ba63cd1f193a733dd2",
"previousBlockId" : "15918760246746894806",
"blockSignature" : "a3733254aad600fa787d6223002278c3400be5e8ed4763ae27f9a15b80e20c22ac9259dc926f4f4cabdf0e4f8cec49308fa8296d71c288f56b9d1e11dfe81e07",
"confirmations" : 200,
"numberOfTransactions" : 15,
"version" : 0,
"generatorAddress" : "12668885769632475474L",
"totalAmount" : "150000000",
"totalForged" : "65000000",
"totalFee" : "15000000",
"id" : "6258354802676165798",
"height" : 123,
"timestamp" : 28227090
}
},
"ReducedBlock" : {
"type" : "object",
"required" : [ "generatorPublicKey", "height", "id", "timestamp" ],
"properties" : {
"id" : {
"type" : "string",
"format" : "id",
"example" : "6258354802676165798",
"minLength" : 1,
"maxLength" : 20
},
"version" : {
"type" : "integer",
"example" : 0,
"minimum" : 0
},
"height" : {
"type" : "integer",
"example" : 123,
"minimum" : 1
},
"timestamp" : {
"type" : "integer",
"example" : 28227090,
"description" : "Unix Timestamp"
},
"generatorAddress" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L"
},
"generatorPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
},
"payloadLength" : {
"type" : "integer",
"example" : 117,
"minimum" : 0
},
"payloadHash" : {
"type" : "string",
"format" : "hex",
"example" : "4e4d91be041e09a2e54bb7dd38f1f2a02ee7432ec9f169ba63cd1f193a733dd2"
},
"blockSignature" : {
"type" : "string",
"format" : "signature",
"example" : "a3733254aad600fa787d6223002278c3400be5e8ed4763ae27f9a15b80e20c22ac9259dc926f4f4cabdf0e4f8cec49308fa8296d71c288f56b9d1e11dfe81e07"
},
"confirmations" : {
"type" : "integer",
"example" : 200
},
"previousBlockId" : {
"type" : "string",
"format" : "id",
"example" : "15918760246746894806"
}
}
},
"CommonBlock" : {
"type" : "object",
"required" : [ "height", "id", "previousBlock" ],
"properties" : {
"id" : {
"type" : "string",
"format" : "id",
"example" : "6258354802676165798",
"minLength" : 1,
"maxLength" : 20
},
"height" : {
"type" : "integer",
"example" : 123,
"minimum" : 1
},
"previousBlock" : {
"type" : "string",
"format" : "id",
"example" : "15918760246746894806"
}
},
"x-private" : true
},
"ForgingStatus" : {
"type" : "object",
"required" : [ "forging", "publicKey" ],
"properties" : {
"forging" : {
"type" : "boolean",
"example" : true,
"description" : "True if the delegate enabled forging."
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "Public key of the queried delegate."
}
},
"example" : {
"forging" : true,
"publicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079"
}
},
"VotersResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/DelegateWithVoters"
},
"meta" : {
"$ref" : "#/definitions/Meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Voters endpoint response",
"example" : {
"data" : {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"voters" : [ {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}, {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
} ],
"votes" : 108877,
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "isabella"
},
"meta" : {
"offset" : { },
"limit" : { }
},
"links" : "{}"
}
},
"VotesResponse" : {
"type" : "object",
"required" : [ "data", "links", "meta" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/DelegateWithVotes"
},
"meta" : {
"$ref" : "#/definitions/DelegatesResponse_meta"
},
"links" : {
"type" : "object",
"properties" : { }
}
},
"description" : "Votes endpoint response",
"example" : {
"data" : {
"votesUsed" : 2,
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"votesAvailable" : 40,
"votes" : [ {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "liskhq"
}, {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "liskhq"
} ],
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "isabella"
},
"meta" : {
"offset" : { },
"limit" : 9
},
"links" : "{}"
}
},
"Forger" : {
"type" : "object",
"required" : [ "address", "nextSlot", "publicKey", "username" ],
"properties" : {
"username" : {
"type" : "string",
"format" : "username",
"example" : "isabella",
"description" : "The delegates' username.\nA delegate chooses the username by registering a delegate on the Lisk network.\nIt is unique and cannot be changed later.\n"
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"description" : "The public key is derived from the private key of the owner of the account.\nIt can be used to validate that the private key belongs to the owner, but not provide access to the owners private key.\n"
},
"address" : {
"type" : "string",
"format" : "address",
"example" : "6251001604903637008L",
"description" : "The Lisk Address is the human readable representation of the accounts owners' public key.\nIt consists of 21 numbers followed by a big 'L' at the end.\n"
},
"nextSlot" : {
"type" : "number",
"example" : 4368793.0,
"description" : "Returns the slot number in which the forger will be able to forge the next block.\nEach slot has a timespan of 10 seconds.\nThe first slot began directly after the Lisk Epoch Time.\n"
}
},
"example" : {
"address" : "6251001604903637008L",
"nextSlot" : 4368793.0,
"publicKey" : "2ca9a7143fc721fdc540fef893b27e8d648d2288efa61e56264edf01a2c23079",
"username" : "isabella"
}
},
"ForgingStats" : {
"type" : "object",
"required" : [ "count", "fees", "forged", "rewards" ],
"properties" : {
"fees" : {
"type" : "string",
"example" : "15000000",
"description" : "Amount of fees, the delegate earned during the timespan."
},
"rewards" : {
"type" : "string",
"example" : "50000000",
"description" : "Amount of rewards, the delegate earned during the timespan."
},
"forged" : {
"type" : "string",
"example" : "65000000",
"description" : "Amount of Lisk, that have been transferred inside the forged blocks of a delegate, during the timespan."
},
"count" : {
"type" : "string",
"example" : "100",
"description" : "Amount of blocks, that the delegate has forged during the timespan."
}
},
"example" : {
"fees" : "15000000",
"forged" : "65000000",
"count" : "100",
"rewards" : "50000000"
}
},
"Dapp" : {
"type" : "object",
"required" : [ "name", "transactionId", "type" ],
"properties" : {
"transactionId" : {
"type" : "string",
"format" : "id",
"example" : "15359945250124697273",
"description" : "Unique Identifier of the Register Dapp Transaction.\nDerived from the transaction signature.\n",
"minLength" : 1,
"maxLength" : 20
},
"icon" : {
"type" : "string",
"example" : "http://www.blocksafefoundation.com/header.jpg",
"description" : "Dapp icon.\nA link to the icon can be provided in the Register Dapp Transaction object.\n"
},
"category" : {
"type" : "number",
"example" : 8.0,
"description" : "The category of the Dapp."
},
"type" : {
"type" : "number",
"example" : 8.0,
"description" : "The type of the Dapp."
},
"link" : {
"type" : "string",
"example" : "https://github.com/blocksafe/SDK-notice/archive/master.zip"
},
"tags" : {
"type" : "string",
"example" : "Smartgun",
"description" : "Tags of the Dapp."
},
"description" : {
"type" : "string",
"example" : "Smart Gun Network",
"description" : "Description of the Dapp."
},
"name" : {
"type" : "string",
"example" : "Blocksafe",
"description" : "Name of the Dapp."
}
},
"example" : {
"icon" : "http://www.blocksafefoundation.com/header.jpg",
"link" : "https://github.com/blocksafe/SDK-notice/archive/master.zip",
"name" : "Blocksafe",
"description" : "Smart Gun Network",
"category" : 8.0,
"type" : 8.0,
"transactionId" : "15359945250124697273",
"tags" : "Smartgun"
}
},
"Peer" : {
"type" : "object",
"required" : [ "state", "wsPort" ],
"properties" : {
"ip" : {
"type" : "string",
"format" : "ip",
"example" : "127.0.0.1",
"description" : "IPv4 address of the peer node."
},
"httpPort" : {
"type" : "integer",
"format" : "int32",
"example" : 8000,
"description" : "The port the peer node uses for HTTP requests, e.g. API calls.",
"minimum" : 1,
"maximum" : 65535
},
"wsPort" : {
"type" : "integer",
"format" : "int32",
"example" : 8001,
"description" : "The port the peer node uses for Websocket Connections, e.g. P2P broadcasts.",
"minimum" : 1,
"maximum" : 65535
},
"os" : {
"type" : "string",
"example" : "debian",
"description" : "The Operating System, that the peer node runs on."
},
"version" : {
"type" : "string",
"format" : "version",
"example" : "v0.8.0",
"description" : "The version of Lisk Core that the peer node runs on."
},
"state" : {
"type" : "integer",
"format" : "int32",
"example" : 2,
"description" : "The state of the Peer.\nAvailable values: Connected, Disconnected, Banned\n",
"minimum" : 0,
"maximum" : 2
},
"height" : {
"type" : "integer",
"example" : 123,
"description" : "Network height on the peer node.\nRepresents the current number of blocks in the chain on the peer node.\n"
},
"broadhash" : {
"type" : "string",
"format" : "hex",
"example" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea",
"description" : "Broadhash on the peer node.\nBroadhash is established as an aggregated rolling hash of the past five blocks present in the database.\n"
},
"nonce" : {
"type" : "string",
"example" : "sYHEDBKcScaAAAYg",
"description" : "Unique Identifier for the peer.\nRandom string.\n",
"minLength" : 1
}
},
"example" : {
"os" : "debian",
"broadhash" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea",
"httpPort" : 8000,
"wsPort" : 8001,
"ip" : "127.0.0.1",
"state" : 2,
"version" : "v0.8.0",
"nonce" : "sYHEDBKcScaAAAYg",
"height" : 123
}
},
"PeersList" : {
"type" : "object",
"required" : [ "peers" ],
"properties" : {
"peers" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Peer"
}
}
},
"x-private" : true
},
"Fees" : {
"type" : "object",
"required" : [ "dappDeposit", "dappRegistration", "dappWithdrawal", "delegate", "multisignature", "secondSignature", "send", "vote" ],
"properties" : {
"send" : {
"type" : "string",
"example" : "10000000"
},
"vote" : {
"type" : "string",
"example" : "100000000"
},
"secondSignature" : {
"type" : "string",
"example" : "500000000"
},
"delegate" : {
"type" : "string",
"example" : "2500000000"
},
"multisignature" : {
"type" : "string",
"example" : "500000000"
},
"dappRegistration" : {
"type" : "string",
"example" : "2500000000"
},
"dappWithdrawal" : {
"type" : "string",
"example" : "10000000"
},
"dappDeposit" : {
"type" : "string",
"example" : "10000000"
}
},
"example" : {
"delegate" : "2500000000",
"secondSignature" : "500000000",
"dappDeposit" : "10000000",
"send" : "10000000",
"vote" : "100000000",
"dappWithdrawal" : "10000000",
"dappRegistration" : "2500000000",
"multisignature" : "500000000"
}
},
"NodeConstants" : {
"type" : "object",
"required" : [ "build", "commit", "epoch", "fees", "milestone", "nethash", "nonce", "reward", "supply", "version" ],
"properties" : {
"epoch" : {
"type" : "string",
"format" : "date-time",
"example" : "2016-05-24T17:00:00.000Z",
"description" : "Timestamp of first block on the network."
},
"milestone" : {
"type" : "string",
"example" : "500000000",
"description" : "The Reward, each forger will get for forging a block at the current slot.\nAfter a certain amount of slots, the reward will be reduced.\n"
},
"build" : {
"type" : "string",
"example" : "v09:54:35 12/04/2017",
"description" : "The build number.\nConsists of `v` + the date and time of the build of the node.\n"
},
"commit" : {
"type" : "string",
"example" : "7199d4b67c3575d5f99d1c29436a02977eeb01a7",
"description" : "The last commit that was added to the codebase.",
"minLength" : 40,
"maxLength" : 40
},
"version" : {
"type" : "string",
"format" : "version",
"example" : "v0.8.0",
"description" : "The Lisk Core version, that the node is running on."
},
"nethash" : {
"type" : "string",
"example" : "ed14889723f24ecc54871d058d98ce91ff2f973192075c0155ba2b7b70ad2511",
"description" : "Describes the network.\nThe nethash describes e.g. the Mainnet or the Testnet, that the node is connecting to.\n"
},
"supply" : {
"type" : "string",
"example" : "10575384500000000",
"description" : "Total supply of LSK in the network."
},
"reward" : {
"type" : "string",
"example" : "500000000",
"description" : "The reward a delegate will get for forging a block.\nDepends on the slot height.\n"
},
"nonce" : {
"type" : "string",
"example" : "cJmXK66xxz644d67",
"description" : "Unique identifier of the node.\nRandom string.\n",
"minLength" : 16,
"maxLength" : 16
},
"fees" : {
"$ref" : "#/definitions/Fees"
}
},
"example" : {
"reward" : "500000000",
"nethash" : "ed14889723f24ecc54871d058d98ce91ff2f973192075c0155ba2b7b70ad2511",
"fees" : {
"delegate" : "2500000000",
"secondSignature" : "500000000",
"dappDeposit" : "10000000",
"send" : "10000000",
"vote" : "100000000",
"dappWithdrawal" : "10000000",
"dappRegistration" : "2500000000",
"multisignature" : "500000000"
},
"milestone" : "500000000",
"build" : "v09:54:35 12/04/2017",
"commit" : "7199d4b67c3575d5f99d1c29436a02977eeb01a7",
"epoch" : "2016-05-24T17:00:00.000Z",
"version" : "v0.8.0",
"supply" : "10575384500000000",
"nonce" : "cJmXK66xxz644d67"
}
},
"NodeStatus" : {
"type" : "object",
"required" : [ "broadhash", "consensus", "height", "loaded", "networkHeight", "syncing", "transactions" ],
"properties" : {
"broadhash" : {
"type" : "string",
"example" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea",
"description" : "Broadhash is established as an aggregated rolling hash of the past five blocks present in the database.\nBroadhash consensus serves a vital function for the Lisk network in order to prevent forks.\nIt ensures that a majority of available peers agree that it is acceptable to forge.\n",
"minLength" : 64,
"maxLength" : 64
},
"consensus" : {
"type" : "integer",
"example" : 95,
"description" : "Percentage of the connected peers, that have the same broadhash as the querying node.",
"minimum" : 0,
"maximum" : 100.0
},
"height" : {
"type" : "integer",
"example" : 123,
"description" : "Current block height of the node.\nRepresents the current number of blocks in the chain on the node.\n",
"minimum" : 1
},
"loaded" : {
"type" : "boolean",
"example" : true,
"description" : "True if the blockchain loaded."
},
"networkHeight" : {
"type" : "integer",
"example" : 123,
"description" : "Current block height of the network.\nRepresents the current number of blocks in the chain on the network.\n"
},
"syncing" : {
"type" : "boolean",
"example" : false,
"description" : "True if the node syncing with other peers."
},
"transactions" : {
"$ref" : "#/definitions/NodeStatus_transactions"
}
},
"example" : {
"consensus" : 95,
"loaded" : true,
"broadhash" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea",
"networkHeight" : 123,
"syncing" : false,
"transactions" : {
"unconfirmed" : 5,
"total" : 15,
"unprocessed" : 3,
"unsigned" : 2,
"confirmed" : 5
},
"height" : 123
}
},
"ProcessingError" : {
"type" : "object",
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Error message containing details of the error",
"minLength" : 1
}
}
},
"NotFoundError" : {
"type" : "object",
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Error message containing details of the error",
"minLength" : 1
}
}
},
"AccessDeniedError" : {
"type" : "object",
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Error message containing details of the error",
"minLength" : 1
}
}
},
"UnexpectedError" : {
"type" : "object",
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "Error message containing details of the error",
"minLength" : 1
}
}
},
"RequestLimitError" : {
"type" : "object",
"properties" : {
"error" : {
"type" : "string",
"example" : "Request limit exceeded. Please try again later"
}
}
},
"ParamErrorResponse" : {
"type" : "object",
"required" : [ "errors", "message" ],
"properties" : {
"message" : {
"type" : "string",
"example" : "Validation errors",
"description" : "Message stating some valdiation error occurred"
},
"errors" : {
"type" : "array",
"description" : "Array of individual parameter errors",
"items" : {
"$ref" : "#/definitions/ParamError"
}
}
},
"description" : "Response generated in case of parameters validation"
},
"ParamError" : {
"type" : "object",
"required" : [ "code", "message", "name" ],
"properties" : {
"code" : {
"type" : "string",
"example" : "INVALID_REQUEST_PARAMETER",
"description" : "Valid error code explaining error"
},
"name" : {
"type" : "string",
"example" : "offset",
"description" : "Parameter name for which error triggered"
},
"in" : {
"type" : "string",
"example" : "query",
"description" : "Where the param was specified, e.g. path, query, form-data"
},
"message" : {
"type" : "string",
"example" : "Invalid parameter (offset) value failed JSON schema validation",
"description" : "Detailed message explaining the error"
},
"errors" : {
"type" : "array",
"description" : "Array of individual validation error for a particular param",
"items" : {
"$ref" : "#/definitions/ParamErrorMessage"
}
}
},
"description" : "Collection of errors on a particular parameter"
},
"ParamErrorMessage" : {
"type" : "object",
"required" : [ "message" ],
"properties" : {
"code" : {
"type" : "string",
"example" : "MINIMUM",
"description" : "Valid error code explaining error"
},
"message" : {
"type" : "string",
"example" : "Value -1 is less than minimum 0",
"description" : "Detailed message explaining error"
},
"description" : {
"type" : "string",
"description" : "Param description specified in schema"
},
"path" : {
"type" : "array",
"description" : "The array/object paths which identify the param associated with the error",
"items" : {
"type" : "string",
"example" : "publicKey"
}
}
},
"description" : "Singular error detail for a parameter"
},
"Account" : {
"type" : "object",
"required" : [ "address", "publicKey" ],
"properties" : {
"address" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "The Lisk Address is the human readable representation of the accounts owners' public key.\nIt consists of multiple numbers followed by a big 'L' at the end.\n"
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "The public key is derived from the private key of the owner of the account.\nIt can be used to validate that the private key belongs to the owner, but not provide access to the owners private key.\n"
},
"secondPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "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" : {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}
},
"AccountExtended" : {
"type" : "object",
"required" : [ "address", "balance", "publicKey", "unconfirmedBalance" ],
"properties" : {
"address" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "The Lisk Address is the human readable representation of the accounts owners' public key.\nIt consists of 21 numbers followed by a big 'L' at the end.\n"
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "The public key is derived from the private key of the owner of the account.\nIt can be used to validate that the private key belongs to the owner, but does not provide access to the owners private key.\n"
},
"balance" : {
"type" : "string",
"example" : "1081560729258",
"description" : "The current balance of the account in Beddows."
},
"unconfirmedBalance" : {
"type" : "string",
"example" : "0",
"description" : "The current unconfirmed balance of the account in Beddows.\nIncludes unconfirmed transactions.\n"
},
"secondPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "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."
},
"delegate" : {
"$ref" : "#/definitions/Delegate"
}
},
"example" : {
"unconfirmedBalance" : "0",
"delegate" : {
"productivity" : 96.41,
"missedBlocks" : 427,
"approval" : 14.22,
"rank" : 70,
"producedBlocks" : 20131,
"vote" : "1081560729258",
"rewards" : "510000000",
"username" : "isabella"
},
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}
},
"MultisignatureGroup" : {
"type" : "object",
"required" : [ "address", "balance", "lifetime", "members", "min", "publicKey", "unconfirmedBalance" ],
"properties" : {
"address" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "The Lisk Address is the human readable representation of the accounts owners' public key.\nIt consists of 21 numbers followed by a big 'L' at the end.\n"
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "The public key is derived from the private key of the owner of the account.\nIt can be used to validate that the private key belongs to the owner, but not provide access to the owners private key.\n"
},
"balance" : {
"type" : "string",
"example" : "1081560729258",
"description" : "The current balance of the account in Beddows."
},
"unconfirmedBalance" : {
"type" : "string",
"example" : "0",
"description" : "The current unconfirmed balance of the account in Beddows.\nIncludes unconfirmed transactions.\n"
},
"secondPublicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "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."
},
"min" : {
"type" : "integer",
"example" : 3,
"description" : "Minimum amount of signatures a transaction needs to be signed successfully by this multisignature account."
},
"lifetime" : {
"type" : "integer",
"example" : 72,
"description" : "The maximum amount of hours, that a transaction will wait for the minimum amount of signatures to be reached.\nIf not enough members of a multisignature group sign the transaction in the defined lifespan, the transaction will be invalid.\n"
},
"members" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Account"
}
}
},
"example" : {
"unconfirmedBalance" : "0",
"address" : "12668885769632475474L",
"min" : 3,
"balance" : "1081560729258",
"members" : [ {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}, {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
} ],
"lifetime" : 72,
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}
},
"Delegate" : {
"type" : "object",
"required" : [ "username", "vote" ],
"properties" : {
"username" : {
"type" : "string",
"format" : "username",
"example" : "isabella",
"description" : "The delegates' username.\nA delegate chooses the username by registering a delegate on the Lisk network.\nIt is unique and cannot be changed later.\n"
},
"vote" : {
"type" : "string",
"example" : "1081560729258",
"description" : "The voters weight of the delegate.\nRepresents the total amount of Lisk (in Beddows) that the delegates' voters own.\nThe voters weight decides which rank the delegate gets in relation to the other delegates and their voters weights.\n"
},
"rewards" : {
"type" : "string",
"example" : "510000000",
"description" : "Total sum of block rewards that the delegate has forged."
},
"producedBlocks" : {
"type" : "integer",
"example" : 20131,
"description" : "Total number of blocks the delegate has forged."
},
"missedBlocks" : {
"type" : "integer",
"example" : 427,
"description" : "Total number of blocks the delegate has missed."
},
"approval" : {
"type" : "number",
"example" : 14.22,
"description" : "Percentage of the voters weight, that the delegate owns in relation to the total supply of Lisk."
},
"productivity" : {
"type" : "number",
"example" : 96.41,
"description" : "Productivity rate.\nPercentage of successfully forged blocks (not missed) by the delegate.\n"
},
"rank" : {
"type" : "integer",
"example" : 70,
"description" : "Rank of the delegate.\nThe rank is defined by the voters weight/ approval of a delegates, in relation to all other delegates.\n"
}
},
"example" : {
"productivity" : 96.41,
"missedBlocks" : 427,
"approval" : 14.22,
"rank" : 70,
"producedBlocks" : 20131,
"vote" : "1081560729258",
"rewards" : "510000000",
"username" : "isabella"
}
},
"DelegateWithAccount" : {
"type" : "object",
"required" : [ "account", "username", "vote" ],
"properties" : {
"username" : {
"type" : "string",
"format" : "username",
"example" : "isabella",
"description" : "The delegates' username.\nA delegate chooses the username by registering a delegate on the Lisk network.\nIt is unique and cannot be changed later.\n"
},
"vote" : {
"type" : "string",
"example" : "1081560729258",
"description" : "The voters weight of the delegate.\nRepresents the total amount of Lisk (in Beddows) that the delegates' voters own.\nThe voters weight decides which rank the delegate gets in relation to the other delegates and their voters weights.\n"
},
"rewards" : {
"type" : "string",
"example" : "510000000",
"description" : "Total sum of block rewards that the delegate has forged."
},
"producedBlocks" : {
"type" : "integer",
"example" : 20131,
"description" : "Total number of blocks the delegate has forged."
},
"missedBlocks" : {
"type" : "integer",
"example" : 427,
"description" : "Total number of blocks the delegate has missed."
},
"approval" : {
"type" : "number",
"example" : 14.22,
"description" : "Percentage of the voters weight, that the delegate owns in relation to the total supply of Lisk."
},
"productivity" : {
"type" : "number",
"example" : 96.41,
"description" : "Productivity rate.\nPercentage of successfully forged blocks (not missed) by the delegate.\n"
},
"rank" : {
"type" : "integer",
"example" : 70,
"description" : "Rank of the delegate.\nThe rank is defined by the voters weight/ approval of a delegates, in relation to all other delegates.\n"
},
"account" : {
"$ref" : "#/definitions/Account"
}
},
"example" : {
"productivity" : 96.41,
"missedBlocks" : 427,
"approval" : 14.22,
"rank" : 70,
"producedBlocks" : 20131,
"vote" : "1081560729258",
"rewards" : "510000000",
"account" : {
"address" : "12668885769632475474L",
"secondPublicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
},
"username" : "isabella"
}
},
"DelegateWithVoters" : {
"type" : "object",
"required" : [ "address", "balance", "username", "voters", "votes" ],
"properties" : {
"username" : {
"type" : "string",
"format" : "username",
"example" : "isabella",
"description" : "The delegates' username.\nA delegate chooses the username by registering a delegate on the Lisk network.\nIt is unique and cannot be changed later.\n"
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "The public key of the delegate."
},
"votes" : {
"type" : "integer",
"example" : 108877,
"description" : "The voters weight of the delegate.\nRepresents the total amount of Lisk (in Beddows) that the delegates' voters own.\nThe voters weight decides which rank the delegate gets in relation to the other delegates and their voters weights.\n"
},
"address" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "The Lisk Address of a delegate."
},
"balance" : {
"type" : "string",
"example" : "1081560729258",
"description" : "Account balance.\nAmount of Lisk the delegate account owns.\n"
},
"voters" : {
"type" : "array",
"description" : "List of accounts that voted for the queried delegate.",
"items" : {
"$ref" : "#/definitions/Voter"
}
}
},
"example" : {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"voters" : [ {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}, {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
} ],
"votes" : 108877,
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "isabella"
}
},
"Voter" : {
"type" : "object",
"required" : [ "address", "balance", "publicKey" ],
"properties" : {
"address" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "The Lisk Address of the account that voted for the queried delegate."
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "Public key of the account that voted for the queried delegate."
},
"balance" : {
"type" : "string",
"example" : "1081560729258",
"description" : "Balance of the account that voted for the queried delegate."
}
},
"example" : {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b"
}
},
"DelegateWithVotes" : {
"type" : "object",
"required" : [ "address", "balance", "username", "votes", "votesAvailable", "votesUsed" ],
"properties" : {
"address" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "The Lisk Address of the queried account."
},
"balance" : {
"type" : "string",
"example" : "1081560729258",
"description" : "The balance of the queried account."
},
"username" : {
"type" : "string",
"format" : "username",
"example" : "isabella",
"description" : "Username of the account, if the queried account is a delegate"
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "Public key of the queried account."
},
"votesUsed" : {
"type" : "integer",
"example" : 2,
"description" : "Number of votes that are already placed by the queried account."
},
"votesAvailable" : {
"type" : "integer",
"example" : 40,
"description" : "Number of votes that are available for the queried account.\nDerives from 101(max possible votes) - votesUsed(alreadu used votes)\n"
},
"votes" : {
"type" : "array",
"description" : "List of placed votes by the queried account.",
"items" : {
"$ref" : "#/definitions/Vote"
}
}
},
"example" : {
"votesUsed" : 2,
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"votesAvailable" : 40,
"votes" : [ {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "liskhq"
}, {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "liskhq"
} ],
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "isabella"
}
},
"Vote" : {
"type" : "object",
"required" : [ "address", "balance", "publicKey", "username" ],
"properties" : {
"address" : {
"type" : "string",
"format" : "address",
"example" : "12668885769632475474L",
"description" : "Lisk Address of the delegate the queried account voted for."
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "Public key of the delegate the queried account voted for."
},
"balance" : {
"type" : "string",
"example" : "1081560729258",
"description" : "Balance of the delegate the queried account voted for."
},
"username" : {
"type" : "string",
"format" : "username",
"example" : "liskhq",
"description" : "Username of the delegate the queried account voted for."
}
},
"example" : {
"address" : "12668885769632475474L",
"balance" : "1081560729258",
"publicKey" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"username" : "liskhq"
}
},
"WSPeerHeaders" : {
"type" : "object",
"required" : [ "httpPort", "nethash", "nonce", "version", "wsPort" ],
"properties" : {
"httpPort" : {
"type" : "integer",
"format" : "int32",
"example" : 8000,
"minimum" : 1,
"maximum" : 65535
},
"wsPort" : {
"type" : "integer",
"format" : "int32",
"example" : 8001,
"minimum" : 1,
"maximum" : 65535
},
"os" : {
"type" : "string",
"example" : "debian"
},
"version" : {
"type" : "string",
"format" : "version",
"example" : "v0.8.0"
},
"height" : {
"type" : "integer",
"example" : 123
},
"nethash" : {
"type" : "string",
"maxLength" : 64
},
"broadhash" : {
"type" : "string",
"format" : "hex",
"example" : "258974416d58533227c6a3da1b6333f0541b06c65b41e45cf31926847a3db1ea"
},
"nonce" : {
"type" : "string",
"example" : "sYHEDBKcScaAAAYg",
"minLength" : 16,
"maxLength" : 16
}
},
"x-private" : true
},
"WSPeerUpdateRequest" : {
"type" : "object",
"required" : [ "data", "socketId" ],
"properties" : {
"data" : {
"$ref" : "#/definitions/WSPeerUpdateRequest_data"
},
"socketId" : {
"type" : "string"
}
},
"x-private" : true
},
"WSSignaturesList" : {
"type" : "object",
"required" : [ "nonce", "signatures" ],
"properties" : {
"nonce" : {
"type" : "string",
"example" : "sYHEDBKcScaAAAYg",
"minLength" : 16,
"maxLength" : 16
},
"signatures" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
},
"maxItems" : 25,
"minItems" : 1
}
},
"x-private" : true
},
"WSBlocksList" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
},
"x-private" : true
},
"WSBlocksCommonRequest" : {
"type" : "object",
"required" : [ "ids" ],
"properties" : {
"ids" : {
"type" : "string",
"format" : "csv"
}
},
"x-private" : true
},
"WSTransactionsRequest" : {
"type" : "object",
"required" : [ "nonce", "transactions" ],
"properties" : {
"nonce" : {
"type" : "string",
"example" : "sYHEDBKcScaAAAYg",
"minLength" : 16,
"maxLength" : 16
},
"transactions" : {
"type" : "array",
"items" : {
"type" : "object",
"properties" : { }
},
"maxItems" : 25,
"minItems" : 1
}
},
"x-private" : true
},
"WSAccessObject" : {
"type" : "object",
"required" : [ "authKey", "peer", "updateType" ],
"properties" : {
"peer" : {
"$ref" : "#/definitions/Peer"
},
"authKey" : {
"type" : "string"
},
"updateType" : {
"type" : "integer",
"minimum" : 0,
"maximum" : 1
}
},
"x-private" : true
},
"WSTransactionsResponse" : {
"type" : "object",
"required" : [ "transactions" ],
"properties" : {
"transactions" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "object",
"properties" : { }
},
"maxItems" : 100
}
},
"x-private" : true
},
"WSSignaturesResponse" : {
"required" : [ "signatures" ],
"properties" : {
"signatures" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "object",
"properties" : { }
},
"maxItems" : 100
}
},
"x-private" : true
},
"WSBlocksBroadcast" : {
"type" : "object",
"required" : [ "block", "nonce" ],
"properties" : {
"nonce" : {
"type" : "string",
"example" : "sYHEDBKcScaAAAYg",
"minLength" : 16,
"maxLength" : 16
},
"block" : {
"$ref" : "#/definitions/ReducedBlock"
}
},
"x-private" : true
},
"data" : {
"type" : "object",
"required" : [ "forging", "password", "publicKey" ],
"properties" : {
"forging" : {
"type" : "boolean",
"example" : true,
"description" : "Forging status of the delegate"
},
"password" : {
"type" : "string",
"example" : "happy tree friends",
"description" : "Password for decrypting passphrase of delegate.",
"minLength" : 5
},
"publicKey" : {
"type" : "string",
"format" : "publicKey",
"example" : "968ba2fa993ea9dc27ed740da0daf49eddd740dbd7cb1cb4fc5db3a20baf341b",
"description" : "Public key of the delegate."
}
}
},
"PeersResponse_meta" : {
"required" : [ "count", "limit", "offset" ],
"properties" : {
"offset" : {
"$ref" : "#/definitions/Offset"
},
"limit" : {
"$ref" : "#/definitions/Limit"
},
"count" : {
"type" : "integer",
"example" : 100,
"description" : "Number of peers in the response"
}
},
"example" : {
"offset" : { },
"limit" : { },
"count" : 100
}
},
"DelegatesResponse_meta" : {
"required" : [ "limit", "offset" ],
"properties" : {
"offset" : {
"$ref" : "#/definitions/Offset"
},
"limit" : {
"type" : "integer",
"format" : "int32",
"minimum" : 1,
"maximum" : 101,
"default" : 10
}
},
"example" : {
"offset" : { },
"limit" : 9
}
},
"ForgersResponse_meta" : {
"required" : [ "currentSlot", "lastBlock", "lastBlockSlot", "limit", "offset" ],
"properties" : {
"offset" : {
"$ref" : "#/definitions/Offset"
},
"limit" : {
"type" : "integer",
"format" : "int32",
"minimum" : 1,
"maximum" : 101,
"default" : 10
},
"currentSlot" : {
"type" : "integer",
"example" : 10,
"description" : "Currently active slot"
},
"lastBlockSlot" : {
"type" : "integer",
"example" : 10,
"description" : "Slot of the last processed block"
},
"lastBlock" : {
"type" : "integer",
"example" : 10,
"description" : "ID of the last processed block"
}
},
"example" : {
"currentSlot" : 10,
"lastBlock" : 10,
"offset" : { },
"limit" : 9,
"lastBlockSlot" : 10
}
},
"ForgingStatsResponse_meta" : {
"required" : [ "fromTimestamp", "toTimestamp" ],
"properties" : {
"fromTimestamp" : {
"type" : "integer",
"example" : 0,
"description" : "Starting unix timestamp"
},
"toTimestamp" : {
"type" : "integer",
"example" : 1525861914,
"description" : "Ending unix timestamp"
}
},
"example" : {
"fromTimestamp" : 0,
"toTimestamp" : 1525861914
}
},
"SignatureResponse_data" : {
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string",
"minLength" : 1
}
},
"example" : {
"message" : "message"
}
},
"SignatureResponse_meta" : {
"required" : [ "status" ],
"properties" : {
"status" : {
"type" : "boolean",
"example" : true,
"description" : "Acceptance status for the signature"
}
},
"example" : {
"status" : true
}
},
"TransactionsResponse_meta" : {
"required" : [ "count", "limit", "offset" ],
"properties" : {
"offset" : {
"$ref" : "#/definitions/Offset"
},
"limit" : {
"$ref" : "#/definitions/Limit"
},
"count" : {
"type" : "integer",
"example" : 100,
"description" : "Number of transactions in the response"
}
},
"example" : {
"offset" : { },
"limit" : { },
"count" : 100
}
},
"GeneralStatusResponse_meta" : {
"required" : [ "status" ],
"properties" : {
"status" : {
"type" : "boolean",
"example" : true,
"description" : "Acceptance status for transactions"
}
},
"example" : {
"status" : true
}
},
"NodeStatus_transactions" : {
"required" : [ "confirmed", "total", "unconfirmed", "unprocessed", "unsigned" ],
"properties" : {
"unconfirmed" : {
"type" : "integer",
"example" : 5,
"description" : "Number of unconfirmed Transactions known to the node."
},
"unsigned" : {
"type" : "integer",
"example" : 2,
"description" : "Number of unsigned Transactions known to the node."
},
"unprocessed" : {
"type" : "integer",
"example" : 3,
"description" : "Number of unprocessed Transactions known to the node."
},
"confirmed" : {
"type" : "integer",
"example" : 5,
"description" : "Number of confirmed Transactions known to the node."
},
"total" : {
"type" : "integer",
"example" : 15,
"description" : "Number of total Transactions known to the node."
}
},
"description" : "Transactions known to the node.",
"example" : {
"unconfirmed" : 5,
"total" : 15,
"unprocessed" : 3,
"unsigned" : 2,
"confirmed" : 5
}
},
"WSPeerUpdateRequest_data" : {
"required" : [ "nonce" ],
"properties" : {
"nethash" : {
"type" : "string",
"maxLength" : 64
},
"broadhash" : {
"type" : "string",
"format" : "hex"
},
"height" : {
"type" : "integer",
"minimum" : 1
},
"nonce" : {
"type" : "string",
"minLength" : 16,
"maxLength" : 16
}
}
}
},
"parameters" : {
"ip" : {
"name" : "ip",
"in" : "query",
"description" : "IP of the node or delegate",
"required" : false,
"type" : "string",
"format" : "ip"
},
"httpPort" : {
"name" : "httpPort",
"in" : "query",
"description" : "Http port of the node or delegate",
"required" : false,
"type" : "integer",
"maximum" : 65535,
"minimum" : 1,
"format" : "int32"
},
"wsPort" : {
"name" : "wsPort",
"in" : "query",
"description" : "Web socket port for the node or delegate",
"required" : false,
"type" : "integer",
"maximum" : 65535,
"minimum" : 1,
"format" : "int32"
},
"os" : {
"name" : "os",
"in" : "query",
"description" : "OS of the node",
"required" : false,
"type" : "string"
},
"version" : {
"name" : "version",
"in" : "query",
"description" : "Lisk version of the node",
"required" : false,
"type" : "string",
"format" : "version"
},
"state" : {
"name" : "state",
"in" : "query",
"description" : "Current state of the network",
"required" : false,
"type" : "integer",
"maximum" : 2,
"minimum" : 0,
"format" : "int32"
},
"height" : {
"name" : "height",
"in" : "query",
"description" : "Current height of the network",
"required" : false,
"type" : "integer",
"minimum" : 1,
"format" : "int32"
},
"broadhash" : {
"name" : "broadhash",
"in" : "query",
"description" : "Broadhash of the network",
"required" : false,
"type" : "string",
"format" : "hex"
},
"limit" : {
"name" : "limit",
"in" : "query",
"description" : "Limit applied to results",
"required" : false,
"type" : "integer",
"default" : 10,
"maximum" : 100.0,
"minimum" : 1,
"format" : "int32"
},
"offset" : {
"name" : "offset",
"in" : "query",
"description" : "Offset value for results",
"required" : false,
"type" : "integer",
"default" : 0,
"minimum" : 0,
"format" : "int32"
},
"address" : {
"name" : "address",
"in" : "query",
"description" : "Address of an account",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 2,
"format" : "address"
},
"publicKey" : {
"name" : "publicKey",
"in" : "query",
"description" : "Public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
},
"secondPublicKey" : {
"name" : "secondPublicKey",
"in" : "query",
"description" : "Second public key to query",
"required" : false,
"type" : "string",
"format" : "publicKey"
},
"username" : {
"name" : "username",
"in" : "query",
"description" : "Delegate username to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "username"
},
"blockId" : {
"name" : "blockId",
"in" : "query",
"description" : "Block id to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "id"
},
"transactionId" : {
"name" : "id",
"in" : "query",
"description" : "Transaction id to query",
"required" : false,
"type" : "string",
"maxLength" : 20,
"minLength" : 1,
"format" : "id"
},
"recipientId" : {
"name" : "recipientId",
"in" : "query",
"description" : "Recipient lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
},
"recipientPublicKey" : {
"name" : "recipientPublicKey",
"in" : "query",
"description" : "Recipient public key",
"required" : false,
"type" : "string",
"minLength" : 1,
"format" : "publicKey"
},
"senderId" : {
"name" : "senderId",
"in" : "query",
"description" : "Sender lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
},
"senderPublicKey" : {
"name" : "senderPublicKey",
"in" : "query",
"description" : "Sender public key",
"required" : false,
"type" : "string",
"minLength" : 1,
"format" : "publicKey"
},
"senderIdOrRecipientId" : {
"name" : "senderIdOrRecipientId",
"in" : "query",
"description" : "Lisk address",
"required" : false,
"type" : "string",
"maxLength" : 22,
"minLength" : 1,
"format" : "address"
},
"transactionType" : {
"name" : "type",
"in" : "query",
"description" : "Transaction type (0-7)",
"required" : false,
"type" : "integer",
"maximum" : 7,
"minimum" : 0
},
"minAmount" : {
"name" : "minAmount",
"in" : "query",
"description" : "Minimum transaction amount in Beddows",
"required" : false,
"type" : "integer",
"minimum" : 0
},
"maxAmount" : {
"name" : "maxAmount",
"in" : "query",
"description" : "Maximum transaction amount in Beddows",
"required" : false,
"type" : "integer",
"minimum" : 0
},
"fromTimestamp" : {
"name" : "fromTimestamp",
"in" : "query",
"description" : "Starting unix timestamp",
"required" : false,
"type" : "integer",
"minimum" : 0
},
"toTimestamp" : {
"name" : "toTimestamp",
"in" : "query",
"description" : "Ending unix timestamp",
"required" : false,
"type" : "integer",
"minimum" : 1
}
}
}以上是关于json lisk-的OpenAPI的主要内容，如果未能解决你的问题，请参考以下文章