折合CNY

折合CNY

折合USD

简体中文
官方公告 新闻资讯 常见问题 关于我们 使用条款 隐私政策 联系我们 费用 API说明

API文档

一、API使用说明

1、请求过程说明

2、安全认证

3、接口

3.1获取当前最新行情 - Ticker

3.2市场深度 - Depth

3.3账户信息 - Balance

3.4挂单查询 - Trust_list

3.5查询订单信息 - Trust_view

3.6取消订单 - Trust_cancel

3.7下单 - Trust_add

4.错误代码对照表

二、API实例代码

一、API使用说明

1、请求过程说明

1.1 构造请求数据,用户数据按照BTCTRADE提供的接口规则,通过程序生成签名和要传输给BTCTRADE的数据集合;

1.2 发送请求数据,把构造完成的数据集合通过POST/GET提交的方式传递给BTCTRADE;

1.3 BTCTRADE对请求数据进行处理,服务器在接收到请求后,会首先进行安全校验,验证通过后便会处理该次发送过来的请求;

1.4 返回响应结果数据,BTCTRADE把响应结果以JSON的格式反馈给用户,具体的响应格式,错误代码参见接口部分;

1.5 对获取的返回结果数据进行处理;

1.6 Domain : api.btctrade.im ;

2、安全认证

所有的private API都需要经过认证

Api的申请可以到财务中心 -> API,申请得到私钥和公钥,私钥BTCTRADE将不做储存,一旦丢失将无法找回

注意:请勿向任何人泄露这两个参数,这像您的密码一样重要

3、签名机制

每次请求private api 都需要验证签名,发送的参数示例:

$param = array(

amount => 1,

price => 10000,

type => 'buy',

nonce => 141377098123

key => 5zi7w-4mnes-swmc4-egg9b-f2iqw-396z4-g541b

signature => 459c69d25c496765191582d9611028b9974830e9dfafd762854669809290ed82

);

nonce 可以理解为一个递增的整数:http://zh.wikipedia.org/wiki/Nonce

key 是申请到的公钥

signature是签名,是将amount price type nonce key等参数通过'&'字符连接起来通过md5(私钥)为key进行sha256算法加密得到的值.

4、接口

Ticker(牌价)

Path:/api/v1/ticker/region/{btc|usc}

Request类型:GET

参数

coin - eth

region - 交易区:可选,btc、usc, 默认btc

返回JSON dictionary

high - 最高价

low - 最低价

buy - 买一价

sell - 卖一价

last - 最近一次成交价

vol - 成交量

返回结果示例

{
    "code" : 0,
    "msg" : "Suceess",
    "result": true,
    "data":[
        "high":22,
        "low":20,
        "buy":1.879,
        "sell":0,
        "last":38800,
        "vol":283.954
    ]
}

Depth(市场深度)

描述:返回所有的市场深度,此回应的数据量会较大,所以请勿频繁调用。

Path:/api/v1/depth/region/{btc|usc}

Request类型:GET

参数

region - 交易区:可选,btc、usc, 默认btc

coin - coin

返回JSON dictionary

asks - 委买单[价格, 委单量],价格从高到低排序

bids - 委卖单[价格, 委单量],价格从高到低排序

返回结果示例:

{
    "code" : 0,
    "msg" : "Suceess",
    "result": true,
    "asks": [
        [70000, 5],
        [69000, 0.48],
        [67000, 0.9999],
        [64498, 0.02]
        ...
    ],
    "bids": [
        [38300, 1.879],
        [38100, 1.0078],
        [38000, 1.24],
        [37700, 4.706]
        ...
    ]
}

只读权限方法列表

Account Balance(账户信息)

列举您的帐户信息

Path:/api/v1/balance/

Request类型:POST

参数

key - API key

signature - signature

nonce - nonce

返回JSON dictionary

eth_balance - ETH总余额

btc_balance - 比特币总余额

eth_lock - ETH冻结余额

