SD-Cable V1.2.2

1 账户接口

1.1 获取新钱包

GET /v1/wallet/new

结果:

                        
参数 类型 说明
wallet Object 钱包
address String 六域链钱包地址(公钥)
secret String 私钥

注:新获取的钱包为未激活。激活方式:使用支付接口从已激活账户中向新账户转账0.6个SDA进行。

1.2 获得账户余额

GET /v1/accounts/balances/{:address}

参数 类型 说明
address String 六域链地址
结果:
参数 类型 说明
success Boolean 请求结果
ledger String 区块高度
balances Array 余额,对象数组
value String 数量
currency String 通证符号
counterparty String 发行方,当通证为SDA时为空

2 支付接口

2.1 支付请求

POST /v1/accounts/payments/{:source_address}?submit=true

参数 类型 说明
source_address String 支付方的六域链地址
参数 类型 说明
secret String 支付方的钱包私钥
payment Object 支付对象
source_account String 支付方的六域链地址
destination_account String 收款方的六域链地址
amount String 数量
memos Array 支付的备注,对象数组,可选
memo_type String 备注类型,英文加数字
memo_data String 备注内容
请求数据:

                        
结果:

                        
参数 类型 说明
success Boolean 请求结果
hash String 交易hash
status_url String 查看交易状态的地址

2.2 获得支付信息

GET /v1/accounts/payments/{:address}/{:hash}

参数 类型 说明
address String 六域链地址
hash String 交易hash
结果:
参数 类型 说明
success Boolean 请求结果
hash String 交易hash
ledger String 区块高度
state String 状态(validated :已完成;pending:交易中)
source_account String 支付方的六域链地址
destination_account String 收款方的六域链地址
direction String 交易类型
amount String 数量
timestamp String 交易时间
fee String 费率
memos Array 支付的备注,对象数组
memo_type String 备注类型
memo_data String 备注内容

2.3 获得支付历史

GET /v1/accounts/payments/{:address}

参数 类型 说明
address String 六域链地址
参数 类型 说明
source_account String
destination_account String 收款方的六域链地址,可选
direction String 交易类型,可选值incoming:收款,outgoing:支付,可选
start_ledger Integer 起始区块高度,可选
end_ledger Integer 结束区块高度,可选
per_page Integer 每页数量,可选
page Integer 页码,可选
结果:
参数 类型 说明
success Boolean 请求结果
payments Object 支付历史,同交易记录中的信息

3 服务器基本信息接口

3.1 获取默认费率

GET /v1/transaction-fee

结果:

                        
参数 类型 说明
success Boolean 请求结果
fee String 当前默认费率

3.2 获取服务器信息

GET /v1/server

结果:

                        
参数 类型 说明
success Boolean 请求结果
sdchaind_server_status Object 六域链服务器状况
complete_ledgers String 完成的区块
server_state String 服务器状况
reserve_base_sda String 激活至少需要的SDA数量

3.3 查看服务器连接

GET /v1/server/connected

结果:

                        
参数 类型 说明
success Boolean 请求结果
connected Boolean 与服务器的连接情况

4 订单接口

4.1 获取订单列表

GET /v1/accounts/orders/{:address}

参数 类型 说明
address String 六域链地址
参数 类型 说明
page String 页码
limit String 每个响应的最大结果
结果:
参数 类型 说明
success Boolean 请求结果
validated String 是否验证
ledger String 区块高度
orders String 订单信息
type String 订单类型
taker_gets Object 收款方的六域链地址
taker_pays String 对方应该花费的数量
currency String 通证名称
counterparty String 发行商
value String 数量

4.2 提交订单

POST /v1/accounts/orders/{:address}

参数 类型 说明
address String 六域链地址
参数 类型 说明
secret String 支付方的钱包私钥
order Object 订单信息
type String 订单类型
taker_pays Object 对方应该花费的数量
currency String 通证名称
counterparty String 发行商
value String 数量
taker_gets Object 对方应该得到的数量
请求数据:

                        
结果:

                        
参数 类型 说明
success Boolean 请求结果
hash String 交易hash
ledger Integer 区块高度
state String 交易状态
order Object 订单信息
taker_gets Object 对方应该得到的数量
taker_pays Object 对方应该花费的数量
Fee String 费率
sequence Integer 订单编号(用于取消订单)

4.3 取消订单

DELETE /v1/accounts/orders/{:address}/{: sequence}

参数 类型 说明
address String 六域链地址
sequence Integer 订单编号
参数 类型 说明
secret String 支付方的钱包私钥
请求数据:

                        
结果:

                        
参数 类型 说明
success Boolean 请求结果
validated String 是否验证
ledger String 区块高度
state String 交易状态
order Object 订单信息
fee String 费率
offer_sequence String 被取消的订单号
sequence String 当前交易号

4.4 查看订单详情

GET /v1/accounts/orders/{:address}/{:hash}

参数 类型 说明
address String 六域链地址
hash String 交易hash
结果:
参数 类型 说明
success Boolean 请求结果
hash String 交易hash
ledger String 区块高度
state String 交易状态
order Object 订单信息
taker_pays Object 对方应该花费的数量
taker_gets Object 对方应该得到的数量
account String 六域链地址
sequence Integer 订单编号
balance_changes Array 余额变化
order_changes Array 订单变化

4.5 获取当前订单列表

GET /v1/order_book/{:base}/{:counter}

参数 类型 说明
base String 基础通证(currency+counterparty或SDA)
counter String 计算通证(currency+counterparty或SDA)
参数 类型 说明
limit String 每个响应的最大结果
结果:
参数 类型 说明
success Boolean 请求结果
validated String 是否验证
ledger String 区块高度
order_book String 交易对
bids Array 买单信息
price Object 单价(amount类型)
taker_gets_total String 对方应该获取的数量(amount类型)
taker_pays_total String 对方应该花费的数量(amount类型)
order_maker String 挂单方地址
asks Array 卖单信息

5 交易历史接口

5.1 获取交易历史

GET /v1/accounts/transactions/{:address}

参数 类型 说明
address String 六域链地址
参数 类型 说明
type String 交易种类:payment,offercreate,offercancel,trustset,可提供多个用“,”隔开
start_ledger Integer 起始区块高度,可选
end_ledger Integer 结束区块高度,可选
per_page Integer 每页数量,可选
page Integer 页码,可选
结果:
参数 类型 说明
success Boolean 请求结果
transactions Array 交易对象数组
hash String 交易hash
ledger String 区块高度
date String 时间
type String 类型
fee String 费率
result String 结果
price String 单价(type=offercreate)
pair String 交易对(type=offercreate)
seq Integer 订单编号(type=offercreate)
counterparty String 对方地址(type=payment)
amount String 数量对象
currency String 币种
value String 数量
counterparty String 发行商地址
effects Array 影响
effect String 影响类型
seq String 订单编号
price String 单价
pair String 交易对
amount String 数量
memos Array 备注

5.2 获取交易详情

GET /v1/accounts/transactions/{:address}/{:hash}

参数 类型 说明
address String 六域链地址
hash String 交易hash
结果:
参数 类型 说明
success Boolean 请求结果
transaction Array 交易对象数组
hash String 交易hash
ledger String 区块高度
date String 时间
type String 类型
fee String 费率
result String 结果
price String 单价(type=offercreate)
pair String 交易对(type=offercreate)
seq Integer 订单编号(type=offercreate)
counterparty String 对方地址(type=payment)
amount String 数量对象
currency String 币种
value String 数量
counterparty String 发行商地址
effects Array 影响
effect String 影响类型
seq String 订单编号
price String 单价
pair String 交易对
amount String 数量
memos Array 备注