ASCH HTTP API文档

Asch

1 API使用说明

1.1 请求过程说明

1.1 构造请求数据，用户数据按照Asch提供的接口规则，通过程序生成签名，生成请求数据集合；
1.2 发送请求数据，把构造完成的数据集合通过POST/GET等提交的方式传递给Asch；
1.3 Asch对请求数据进行处理，服务器在接收到请求后，会首先进行安全校验，验证通过后便会处理该次发送过来的请求；
1.4 返回响应结果数据，Asch把响应结果以JSON的格式反馈给用户，每个响应都包含success字段，表示请求是否成功，成功为true, 失败为false。 如果失败，则还会包含一个error字段，表示错误原因；
1.5 对获取的返回结果数据进行处理；

2 接口

2.1 账户accounts

2.1.1 登录

2.1.1.1 本地加密后再登陆（推荐使用）

接口地址：/api/accounts/open2/
请求方式：post
支持格式：json
接口备注：根据用户密码在本地客户端用js代码生成公钥

请求参数说明：

返回参数说明：

请求示例：

var secret = 'Asch账户密码'  //在浏览器内存中保留
var AschJS = require('asch-js');  //asch-js具体安装方法见附录 
var publicKey = AschJS.crypto.getKeys(secret).publicKey;  //根据密码生成公钥 
// var address = AschJS.crypto.getAddress(publicKey);   //根据公钥生成地址
// 将上面生成的数据通过post提交到asch server   
curl -X POST -H "Content-Type: application/json" -k -d '{"publicKey":"bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9"}' http://45.32.248.33:4096/api/accounts/open2/   

JSON返回示例：

{   
    "success": true,   
    "account": {   
        "address": "16723473400748954103",  //asch地址   
        "unconfirmedBalance": 19480000000,  //未确认和已确认的余额之和，该值大于等于balance   
        "balance": 19480000000, //余额   
        "publicKey": "bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9",    //公钥   
        "unconfirmedSignature": false,   
        "secondSignature": true,    //二级签名   
        "secondPublicKey": "edf30942beb74de5ed6368c792af8665e9636f32a5f1c9377bcdc3b252d3f277",  //二级密码公钥   
        "multisignatures": [],    
        "u_multisignatures": [],   
        "lockHeight: ": 0 // 锁仓高度    
    },   
    "latestBlock": {   
        "height": 114480,   //当前节点最新区块高度     
        "timestamp": 4471890   
    },   
    "version": {   
        "version": "1.0.0",   //当前节点版本号    
        "build": "12:11:11 16/08/2016", //构建日期   
        "net": "testnet"    //区块链类型，是主链还是测试链   
    }   
}   

2.1.1.2 本地不加密直接登陆

接口地址：/api/accounts/open/
请求方式：post
支持格式：json
接口备注：将密码传入到server端，根据生成的地址去查询账户信息。不推荐在公网坏境使用！
请求参数说明：

返回参数说明：

请求示例：

curl -X POST -H "Content-Type: application/json" -k -d '{"secret":"fault still attack alley expand music basket purse later educate follow ride"}' http://45.32.248.33:4096/api/accounts/open/   

JSON返回示例：

{   
    "success": true,    
    "account": {   
        "address": "16723473400748954103",    
        "unconfirmedBalance": 19480000000,    
        "balance": 19480000000,    
        "publicKey": "bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9",    
        "unconfirmedSignature": false,    
        "secondSignature": true,    
        "secondPublicKey": "edf30942beb74de5ed6368c792af8665e9636f32a5f1c9377bcdc3b252d3f277",    
        "multisignatures": [ ],    
        "u_multisignatures": [ ]   
    }   
}   

2.1.2 根据地址获取账户信息

接口地址：/api/accounts
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET http://45.32.248.33:4096/api/accounts?address=16723473400748954103   

JSON返回示例：

{   
    "success": true,   
    "account": {   
        "address": "16723473400748954103",  //asch地址   
        "unconfirmedBalance": 19480000000,  //未确认和已确认的余额之和，该值大于等于balance   
        "balance": 19480000000, //余额   
        "publicKey": "bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9",    //公钥   
        "unconfirmedSignature": false,   
        "secondSignature": true,    //二级签名   
        "secondPublicKey": "edf30942beb74de5ed6368c792af8665e9636f32a5f1c9377bcdc3b252d3f277",  //二级密码公钥   
        "multisignatures": [],    
        "u_multisignatures": [],   
        "lockHeight: ": 0 // 锁仓高度    
    },   
    "latestBlock": {   
        "height": 114480,   //当前节点最新区块高度     
        "timestamp": 4471890   
    },   
    "version": {   
        "version": "1.0.0",   //当前节点版本号    
        "build": "12:11:11 16/08/2016", //构建日期   
        "net": "testnet"    //区块链类型，是主链还是测试链   
    }   
}   

2.1.3 获取账户余额

接口地址：/api/accounts/getBalance
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/accounts/getBalance?address=14636456069025293113'   

JSON返回示例：

{   
    "success": true,   
    "balance": 5281328514990,   
    "unconfirmedBalance": 5281328514990   
}   

2.1.4 根据地址获取账户公钥

接口地址：/api/accounts/getPublickey
请求方式：get
支持格式：urlencoded
请求参数说明：只有给别人转过账，db中才会存取公钥，否则是查不到的。btc也是这样

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/accounts/getPublickey?address=14636456069025293113'   

