区块链浏览器
概览
(1)网络列表
描述:网络列表
方法:GET
请求路径:/xbaas/v1/explorer/nets
请求参数:无
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | []object | 网络列表 |
请求示例:
响应示例:
{
"code":"0",
"msg":"ok",
"data":{[
{
"name":"xuperos", //网络名称
"chain":"xuper", //平行链名称
"blockId":"f25xxx", //创始区块id
"nodes":"127.0.0.1:37101;node1.xchain.com:37101",//节点
"genesis":"", //创始区块信息
"create_time":"2022-04-21T14:50:38+08:00" //创建时间
"update_time":"2022-04-21T14:50:38+08:00" //更新时间
}...
]}
}
(2) 网络数据概览
描述:数据概览
方法:GET
请求路径:/xbaas/v1/explorer/statistics
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 概览数据 |
请求示例:
响应示例:
{
"code":"0",
"msg":"ok",
"data": {
"block_height":122, //区块高度
"tx_total":2332, //交易总数
"contracts_num":4, //合约数
"nodes_num":6,//节点总数
"period":3000, //平均出块时间,单位毫秒
"precision": 7, // 精度
"tx_peak":300 //历史并发峰值
}
}
(3)区块列表
描述:区块列表
方法:GET
请求路径:/xbaas/v1/explorer/block/list
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| pn | query | int | 否 | 第几页,默认1 |
| ps | query | int | 否 | 每页几条,默认10,大于1小于等于50 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 区块列表 |
请求示例:
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"blist_total":100, //当前返回的区块列表blist大小
"blist":[//区块列表
{
block_id:"12344", //string,区块id
height:2332, //块高度
create_time:123455, //int,创建时间,unix时间戳
miner:"dzaYVdoumhVeFQZa1pzu2kmsQrFcdgFpN" //string,记账节点(矿工)地址
tx_count:100, //交易数量
}...
]
}
}
(4)交易列表
描述:交易列表
方法:GET
请求路径:/xbaas/v1/explorer/chain/tx/list
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| pn | query | int | 否 | 第几页,默认1 |
| ps | query | int | 否 | 每页几条,默认10,大于1小于等于50 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 交易列表 |
请求示例:
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"tx_total":2332, //交易总数
"tx_lists":[
{
"txid":"xxxx", //交易id
"blockid": "xxxx", //区块id
"create_time": 15321456321, // unix时间戳
"coinbase": false, // 是否为矿工奖励
"tx_inputs":[],
"tx_outputs":[{"amount": 0,"to_addr":"W3aNnDxLQ91gehLWRmpdyzFTX5LkFkvzx"}],
"desc":"1", //描述
"trans_type":1, //交易类型,1普通交易;2记账交易;3唱票交易;4合约交易
}...
]
}
}
(5)交易总数趋势
描述:交易总数趋势
方法:GET
请求路径:/xbaas/v1/explorer/trend
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| end_time | query | int | 否 | 统计的结束时间戳,统计区间段然后按type进行递减; 按天则end_time 会取当天24点时间戳,按小时则当前小时的结束时间戳,数据取值区间左闭右开第几页,默认1 |
| type | query | int | 否 | 1:按天,数量对应天数(默认);2:按小时,数量对应为小时 |
| num | query | int | 否 | 数量,大于0,小于等于60 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 交易总数趋势 |
请求示例:
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"1645286400":897722, //时间戳为返回的统计时间段结束时间
"1645372800":897762,
"1645545600":897822
}
}
检索
(1)搜索框
描述:搜索接口
方法:GET
请求路径:/xbaas/v1/explorer/search
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| search | query | string | 是 | 检索条件, 地址、高度、区块hash、交易hash |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 检索内容 |
请求示例:
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"type":"block", //transaction(交易)、block(区块高度, 区块hash)、address(地址)
"search":"", //如果查询条件为区块高度,则返回区块hash
}
}
(2)交易详情
描述:交易详情
方法:GET
请求路径:/xbaas/v1/explorer/tx/query
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| txid | query | string | 是 | 交易id |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 交易详情 |
请求示例:
GET
/xbaas/v1/explorer/tx/query?net=XuperOS&txid=5711a4eb3274a6020fbafc90d8c76ddf25e247e97fe0ced3f3c406d3de726a64
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"txid":"xxxxx",// 交易id
"create_time": 15321456321, // unix时间戳
"coinbase": false, // 是否为矿工奖励
"tx_inputs":[],
"tx_outputs":[{"amount": 0,"to_addr":"WphkwmEcHqBV6aWVrqgK2iD6K2X5Znh85"}],
"trans_type":1, //交易类型,1普通交易;2记账交易;3唱票交易;4合约交易
"token_type" :"xxx", //通证类型
"fee":1.11 //交易手续费
"from_total_amount": 10000, //交易发起金额
"to_total_amount":1000, //交易接收金额
"block_id" : "xxxx" //区块id
"height" : 12343 //区块高度
}
}
(3)地址交易列表
描述:用户交易历史
方法:GET
请求路径:/xbaas/v1/explorer/addr/txlist
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| address | query | string | 是 | 用户地址 |
| trans_type | query | int | 否 | 交易类型,兼容字段,默认取普通交易:1 |
| ps | query | int | 否 | 分页大小 |
| pn | query | int | 否 | 分页 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 交易列表 |
请求示例:
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"tx_total":2332, //交易总数
"tx_lists":[{
"txid":"",
"create_time": 15321456321, // unix时间戳
"coinbase": false, // 是否为矿工奖励
"tx_inputs":[{
"from_addr": "XXX..", //来源帐号
"amount":1000, //来源金额
},{...}],
"tx_outputs":[{
"to_addr": "YYY...", //转出金额
"amount":500,
},{...}],
"trans_type":"1", // 交易类型
"fee":1.111, //手续费
"token_type" : "xxx", //通证类型
"amount":1000, //交易金额
"tx_type":1, //转出或转入
"trans_type":1, //交易类型,1普通交易;2记账交易;3唱票交易;4合约交易
"desc":"1", //交易描述
}]
}
}
(4)区块详情
描述:区块详情
方法:GET
请求路径:/xbaas/v1/explorer/blockdetail
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| blockid | query | string | 与height二选一 | 区块hash |
| height | query | int | 与block_id二选一 | 高度,如果blockid为空,默认取第0个区块 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 区块详情 |
请求示例:
GET
/xbaas/v1/explorer/blockdetail?net=XuperOS&blockid=eec21f3316656d1e33a68c647e04be5c942845d1403da8c27456947207f1c676
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"block_id" : "23a2b442", //区块hash
"height" : 100, //高度
"pre_hash" : "856a2b442b59fca7...", //前一个区块hash
"next_hash" : "1986f32a9b42bd0...", //后一个区块hash
"proposer" : "xxx" , //播报方
"tx_count" : 10 //普通交易数量
"create_time" : 123455, //int,创建时间,unix时间戳
}
}
(5)区块下的交易列表
描述:区块下的交易列表
方法:GET
请求路径:/xbaas/v1/explorer/tx/list
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| blockid | query | string | 与height二选一 | 区块hash |
| height | query | int | 与block_id二选一 | 高度,如果blockid为空,默认取第0个区块 |
| ps | query | int | 否 | 分页大小 |
| pn | query | int | 否 | 分页 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 交易列表 |
请求示例:
GET
/xbaas/v1/explorer/tx/list?net=XuperOS&blockid=eec21f3316656d1e33a68c647e04be5c942845d1403da8c27456947207f1c676
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"tx_total":2332, //交易总数
"tx_lists":[{
"txid":"xxxx", //交易id
"blockid": "xxxx", //区块id
"create_time": 15321456321, // unix时间戳
"coinbase": false, // 是否为矿工奖励
"tx_inputs":[],
"tx_outputs":[{"amount": 0,"to_addr":"W3aNnDxLQ91gehLWRmpdyzFTX5LkFkvzx"}],
"desc":"1", //描述
"trans_type":1, //交易类型,1普通交易;2记账交易;3唱票交易;4合约交易
}...]
}
}
(6)地址详情
描述:区块下的交易列表
方法:GET
请求路径:/xbaas/v1/explorer/addressdetail
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| address | query | string | 是 | 用户地址 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 交易列表 |
请求示例:
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"normal_tx_total":2332, //普通交易总数
"normal_accept_total":123322, //总接收,未除精度
"normal_output_total":123322, //总支出,未除精度
"balance":"2332.22", //余额,除以精度后的值
}
}
(7)合约交易详情
描述:合约交易详情
方法:GET
请求路径:/xbaas/v1/explorer/tx/contract
请求参数:
| 名称 | 位置 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| net | query | string | 是 | 网络名 |
| chain | query | string | 否 | 链名称,默认为xuper |
| txid | query | string | 是 | 交易地址 |
响应体:
| 字段 | 字段类型 | 字段内容 |
|---|---|---|
| msg | string | 响应的消息 |
| code | string | 状态码 |
| data | object | 交易列表 |
请求示例:
GET
/xbaas/v1/explorer/tx/contract?net=LocalChain&txid=86767d5d7b13f585cbff2d9aedc0b8d8eec1d0786bfd0e943391da4c037d87cb
响应示例:
{
code:0, //成功
msg:"ok",
data:{
"txid":"xxxxx",// 交易id
"contract_type"2, //交易类型,1 创建合约账户 2 部署合约代码 3 调用合约
"contract_account":"XCxxx",//合约账户
"module_name":"wwasm", //合约类型
"contract_name" :"xxx", //合约名称
"method_name":"increase" //合约方法
"create_time": "", //交易时间
"desc":"", //交易描述
"args" : "xxxx" //交易参数
}
}
错误码
| 错误码 | 含义 |
|---|---|
| 2010008 | 系统错误 |
| 3020008 | 参数为空错误 |
| 3020009 | 参数不符合要求错误 |
| 3020012 | 无权访问 |
| 2010005 | 查询请求错误 |