简介

欢迎使用LBANK API！ 你可以使用此 API 获得合约市场行情数据，进行交易，并且管理你的账户。此文档是v1版本的，会持续更新。

接口是提供服务的基础，API分为账户、交易和行情三类。开发者在网站创建账号后，可以根据自身需求建立不同权限的API，并利用API进行自动交易或者提现。

账户和交易API需要身份验证，提供下单、撤单，查询订单和帐户信息等功能。行情API提供市场的行情数据，所有行情接口都是公开的。

流程

开发者如需使用API ，请先申请API key，并勾选合约权限等信息 点击申请API Key，然后根据此文档详情进行开发，使用过程中如有问题或者建议请及时反馈。

API Key包括以下两个部分

• API Key API访问密钥
• Secret Key 签名认证加密所使用的密钥（仅申请时可见）

LBank支持RSA和HmacSHA256两种签名方式

• RSA方案是基于数学困难问题的数字签名方案，是非对称密码的身份认证方案。发送方对消息报文、用户私钥等进行约定的编码与运算得到数字签名。接收方通过数字签名、用户注册公钥来确定身份与消息报文的完整性。相对地，由于在RSA方案的验证过程中，接收方无需发送者的私钥信息，可以保证有且只有发送方能发送合法消息。由于使用非对称加密技术，RSA安全性较高，但加解密速度较慢。
• HMAC方案是基于hash函数的消息认证方案，是对称模式的密码方案。发送方对消息报文、共享密钥等进行约定的编码与运算后得出消息认证码。接收方通过该消息认证码来确定发送方身份与消息报文的完整性。HMAC方案基于hash函数具有高安全性和高效性等特点，其加解密速度较快，但由于其密钥需要在客户端和服务端之间共享，因此安全性没有RSA高。

用户可根据自己的实际使用需求，选择不同的签名认证方式。

接入说明

接入URL

rest

​ https://lbkperp.lbank.com/

Websocket

​ wss://lbkperpws.lbank.com/ws

接口分类

​ 公共接口：/cfd/openApi/v1/pub

​ 私有接口：/cfd/openApi/v1/prv （需要认证访问）

签名认证

​ API 请求在通过 internet 传输的过程中极有可能被篡改，为了确保请求未被更改，除公共接口（基础信息，行情数据）外的私有接口均必须使用您的 API Key 做签名认证，以校验参数或参数值在传输途中是否发生了更改。每一个API Key需要有适当的权限才能访问相应的接口。每个新创建的API Key都需要分配权限。权限类型分为：交易，只读，和提现。在使用接口前，请查看每个接口的权限类型，并确认你的API Key有相应的权限。

请求头设置

post请求，请求头信息中 contentType 需要统一设置为: 'application/json'。

contentType:'application/json'

请求头增加timestamp参数，您发出请求的时间戳（毫秒），如：1567833674095。在查询请求中包含此值有助于防止第三方截取您的请求。建议通过 /cfd/openApi/v1/pub/getTime API接口获取。

请求头增加signature_method参数，RSA/HmacSHA256，目前两种都支持。

请求头增加echostr参数，该参数为字母和数字字符串，长度30到40间。

签名流程（如何生成API请求参数中的sign）

1. 准备待签名字符串:

每个API中所需的请求参数，去除sign，再加上signature_method，timestamp，echostr三个参数(这三个参数需要和header中的保持一致)，组成了需要参与签名的字符串。同时，待签名字符串要求按照参数名进行排序（首先比较所有参数名的第一个字母，按abcd顺序排列，若遇到相同首字母,则看第二个字母, 以此类推。）以下使用prv/account接口，并以Java代码作为举例，所需签名的字符串为

string parameters="api_key=fb4e39e5-6a06-4291-9f80-d10176a0badd&asset=USDT&echostr=echostr123456789012345678901234567890&productGroup=SwapU&signature_method=HmacSHA256&timestamp=1665990154559"

2. 待签名字符串转成所有字符大写的MD5摘要:

将parameters转成MD5摘要，并将所有字符转换成大写

string preparedStr = DigestUtils.md5Hex(parameters).toUpperCase()

3. 签名:

使用RSA或者HmacSHA256方式，以及api_key对应的secret key，对preparedStr进行签名，得到最终的sign。

RSA方式(signature_method = RSA):

使用api_key对应的secret key，通过RSA使用SHA256算法对preparedStr做一次签名(用Base64编码)，并将最终的签名结果赋值于参数sign。可参考shell中的Java代码。