JSON返回示例：

{   
    "success": true,   
    "publicKey": "ae256559d06409435c04bd62628b3e7ea3894c43298556f52b1cfb01fb3e3dc7"   
}   

2.1.5 生成公钥

接口地址：/api/accounts/generatePublickey
请求方式：post
支持格式：json
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X POST -d '{"secret":"fault still attack alley expand music basket purse later educate follow ride"}' 'http://45.32.248.33:4096/api/accounts/generatePublickey'   

JSON返回示例：

{   
    "success": true,   
    "publicKey": "bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9"   
}   

2.1.6 根据地址获取其投票列表

接口地址：/api/accounts/delegates
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/accounts/delegates?address=14636456069025293113'   

JSON返回示例：

{   
    "success": true,   
    "delegates": [{   
        "username": "wgl_002",   
        "address": "14636456069025293113",   
        "publicKey": "ae256559d06409435c04bd62628b3e7ea3894c43298556f52b1cfb01fb3e3dc7",   
        "vote": 9901985415600500,   
        "producedblocks": 1373,   
        "missedblocks": 6,   
        "rate": 1,   
        "approval": "98.54",   
        "productivity": "99.56"   
    },   
    {   
        "username": "wgl_003",   
        "address": "9961157415582672274",   
        "publicKey": "c292db6ea14d518bc29e37cb227ff260be21e2e164ca575028835a1f499e4fe2",   
        "vote": 9891995435600500,   
        "producedblocks": 1371,   
        "missedblocks": 8,   
        "rate": 2,   
        "approval": "98.44",   
        "productivity": "99.41"   
    },   
    {   
        "username": "wgl_001",   
        "address": "1869971419039689816",   
        "publicKey": "c547df2dde6cbb4508aabcb5970d8f9132e5a1d1c422632da6bc20bf1df165b8",   
        "vote": 32401577128413,   
        "producedblocks": 969,   
        "missedblocks": 8,   
        "rate": 102,   
        "approval": "0.32",   
        "productivity": 0   
    }]   
}   

2.1.7 获取受托人手续费设置

接口地址：/api/accounts/delegates/fee
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/accounts/delegates/fee  

JSON返回示例：

{   
    "success": true,   
    "fee": 100000000  // 0.1 XAS   
}   

2.1.8 给受托人投票

接口地址：/api/accounts/delegates
请求方式：put
支持格式：json
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X PUT -d '{"secret":"call scissors pupil water friend timber spend brand vote obey corn size","publicKey":"3ec1c9ec08c0512641deba37c0e95a0fe5fc3bdf58424009f594d7d6a4e28a2a","delegates":["+fafcd01f6b813fdeb3c086e60bc7fa9bfc8ef70ae7be47ce0ac5d06e7b1a8575"]}' 'http://45.32.248.33:4096/api/accounts/delegates'     

JSON返回示例：

 {
    "success": true,
    "transaction": {
        "type": 3,  //投票的交易类型为3
        "amount": 0,
        "senderPublicKey": "3ec1c9ec08c0512641deba37c0e95a0fe5fc3bdf58424009f594d7d6a4e28a2a",
        "requesterPublicKey": null,
        "timestamp": 5056064,
        "asset": {
            "vote": {
                "votes": ["+fafcd01f6b813fdeb3c086e60bc7fa9bfc8ef70ae7be47ce0ac5d06e7b1a8575"]
            }
        },
        "recipientId": null,
        "signature": "0bff58c7311fc59b3c8b3ffc236bbfece9850c334fb0c292ab087f78cf9a6c0f4d3e541c501887a2c2ec46294c777e8f7bf7dea9cb7c9a175fdec641bb684f08",
        "id": "5630629337798595849",
        "fee": 10000000,
        "senderId": "15238461869262180695"
    }
}  

2.1.9 生成新账户

接口地址：/api/accounts/new
请求方式：get
支持格式：无
请求参数：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/accounts/new'   

JSON返回示例：

{    
    success: true,
    secret: "during crush zoo wealth horror left night upset spike iron divert lawn", // 密码   
    publicKey: "261fa56f389c324fddbe8777dbc0ef3341ee7b75d1ffdc82192265633b90d503", // 公钥    
    privateKey: "67c9523b7622704c4bcfe960cb32d7fa04d3eb94e30e7964d3c6a24a3647a0a3261fa56f389c324fddbe8777dbc0ef3341ee7b75d1ffdc82192265633b90d503", // 私钥    
    address: "ANfXDQUZroMnrQ6vRGR7UXXtbPn3fhEVRJ" // 地址    
}    

2.1.10 获取账户排行榜前100名

接口地址：/api/accounts/top
请求方式：get
支持格式：无
请求参数说明：如果不加请求参数则返回持币量前100名账户信息

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/accounts/top?limit=5&offset=0'  //返回前5名账户信息

JSON返回示例：