btc_lock - 比特币冻结余额

返回结果示例:

{
    "code" : 0,
    "msg" : "Suceess",
    "result": true,
    "data": {
        "uid": "1",
        "xas_balance": 1,
        "xas_lock": 0,
        "eth_balance": 1,
        "eth_lock": 0,
        "btc_balance": 1,
        "btc_lock": 0
    }
}

Trust_list(挂单查询)

您指定时间后的挂单,可以根据类型查询,比如查看正在挂单和全部挂单

Path:/api/v1/trust_list/region/{btc|usc}

Request类型:POST

参数

key - API key

signature - signature

nonce - nonce

since - unix timestamp(utc timezone) default == 0, i.e. 返回所有

coin - coin

region - 交易区:可选,btc、usc, 默认btc

type - 挂单类型[open:正在挂单, all:所有挂单]

返回JSON dictionary

id - 挂单ID

coin - eth

datetime - 时间戳

type - "buy" or "sell"

price - price

status - 状态:1 ( 新挂单 ) 2 ( 开放交易 ), 3 ( 撤销 ), 4 ( 完全成交 )

amount_total - 委托数量

amount_remain - 未成交数量

返回结果示例:

{
    "code" : 0,
    "msg" : "Suceess"
    "data": [{
        "id": "28",
        "datetime": "1508737051",
        "type": "sell",
        "price": 0.000123,
        "amount_total": 1213,
        "amount_remain": 1213
    }]
}

Trust_view(查询订单信息)

Path:/api/v1/trust_view/region/{btc|usc}

Request类型:POST

参数

key - API key

signature - signature

nonce - nonce

id - 挂单ID

coin - coin

region - 交易区:可选,btc、usc, 默认btc

返回JSON dictionary

id - 挂单ID

datetime - 挂单时间(格式:时间戳)

type - "buy" or "sell"

price - 挂单价

num_total - 委托数量

num_over - 未成交数量

status - 状态:1 ( 新挂单 ) 2 ( 开放交易 ), 3 ( 撤销 ), 4 ( 完全成交 )

返回结果示例:

{
    "code": 0,
    "msg": "Suceess",
    "data": {
        "id": 28,
        "datetime": "1508737051",
        "type": "sell",
        "price": 0.000123,
        "num_total": 1213,
        "num_over": 1213,
        "status": "4"
    }
}

完整权限方法列表

Trust_cancel(取消订单)

Path:/api/v1/trust_cancel/region/{btc|usc}

Request类型:POST

参数

key - API key

signature - signature

nonce - nonce

id - 挂单ID

coin - coin

region - 交易区:可选,btc、usc, 默认btc

返回JSON dictionary

code - 0(成功), 其他(失败)

id - 订单ID

返回结果示例:

{
    "code": 0,
    "msg": "Suceess",
    "result": true,
    "data": {
        "id": 28
    }
}

Trust_add(下单)

Path:/api/v1/trust_add/region/{btc|usc}

Request类型:POST

参数

key - API key

signature - signature

nonce - nonce

amount - 购买数量

price - 购买价格

type - 买单或者卖单

coin - coin

region - 交易区:可选,btc、usc, 默认btc

返回JSON dictionary

id - 挂单ID

code - 0(成功), 其他(失败)

返回结果示例:

{
    "code": 0,
    "msg": "Suceess",
    "result": true,
    "data": {
        "id": 28
    }
}

DEMO

PHP

PYTHON

错误代码对照表

错误代码 详细描述
10000 必选参数不能为空
10001 参数错误
10002 委托不存在
10003 币种不存在
10004 币种下架
10005 KEY错误
10006 签名错误
10007 权限不足
10008 Nonce过期
10009 价格精度错误
10010 价格错误
10011 数量错误
10012 数量精度错误
10014 委托正在处理
10015 撤销委托失败
20000 用户不存在
5000x 系统错误
50005 余额不足

电报

APP

客服

360网站安全检测平台