RSA示例:

    public static String RSA_Sign(String preparedStr, String secretKey) {
        try {
            PrivateKey priKey = getPrivateKey(secretKey);
            Signature signature = Signature.getInstance("SHA256WithRSA");
            signature.initSign(priKey);
            signature.update(content.getBytes(CharEncoding.UTF_8));
            byte[] signed = signature.sign();
            return new String(Base64.getEncoder().encode(signed));
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    private static PrivateKey getPrivateKey(String key) {
        PKCS8EncodedKeySpec keySpec = new PKCS8EncodedKeySpec(Base64.getDecoder().decode(key));
        PrivateKey privateKey = null;
        try {
            KeyFactory keyFactory = KeyFactory.getInstance(RSA);
            privateKey = keyFactory.generatePrivate(keySpec);
        } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
            e.printStackTrace();
        }
        return privateKey;
    }

HmacSHA256方式(signature_method = HmacSHA256):

使用api_key对应的secret key，对preparedStr进行哈希运算，并将最终的签名结果赋值于参数sign。可参考shell中的Java代码。

HmacSHA256示例:

    public static String HmacSHA256_Sign(String preparedStr, String secretKey) {
        String hash = "";
        try {
            Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
            SecretKeySpec secret_key = new SecretKeySpec(secretKey.getBytes(), "HmacSHA256");
            sha256_HMAC.init(secret_key);
            byte[] bytes = sha256_HMAC.doFinal(message.getBytes());
            hash = byteArrayToHexString(bytes);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return hash;
    }

提交

将签名后的得到的sign，以及其他所需参数提交。以prv/account接口举例，需要提交的参数为：

api_key=fb4e39e5-6a06-4291-9f80-d10176a0badd&asset=USDT&echostr=echostr123456789012345678901234567890&productGroup=SwapU&signature_method=HmacSHA256&timestamp=1665990154559

sign=809133cb69a17beba0be076b99b4d90de872476e36da87978ab2889970ccd06d

请求格式

所有的API请求都以GET或者POST形式发出。

并且所有请求头都包含设置三个参数Content-Type:application/json、timestamp:1665990154559、signature_method:RSA、echostr:echostr123456789012345678901234567890。

所有get请求的参数都在路径参数里,RSA方式需要urlencode一下，避免签名后字符串中特殊字符被转义为空格。post 以json提交

返回格式

测试账号

String privateKey = "093F44F700FC48F17DDB67390C895CE5";
  String apikey = "fb4e39e5-6a06-4291-9f80-d10176a0badd"
  String signature_method = "HmacSHA256";

错误码

基础数据

获取当前时间

接口地址:/cfd/openApi/v1/pub/getTime

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取当前时间

请求参数:

暂无

响应参数:

响应示例:

{
    "data": {},
    "error_code": 0,
    "msg": "",
    "result": "",
    "success": true
}

查询合约信息列表

接口地址:/cfd/openApi/v1/pub/instrument

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

查询合约信息列表

请求参数:

响应参数:

响应示例:

[
    {
        "baseCurrency": "",
        "clearCurrency": "",
        "defaultLeverage": 0,
        "exchangeID": "",
        "maxOrderVolume": "",
        "minOrderCost": "",
        "minOrderVolume": "",
        "priceCurrency": "",
        "priceLimitLowerValue": 0,
        "priceLimitUpperValue": 0,
        "priceTick": 0,
        "symbol": "",
        "symbolName": "",
        "volumeMultiple": 0,
        "volumeTick": 0
    }
]

查询合约行情列表

接口地址:/cfd/openApi/v1/pub/marketData

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

查询合约行情列表

请求参数:

响应参数:

响应示例:

[
    {
        "highestPrice": "",
        "lastPrice": "",
        "lowestPrice": "",
        "markedPrice": "",
        "openPrice": "",
        "prePositionFeeRate": "",
        "symbol": "",
        "turnover": "",
        "volume": ""
    }
]

获取盘口

接口地址:/cfd/openApi/v1/pub/marketOrder

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取盘口

请求参数:

响应参数:

响应示例:

{
    "asks": [
        {
            "orders": 0,
            "price": 0,
            "volume": 0
        }
    ],
    "bids": [
        {
            "orders": 0,
            "price": 0,
            "volume": 0
        }
    ],
    "symbol": ""
}