{
    "success": true,
    "accounts": [{
        "address": "355198157736313687",
        "balance": 4400099900000000,        //44000999 XAS
        "publicKey": "0b8e120db026d58cbf9d3f392f88eefe3a82a0a3023298b9466d7ed64ff05881"
    },
    {
        "address": "3196144307608101364",
        "balance": 3750000020000000,
        "publicKey": "988eb82a603dd033f94a4f3b6f9f9ef4a7d3d066607c433e5255d50ea7270720"
    },
    {
        "address": "9248745407080572308",
        "balance": 988703397029757,
        "publicKey": "02cedc56da08099532e312c5e563e2859bc5b93cc594eb3e5d350f368d681988"
    },
    {
        "address": "15745540293890213312",
        "balance": 498186229718623,
        "publicKey": "d39d6f26869067473d685da742339d1a9117257fe14b3cc7261e3f2ed5a339e3"
    },
    {
        "address": "8812460086240160222",
        "balance": 100704426831866,
        "publicKey": "0af92cc32f54d50dd83c4f7de14e71223a57843a40e993bc0813454aa9270053"
    }
}    

2.1.11 获取当前链上账户总个数

接口地址：/api/accounts/count
请求方式：get
支持格式：无
请求参数：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/accounts/count'    

JSON返回示例：

{
    success: true,
    count: 105
}

2.2 交易transactions

2.2.1 获取交易信息

接口地址：/api/transactions
请求方式：get
支持格式：urlencoded
接口备注：如果请求不加参数则会获取全网所有交易
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/transactions?recipientId=16723473400748954103&orderBy=t_timestamp:desc&limit=3'   

JSON返回示例：

{   
    "success": true,   
    "transactions": [{   
        "id": "17192581936339156329",   
        "height": "105951",   
        "blockId": "15051364118100195665",   
        "type": 0,   
        "timestamp": 4385190,   
        "senderPublicKey": "d39d6f26869067473d685da742339d1a9117257fe14b3cc7261e3f2ed5a339e3",   
        "senderId": "15745540293890213312",   
        "recipientId": "16723473400748954103",   
        "amount": 10000000000,   
        "fee": 10000000,   
        "signature": "98d65df3109802c707eeed706e90a907f337bddab58cb4c1fbe6ec2179aa1c85ec2903cc0cf44bf0092926829aa5a0a6ec99458f65b6ebd11f0988772e58740e",   
        "signSignature": "",   
        "signatures": null,   
        "confirmations": "31802",   
        "asset": {   
        }   
    },   
    {   
        "id": "7000452951235123088",   
        "height": "105473",   
        "blockId": "11877628176330539727",   
        "type": 0,   
        "timestamp": 4380147,   
        "senderPublicKey": "fafcd01f6b813fdeb3c086e60bc7fa9bfc8ef70ae7be47ce0ac5d06e7b1a8575",   
        "senderId": "16358246403719868041",   
        "recipientId": "16723473400748954103",   
        "amount": 10000000000,   
        "fee": 10000000,   
        "signature": "dc84044d4f6b4779eecc3a986b6507e458cc5964f601ebeb4d3b68a96129813f4940e14de950526dd685ca1328b6e477e6c57e95aeac45859a2ea62a587d0204",   
        "signSignature": "",   
        "signatures": null,   
        "confirmations": "32280",   
        "asset": {   
        }   
    },   
    {   
        "id": "14093929199102906687",   
        "height": "105460",   
        "blockId": "2237504897174225512",   
        "type": 0,   
        "timestamp": 4380024,   
        "senderPublicKey": "fafcd01f6b813fdeb3c086e60bc7fa9bfc8ef70ae7be47ce0ac5d06e7b1a8575",   
        "senderId": "16358246403719868041",   
        "recipientId": "16723473400748954103",   
        "amount": 10000000000,   
        "fee": 10000000,   
        "signature": "73ceddc3cbe5103fbdd9eee12f7e4d9a125a3bcf2e7cd04282b7329719735aeb36936762f17d842fb14813fa8f857b8144040e5117dffcfc7e2ae88e36440a0f",   
        "signSignature": "",   
        "signatures": null,   
        "confirmations": "32293",   
        "asset": {   
        }   
    }],   
    "count": 3   
}   

2.2.2 根据交易id查看交易详情

接口地址：/api/transactions/get
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/transactions/get?id=14093929199102906687'   

JSON返回示例：

{   
    "success": true,   
    "transaction": {   
        "id": "14093929199102906687", // 交易id  
        "height": "105460",// 该交易所在区块高度   
        "blockId": "2237504897174225512",// 所在区块id   
        "type": 0,// 交易类型，0：普通XAS转账   
        "timestamp": 4380024,// 距离阿希创世块的timestamp   
        "senderPublicKey": "fafcd01f6b813fdeb3c086e60bc7fa9bfc8ef70ae7be47ce0ac5d06e7b1a8575", // 发送者公钥   
        "senderId": "16358246403719868041",// 发送者地址   
        "recipientId": "16723473400748954103",// 接收者地址   
        "amount": 10000000000,// 交易额，100XAS   
        "fee": 10000000, // 手续费0.1XAS  
        "signature": "73ceddc3cbe5103fbdd9eee12f7e4d9a125a3bcf2e7cd04282b7329719735aeb36936762f17d842fb14813fa8f857b8144040e5117dffcfc7e2ae88e36440a0f",   
        "signSignature": "",   
        "signatures": null,   
        "confirmations": "34268",// 确认数   
        "asset": {   
        }   
    }   
}   

2.2.3 根据未确认交易id查看详情

接口地址：/api/transactions/unconfirmed/get
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET http://45.32.248.33:4096/api/transactions/unconfirmed/get?id=7557072430673853692  // 正常情况，该未确认交易存在时间极短0~10秒   

JSON返回示例：

{
    "success": true,
    "transaction": {
        "type": 0,
        "amount": 10000,
        "senderPublicKey": "3ec1c9ec08c0512641deba37c0e95a0fe5fc3bdf58424009f594d7d6a4e28a2a",
        "requesterPublicKey": null,
        "timestamp": 5082322,
        "asset": {
        },
        "recipientId": "16723473400748954103",
        "signature": "3a97f8d63509ef964bda3d816366b8e9e2d9b5d4604a660e7cbeefe210cb910f5de9a51bece06c32d010f55502c62f0f59b8224e1c141731ddfee27206a88d02",
        "id": "7557072430673853692",
        "fee": 10000000,
        "senderId": "15238461869262180695"
    }
}

2.2.4 获取[全网所有]未确认的交易详情

接口地址：/api/transactions/unconfirmed
请求方式：get
支持格式：urlencoded
接口说明：如果不加参数，则会获取全网所有未确认交易
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/transactions/unconfirmed'   

JSON返回示例：

{   
    "success": true,   
    "transactions": []      //全网目前不存在未确认的交易   
}   

2.2.5 创建交易并广播

接口地址：/api/transactions
请求方式：PUT
支持格式：json
接口备注：接收者账户需在web端钱包登陆过
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X PUT -d '{"secret":"unaware label emerge fancy concert long fiction report affair appear decide twenty","amount":1000000,"recipientId":"16723473400748954103"}' 'http://45.32.248.33:4096/api/transactions'    

JSON返回示例：

{   
    "success": true,   
    "transactionId": "16670272591943275531"   
}   

2.3 区块blocks

2.3.1 获取指定区块的详情

接口地址：/api/blocks/get
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/get?id=6076474715648888747'   

JSON返回示例：

{   
    "success": true,   
    "block": {   
        "id": "6076474715648888747",   
        "version": 0,   
        "timestamp": 4734070,   
        "height": 140538,   
        "previousBlock": "16033230167082515105",    //上一个区块id   
        "numberOfTransactions": 0,  //交易数   
        "totalAmount": 0,   //交易额   
        "totalFee": 0,   
        "reward": 350000000,    //奖励   
        "payloadLength": 0,   
        "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",   
        "generatorPublicKey": "1d352950c8141e1b35daba4a974a604519d7a2ef3a1ec0a503ce2653646aa052",   
        "generatorId": "6656029629904254066",   
        "blockSignature": "a53de66922cdc2f431acd0a474beec7cf7c420a8460b7b7caf84999be7caebb59fb7fbb7166c2c7013dbb431585ea7294722166cb08bf9663abf50b6bd81cd05",   
        "confirmations": "2",   
        "totalForged": 350000000   
    }   
}   

2.3.2 获取区块数据

接口地址：/api/blocks
请求方式：get
支持格式：urlencoded
接口说明：不加参数则获取全网区块详情
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks?limit=2&offset=0&orderBy=height:desc'   

JSON返回示例：

{   
    "success": true,   
    "blocks": [{   
        "id": "12634047624004615059",   
        "version": 0,   
        "timestamp": 4708080,   
        "height": 137986,   
        "previousBlock": "3498191422350401106",   
        "numberOfTransactions": 0,  // 交易数   
        "totalAmount": 0,   // 金额   
        "totalFee": 0,  // 手续费   
        "reward": 350000000,    // 奖励   
        "payloadLength": 0,   
        "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",   
        "generatorPublicKey": "44db7bec89ef289d0def257285675ca14f2a947dfd2b70e6b1cff4392ce42ada",   
        "generatorId": "4925169939071346193",   
        "blockSignature": "83a2124e3e8201c1a6099b2ac8ab1c117ad34867978add3a90d41a64df9d2ad8fabc9ec14d27a77cd34c08a6479ef684f247c11b1cbbcb0e9767dffc85838600",   
        "confirmations": "1",   
        "totalForged": 350000000   
    },   
    {   
        "id": "3498191422350401106",   
        "version": 0,   
        "timestamp": 4708070,   
        "height": 137985,   
        "previousBlock": "14078155423801039323",   
        "numberOfTransactions": 0,   
        "totalAmount": 0,   
        "totalFee": 0,   
        "reward": 350000000,   
        "payloadLength": 0,   
        "payloadHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",   
        "generatorPublicKey": "500b1ec025cd64d36008341ed8d2508473ecf559be213ca5f9580620a21a592c",   
        "generatorId": "16006295608945777169",   
        "blockSignature": "a0b5ed6c94b1f33c4d0f017f21a08357061493392b19e34eeedf274b77c751e3f86c92443280de09ea1754d62fe7ef00e02acbdc3bc0c1063cef344bacaa4f07",   
        "confirmations": "2",   
        "totalForged": 350000000   
    }],   
    "count": 137986   
}   

2.3.3 获取区块链高度

接口地址：/api/blocks/getHeight
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/getheight'    

JSON返回示例：

{"success":true,"height":140569}   

2.3.4 获取普通转账手续费

接口地址：/api/blocks/getFee
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/getfee'   

JSON返回示例：

{"success":true,"fee":10000000}     //手续费为0.1 XAS   

2.3.5 获取里程碑

接口地址：/api/blocks/getMilestone
请求方式：get
支持格式：无
请求参数说明：无
返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/getMilestone'    

JSON返回示例：

{"success":true,"milestone":0}   

2.3.6 查看单个区块奖励

接口地址：/api/blocks/getReward
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/getReward'   

JSON返回示例：

{"success":true,"reward":350000000} //每个生成一个block奖励3.5 XAS   

2.3.7 获取XAS当前供应值

接口地址：/api/blocks/getSupply
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/getSupply'   

JSON返回示例：

{"success":true,"supply":10049222600000000} //当前testnet共有100492226XAS   

2.3.8 区块链状态

接口地址：/api/blocks/getStatus
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/getStatus'   

JSON返回示例：

{   
    "success": true,   
    "height": 140649,   
    "fee": 10000000,   
    "milestone": 0,   
    "reward": 350000000,   
    "supply": 10049227150000000   
}   

2.3.9 获取指定区块的交易信息

接口地址：/api/blocks/full
请求方式：get
支持格式：无
请求参数说明：无

请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/blocks/full?height=2392'   

JSON返回示例：

{    
    success: true,    
    block: {    
        id: "99773e6fc4feddc2d876427701ce2b52aabfefc8b54a5a8560ed237acb1c9565",    
        version: 0,    
        timestamp: 39605950,    
        height: 2392,    
        previousBlock: "436ca0351028854792ca63862e01b5285b017dd40bc8748a97c1de034e97817f",    
        numberOfTransactions: 1,    
        totalAmount: 100000000,    
        totalFee: 10000000,    
        reward: 350000000,    
        payloadLength: 117,    
        payloadHash: "07af33c345f733e5224877b290888db2faab26e779e784881fadb086148335f1",    
        generatorPublicKey: "1b36e7183125e3de33a4d778c5a705d4e6180e426b15f4737b18d1e09c150a42",    
        generatorId: "8280768395963849562",    
        blockSignature: "59b292c97e68f8a0fc311c0894e79e1fe23613b2387f42e389e0b5f4aba61847fb13feb8153578b3eb37d6249c13347001cce9c4d06ae521b6c8cefedb829804",    
        totalForged: 360000000,    
        transactions: [{    // 该区块包含的交易信息数组
            id: "07af33c345f733e5224877b290888db2faab26e779e784881fadb086148335f1",    
            height: 2392,    
            blockId: "99773e6fc4feddc2d876427701ce2b52aabfefc8b54a5a8560ed237acb1c9565",    
            type: 0,    
            timestamp: 39605935,    
            senderPublicKey: "8065a105c785a08757727fded3a06f8f312e73ad40f1f3502e0232ea42e67efd",    
            requesterPublicKey: "",    
            senderId: "14762548536863074694",    
            recipientId: "1",    
            amount: 100000000,    
            fee: 10000000,    
            signature: "72b72b3db7eb86436a32bff72f19f89fffc51e10f73ca19536968e70d34c38efd24e96ce43e5d4981a23b07849c9baa20263aeadd9dbbbad233c3efa2fa97100",    
            signSignature: "",    
            signatures: null,    
            args: null,    
            message: "",    
            asset: {    
            }    
        }]    
    }    
}     

2.4 受托人delegates

2.4.1 获取受托人总个数

接口地址：/api/delegates/count
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/delegates/count'   

JSON返回示例：

{    
    "success": true,    
    "count": 234    
}     

2.4.2 根据受托人公钥查看哪些人为其投了票

接口地址：/api/delegates/voters
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/delegates/voters?publicKey=ae256559d06409435c04bd62628b3e7ea3894c43298556f52b1cfb01fb3e3dc7'   

JSON返回示例：

{   
    "success": true,   
    "accounts": [{   
        "address": "2918354313445278349",   
        "publicKey": "4fde4c49f1297d5d3a24b1494204543c4281aff17917ff7ff8ff32da3b4b222f",   
        "balance": 1338227722727,   
        "weight": 0.013316660647014596   
    },   
    {   
        "address": "1523444724068322527",   
        "publicKey": "8a6a61c28dc47541aadf1eecec2175c8f768f2331eea3472b1593bf1aa4e1fb4",   
        "balance": 2109297623765,   
        "weight": 0.020989552213127274   
    },   
    {   
        "address": "14483826354741911727",   
        "publicKey": "5dacb7983095466b9b037690150c3edec0f073815326e33a4744b6d1d50953e2",   
        "balance": 5135815841470,   
        "weight": 0.051106336795243436   
    }   
    }]   
}   

