api description

api.md

API对接

DEMO：https://exchange.cryptorelay.io/

文档：https://exchange.cryptorelay.io/docs

Restful API

用户注册和登录模块

  signUpByEmail: {method: 'POST', url: 'api/v1/users/signup/email'}, // 使用邮箱进行用户注册
  login: {method: 'POST', url: 'api/v1/users/login'}, // 用户登录
  logout: {method: 'POST', url: 'api/v1/users/logout'}, // 用户退出

用户信息管理模块

getUserBaseInfo: {method: 'GET', url: 'api/v1/users/info/basic'}, // 获取用户基本信息

用户订阅

getUserStream: {method: 'POST', url: 'api/v1/user_stream'},

资产 API

getCoinsInfo: {method: 'GET', url: 'api/v1/coins'}, // 获取系统币种列表
  getAssetsList: {method: 'GET', url: 'api/v1/assets'}, // 获取用户资产列表
  getAssetsByCoin: {method: 'GET', url: coin => `api/v1/assets/${coin}`}, // 获取单币种资产
  getAssetsBySymbol: {method: 'GET', url: 'api/v1/symbol/assets'}, // 获取交易对资产
  getLedgers: {method: 'GET', url: 'api/v1/ledgers'}, // 账单流水 (币币账单)
  getDepositAddress: {method: 'GET', url: 'api/v1/deposit/address'}, // 充值(获取平台钱包地址)

交易相关接口

  getSymbolsList: {method: 'GET', url: 'api/v1/trade/symbols'}, // 获取交易对列表
  doOrderLimit: {method: 'POST', url: 'api/v1/orders/limit'}, // 下单(限价交易)
  cancelOrder: {method: 'POST', url: 'api/v1/orders/cancel'}, // 撤单
  getOrdersList: {method: 'GET', url: 'api/v1/orders'}, // 订单查询
  getOrderDetail: {method: 'GET', url: order_id => `api/v1/orders/${order_id}`}, // 成交信息查询(订单详情)
  getRate: {method: 'GET', url: type => `api/v1/rate/${type}`}, // USD对CNY汇率
  getSymbolInfo: {method: 'GET', url: 'api/v1/symbols'}, // 获取交易对定义和参数信息

行情接口

getKlineBySymbol: {method: 'GET', url: 'api/v1/kline'}, // 获取交易对K线数据
  getTickerBySymbol: {method: 'GET', url: 'api/v1/ticker'}, // 获取交易对ticker
  getTickers: {method: 'GET', url: 'api/v1/tickers'}, // 获取所有交易对的ticker
  getDepthBySymbol: {method: 'GET', url: 'api/v1/depth'}, // 获取交易对深度
  getDealBySymbol: {method: 'GET', url: 'api/v1/latestdeal'}, // 获取交易对最新成交

Websocket API

websocket建立连接后无需主动发送信息，只需要被动接收即可，响应格式请参考DEMO抓包。

KLine连接

为对接tradingview方便，K线可单独一条连接，url为：

window.WS_DOMAIN + '/stream?name=kline_' + resolutions[resolution] + '@' + symbolInfo.name;

业务连接

      let url = window.WS_DOMAIN + '/stream?';
      url += 'name=depth@' + symbol;
      url += '&name=trade@' + symbol;
      url += '&name=ticker';
      if (user_stream) {
        url += '&name=' + user_stream;
      }

user_stream 为用户专用token，内容来自上面的 getUserStream接口的返回。