2.4.3 根据公钥或者用户名获取受托人详情

接口地址： /api/delegates/get
请求方式：get
支持格式：urlencoded
接口备注：通过公钥或者用户名获取受托人信息
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET http://45.32.248.33:4096/api/delegates/get?publicKey=bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9   
curl -k -X GET http://45.32.248.33:4096/api/delegates/get?username=delegate_register   

JSON返回示例：

{   
    "success": true,   
    "delegate": {   
        "username": "delegate_register",   
        "address": "16723473400748954103",   
        "publicKey": "bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9",   
        "vote": 0,   
        "producedblocks": 0,   
        "missedblocks": 0,   
        "fees": 0,   
        "rewards": 0,   
        "rate": 191,   
        "approval": 0,   
        "productivity": 0,   
        "forged": "0"   
    }   
}   

2.4.4 获取受托人列表

接口地址：/api/delegates
请求方式：get
支持格式：urlencoded
接口说明：如果不加参数则会返回全网受托人列表
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/delegates?orderby=approval:desc&limit=2' //按照得票率降序排序，取出前2名   

JSON返回示例：

{   
    "success": true,   
    "delegates": [{   
        "username": "wgl_002",  //受托人名字   
        "address": "14636456069025293113",  //受托人地址   
        "publicKey": "ae256559d06409435c04bd62628b3e7ea3894c43298556f52b1cfb01fb3e3dc7",    //受托人公钥   
        "vote": 9901984015600500,   //得票数   
        "producedblocks": 1371, //生成的区块数   
        "missedblocks": 6,  //丢失的区块数   
        "fees": 12588514990,       
        "rewards": 276850000000,    //已经得到的奖励   
        "rate": 1,   
        "approval": 98.54,  //得票率   
        "productivity": 99.56,  //生产率   
        "forged": "289438514990"    //锻造产生的所有奖励   
    },   
    {   
        "username": "wgl_003",   
        "address": "9961157415582672274",   
        "publicKey": "c292db6ea14d518bc29e37cb227ff260be21e2e164ca575028835a1f499e4fe2",   
        "vote": 9891994035600500,   
        "producedblocks": 1370,   
        "missedblocks": 8,   
        "fees": 12355148480,   
        "rewards": 275100000000,   
        "rate": 2,   
        "approval": 98.44,   
        "productivity": 99.42,   
        "forged": "287455148480"   
    }],   
    "totalCount": 233   
}   

2.4.5 获取受托人设置的转账费

接口地址：/api/delegates/fee
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/delegates/fee?publicKey=ae256559d06409435c04bd62628b3e7ea3894c43298556f52b1cfb01fb3e3dc7'   

JSON返回示例：

{"success":true,"fee":10000000000}  //0.1 XAS   

2.4.6 根据公钥查看其锻造情况

接口地址：/api/delegates/forging/getForgedByAccount
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/delegates/forging/getForgedByAccount?generatorPublicKey=ae256559d06409435c04bd62628b3e7ea3894c43298556f52b1cfb01fb3e3dc7'   

JSON返回示例：

{   
    "success": true,   
    "fees": 12589307065,   
    "rewards": 285600000000,   
    "forged": 298189307065   
}   

2.4.7 注册受托人

接口地址：/api/delegates
请求方式：put
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X PUT -d '{"secret":"unaware label emerge fancy concert long fiction report affair appear decide twenty","username":"delegate_0821"}' 'http://45.32.248.33:4096/api/delegates'   

JSON返回示例：

{   
    "success": true,   
    "transaction": {   
        "type": 2,  //注册受托人的交易类型为2   
        "amount": 0,   
        "senderPublicKey": "3b64f1833e6328043e1f2fee31e638bdaa6dfff5c7eb9c8577a5cefcf11261f2",   
        "requesterPublicKey": null,   
        "timestamp": 4737615,   
        "asset": {   
            "delegate": {   
                "username": "delegate_0821",   
                "publicKey": "3b64f1833e6328043e1f2fee31e638bdaa6dfff5c7eb9c8577a5cefcf11261f2"   
            }   
        },   
        "recipientId": null,   
        "signature": "7f8417e8db5f58ddff887c86c789c26b32fd3f01083ef1e3c8d4e18ed16622bf766492d78518c6c7a07aada1c98b1efc36d40c8e09394989dbde229d8e3f8103",   
        "id": "16351320834453011577",   
        "fee": 10000000000,   
        "senderId": "250438937633388106"   
    }   
}   

2.4.8 受托人开启锻造

接口地址：/api/delegates/forging/enable
请求方式：post
支持格式：urlencoded // url必须是受托人所在服务器
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X POST -d '{"secret":"motion group blossom coral upper warrior pattern fragile sister misery palm detect"}' 'http://localhost:4096/api/delegates/forging/enable'   

JSON返回示例：

{"success":true,"address":"16358246403719868041"}   

2.4.9 受托人关闭锻造

接口地址：/api/delegates/forging/disable
请求方式：post
支持格式：urlencoded // url必须是受托人所在服务器
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X POST -d '{"secret":"motion group blossom coral upper warrior pattern fragile sister misery palm detect"}' 'http://localhost:4096/api/delegates/forging/disable'   

JSON返回示例：

{"success":true,"address":"16358246403719868041"}     

2.4.10 受托人锻造状态查看

接口地址：/api/delegates/forging/status
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/delegates/forging/status?publicKey=fafcd01f6b813fdeb3c086e60bc7fa9bfc8ef70ae7be47ce0ac5d06e7b1a8575'        

JSON返回示例：

{"success":true,"enabled":false}    

2.5 节点peers

2.5.1 获取本机连接的所有节点信息

接口地址：/api/peers
请求方式：get
支持格式：urlencoded
备注：展示节点只是和本机有连接的节点，并不是全网所有的节点
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/peers?limit=1'   

JSON返回示例：

{   
    "success": true,   
    "peers": [{   
        "ip": "45.32.19.241",   
        "port": 4096,   
        "state": 2,   
        "os": "linux3.13.0-87-generic",   
        "version": "1.0.0"   
    }],   
    "totalCount": ["54"]   
}   

2.5.2 获取本节点版本号等信息

接口地址：/api/peers/version
请求方式：get
支持格式：无
请求参数说明：无参数

返回参数说明：

请求示例：

curl -k -X GET http://45.32.248.33:4096/api/peers/version   

JSON返回示例：

{   
    "success": true,   
    "version": "1.0.0",   
    "build": "12:11:11 16/08/2016",   
    "net": "testnet"   
}   

2.5.3 获取指定ip节点信息

接口地址：/api/peers/get
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET 'http://45.32.248.33:4096/api/peers/get?ip=45.32.248.33&port=4096'   

JSON返回示例：

{   
    "success": true,   
    "peer": {   
    }   
}   

2.6 同步和加载

2.6.1 查看本地区块链加载状态

接口地址：/api/loader/status
请求方式：get
支持格式：无
请求参数说明：无参数

返回参数说明：

请求示例：

curl -k http://45.32.248.33:4096/api/loader/status -X GET   

JSON返回示例：

{   
    "success": true,   
    "loaded": true,   
    "blocksCount": 0   
}   

2.6.2 查看区块同步信息

接口地址：/api/loader/status/sync
请求方式：get
支持格式：无
请求参数说明：无参数

返回参数说明：

请求示例：

curl -k http://45.32.248.33:4096/api/loader/status/sync -X GET   

JSON返回示例：

{   
    "success": true,   
    "syncing": false,  // 是否在同步中，如果是则为true，目前没有数据可以同步所以为false   
    "blocks": 0,   
    "height": 111987   
}   

2.7 二级密码signatures

2.7.1 设置二级密码

接口地址：/api/signatures
请求方式：put
支持格式：json
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X PUT -d '{"secret":"unaware label emerge fancy concert long fiction report affair appear decide twenty","secondSecret":"fault still attack alley expand music basket purse later educate follow ride"}' 'http://45.32.248.33:4096/api/signatures'    

JSON返回示例：

{   
    "success": true,   
    "transaction": {   
        "type": 1,  //设置二级密码密码的交易类型为1   
        "amount": 0,   
        "senderPublicKey": "3b64f1833e6328043e1f2fee31e638bdaa6dfff5c7eb9c8577a5cefcf11261f2",   
        "requesterPublicKey": null,   
        "timestamp": 4872315,   
        "asset": {   
            "signature": {   
                "publicKey": "bd1e78c5a10fbf1eca36b28bbb8ea85f320967659cbf1f7ff1603d0a368867b9"   
            }   
        },   
        "recipientId": null,   
        "signature": "e76d9b25ec0fdaa88b19d59c5a222b7efdc04f738ee05896f55f4e6959229d9b1600ca25aa92fbea176668f3be7c12c506f2091e2b38c52ef0ece7a5d35e240a",   
        "id": "1614688380530105232",   
        "fee": 500000000,       //设置二级密码密码的手续费为5 XAS   
        "senderId": "250438937633388106"   
    }   
}   

2.7.2 获取二级密码设置手续费

接口地址：/api/signatures/fee
请求方式：get
支持格式：无
请求参数说明：无

返回参数说明：

请求示例：

curl -k http://45.32.248.33:4096/api/signatures/fee -X GET   

JSON返回示例：

{   
    "success": true,   
    "fee": 500000000         //5 XAS   
}     

2.8 多重签名multisignatures

2.8.1 设置普通账户为多重签名账户

接口地址：/api/multisignatures
请求方式：put
支持格式：json
接口说明：返回结果只是生成交易id，还需要其他人签名后该账户才能成功设置成多重签名账户。注册多重签名账户后任意一笔转账都需要多人签名，签名最少个数为min的值（含交易发起人自身）
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X PUT -d '{"secret":"vanish deliver message evil canyon night extend unusual tell prosper issue antenna","min":2,"lifetime":1,"keysgroup":["+eb48b9ab7c9a34a9b7cdf860265d65b31af774355cabf1b3a387d14a1925dc97","+d5d7aa157f866c47a2a1e09e2746286ed089fd90976b54fbfa930e87d11609cb"]}' 'http://45.32.248.33:4096/api/multisignatures'  //公钥为2cef5711e61bb5361c544077aa08aebc4d962a1d656571901c48d716382ad4fd   

JSON返回示例：

{   
    "success": true,   
    "transactionId": "17620378998277022323"     //返回结果只是生成交易id，还需要其他人签名后该账户才能成功设置成多重签名账户   
}   

2.8.2 根据公钥获取挂起的多重签名交易详情

接口地址：/api/multisignatures/pending
请求方式：get
支持格式：urlencoded
请求参数说明：

返回参数说明：

请求示例：

curl -k -X GET http://45.32.248.33:4096/api/multisignatures/pending?publicKey=2cef5711e61bb5361c544077aa08aebc4d962a1d656571901c48d716382ad4fd   

JSON返回示例：

{   
    "success": true,   
    "transactions": [{      //上一步中设置账户为多重签名交易的详情，transactionId: 17620378998277022323   
        "min": 2,   
        "lifetime": 1,   
        "signed": true,   
        "transaction": {   
            "type": 4,      //4代表注册多重签名账户   
            "amount": 0,   
            "senderPublicKey": "2cef5711e61bb5361c544077aa08aebc4d962a1d656571901c48d716382ad4fd",   
            "requesterPublicKey": null,   
            "timestamp": 4879978,   
            "asset": {   
                "multisignature": {   
                    "min": 2,   
                    "keysgroup": ["+eb48b9ab7c9a34a9b7cdf860265d65b31af774355cabf1b3a387d14a1925dc97",   
                    "+d5d7aa157f866c47a2a1e09e2746286ed089fd90976b54fbfa930e87d11609cb"],   
                    "lifetime": 1   
                }   
            },   
            "recipientId": null,   
            "signature": "a42feaccd9f2a4940fc0be1a1580e786b360f189db3154328f307988e75484293eae391f2f9eee489913cc6d15984eb1f5f5a0aa1bf78ea745d5c725f161af08",   
            "id": "17620378998277022323",   
            "fee": 1500000000,   
            "senderId": "3855903394839129841"   
        }   
    }]   
}   

2.8.3 非交易发起人对交易进行多重签名

接口地址：/api/multisignatures/sign
请求方式：post
支持格式：json
请求参数说明：

返回参数说明：

请求示例：

curl -k -H "Content-Type: application/json" -X POST -d '{"secret":"lemon carpet desk accuse clerk future oyster essay seminar force live dog","transactionId":"17620378998277022323"}' 'http://45.32.248.33:4096/api/multisignatures/sign'   //公钥为eb48b9ab7c9a34a9b7cdf860265d65b31af774355cabf1b3a387d14a1925dc97的用户进行签名   

JSON返回示例：

{   
    "success": true,   
    "transactionId": "17620378998277022323"   
}   
// 此时再次获取pending   
curl -k -X GET http://45.32.248.33:4096/api/multisignatures/pending?publicKey=2cef5711e61bb5361c544077aa08aebc4d962a1d656571901c48d716382ad4fd   
{   
    "success": true,   
    "transactions": [{   
        "min": 2,   
        "lifetime": 1,   
        "signed": true,   
        "transaction": {   
            "type": 4,   
            "amount": 0,   
            "senderPublicKey": "2cef5711e61bb5361c544077aa08aebc4d962a1d656571901c48d716382ad4fd",   
            "requesterPublicKey": null,   
            "timestamp": 4879978,   
            "asset": {   
                "multisignature": {   
                    "min": 2,   
                    "keysgroup": ["+eb48b9ab7c9a34a9b7cdf860265d65b31af774355cabf1b3a387d14a1925dc97",   
                    "+d5d7aa157f866c47a2a1e09e2746286ed089fd90976b54fbfa930e87d11609cb"],   
                    "lifetime": 1   
                }   
            },   
            "recipientId": null,   
            "signature": "a42feaccd9f2a4940fc0be1a1580e786b360f189db3154328f307988e75484293eae391f2f9eee489913cc6d15984eb1f5f5a0aa1bf78ea745d5c725f161af08",   
            "id": "17620378998277022323",   
            "fee": 1500000000,   
            "senderId": "3855903394839129841",   
            "signatures": ["b38a161264db2a23e353d3fbc4983562f6343d5ee693144543ca54e2bc67c0f73d1c761b7bfa38b2bb101ac2ab0797b674b1a9964ccd400aaa310746c3494d03"]      //新生成的多重签名   
        }   
    }]   
}   
// 公钥为d5d7aa157f866c47a2a1e09e2746286ed089fd90976b54fbfa930e87d11609cb的账户对该注册交易进行签名   
curl -k -H "Content-Type: application/json" -X POST -d '{"secret":"chalk among elbow piece badge try van round quality position simple teach","transactionId":"17620378998277022323"}' 'http://45.32.248.33:4096/api/multisignatures/sign'   
{"success":true,"transactionId":"17620378998277022323"}   
// 此时再次获取pending,结果为空   
curl -k -X GET http://45.32.248.33:4096/api/multisignatures/pending?publicKey=2cef5711e61bb5361c544077aa08aebc4d962a1d656571901c48d716382ad4fd   
{"success":true,"transactions":[]}   
// 查看该注册交易详情（该交易已广播并写入blockchain）,此时该账户已成功注册成为多重签名账户   
curl -k -X GET http://45.32.248.33:4096/api/transactions/get?id=17620378998277022323   
{   
    "success": true,   
    "transaction": {   
        "id": "17620378998277022323",   //注册账户为多重签名用户的交易id   
        "height": "157013",   
        "blockId": "4680888982781013372",   
        "type": 4,   
        "timestamp": 4879978,   
        "senderPublicKey": "2cef5711e61bb5361c544077aa08aebc4d962a1d656571901c48d716382ad4fd",   
        "senderId": "3855903394839129841",   
        "recipientId": "",   
        "amount": 0,   
        "fee": 1500000000,   
        "signature": "a42feaccd9f2a4940fc0be1a1580e786b360f189db3154328f307988e75484293eae391f2f9eee489913cc6d15984eb1f5f5a0aa1bf78ea745d5c725f161af08",   
        "signSignature": "",   
        "signatures": null,   
        "confirmations": "26",   
        "asset": {   
        }   
    }   
}