Introduction

Welcome to the LBANK API! You can use this API to get contract market data, place trades, and manage your account. This document is version v1 and will be updated continuously.

The interface is the basis for providing services, and the API is divided into three categories: account, transaction and market. After creating an account on the website, developers can create APIs with different permissions according to their own needs, and use the APIs for automatic transactions or cash withdrawals.

Account and transaction APIs require identity verification and provide functions such as placing orders, canceling orders, and querying order and account information. The market quotation API provides market quotation data, and all market quotation interfaces are public.

process

If the developer needs to use the API, please apply for the API key first, and check the information such as contract permissions and click Apply API Key, and then according to this document The details are developed, and if you have any questions or suggestions during use, please give feedback in time.

API Key includes the following two parts

• API Key API access key
• Secret Key The key used for signature authentication and encryption (only visible when applying)

LBank supports two signature methods: RSA and HmacSHA256

• The RSA scheme is a digital signature scheme based on mathematically difficult problems and an identity authentication scheme for asymmetric cryptography. The sender performs the agreed encoding and operation on the message message, the user's private key, etc. to obtain a digital signature. The receiver determines the identity and the integrity of the message message through digital signature and user registration public key. In contrast, since the receiver does not need the sender's private key information during the verification process of the RSA scheme, it can be guaranteed that there is and only the sender can send legitimate messages. Due to the use of asymmetric encryption technology, RSA has high security, but the encryption and decryption speed is slow.
• The HMAC scheme is a message authentication scheme based on a hash function and a symmetric mode encryption scheme. The sender obtains the message authentication code after performing the agreed encoding and operation on the message message and the shared key. The receiver uses the message authentication code to determine the identity of the sender and the integrity of the message. The HMAC scheme is based on the hash function and has the characteristics of high security and high efficiency. Its encryption and decryption speed is fast, but because its key needs to be shared between the client and the server, the security is not as high as RSA.

Users can choose different signature authentication methods according to their actual needs.

access instructions

access URL

rest

https://lbkperp.lbank.com/

Websockets

wss://lbkperpws.lbank.com/ws

Interface Classification

Public interface: /cfd/openApi/v1/pub

Private interface: /cfd/openApi/v1/prv (requires authenticated access)

Signature authentication

API requests are very likely to be tampered with during transmission over the internet. In order to ensure that the request has not been changed, all private interfaces except the public interface (basic information, market data) must use your API Key for signature authentication to verify Whether the parameter or parameter value was changed in transit. Each API Key requires appropriate permissions to access the corresponding interface. Every newly created API Key needs to be assigned permissions. Permission types are divided into: transaction, read-only, and withdrawal. Before using an interface, please check the permission type of each interface and confirm that your API Key has the corresponding permission.

Request header settings

For post requests, the contentType in the request header information needs to be uniformly set to: 'application/json'.

contentType: 'application/json'

Add the timestamp parameter to the request header, the timestamp (milliseconds) of your request, such as: 1567833674095. Including this value in your query request helps prevent third parties from intercepting your request. It is recommended to obtain it through the /cfd/openApi/v1/pub/getTime API interface.

The request header adds signature_method parameter, RSA/HmacSHA256, currently both are supported.

The echostr parameter is added to the request header, which is a string of letters and numbers with a length between 30 and 40.

Signature process (how to generate sign in API request parameters)

1. Prepare the string to be signed:

The request parameters required in each API, remove sign, plus signature_method, timestamp, echostr three parameters (these three parameters need to be consistent with those in the header), constitute the need to participate The signed string. At the same time, the string to be signed is required to be sorted according to the parameter name (first compare the first letter of all parameter names, and arrange them in abcd order, if the same first letter is encountered, then look at the second letter, and so on.) The following uses prv/account interface, and taking Java code as an example, the required signature string is

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

2. The MD5 digest of the character string to be signed into uppercase characters:

Convert parameters to MD5 digest and convert all characters to uppercase

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

3. Signature:

Sign preparedStr using RSA or HmacSHA256 and the secret key corresponding to api_key to get the final sign.

RSA method(signature_method = RSA):

Use the secret key corresponding to api_key to sign preparedStr using the SHA256 algorithm through RSA (encoded in Base64), and assign the final signature result to the parameter sign. Refer to the Java code in the shell.

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 method (signature_method = HmacSHA256):

Use the secret key corresponding to api_key to hash preparedStr, and assign the final signature result to the parameter sign. Refer to the Java code in the shell.

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;
    }

submit

Submit the signed sign and other required parameters. Taking the prv/account interface as an example, the parameters that need to be submitted are:

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

sign=809133cb69a17beba0be076b99b4d90de872476e36da87978ab2889970ccd06d

Request format

All API requests are sent as GET or POST.

And all request headers include setting three parameters Content-Type: application/json, timestamp: 1665990154559, signature_method: RSA, echostr: echostr123456789012345678901234567890.

All get request parameters are in the path parameters, RSA method requires urlencode to avoid special characters in the string being escaped into spaces after signing. post submitted as json

return format

test account

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

error code

Basic data

Get the current time

Interface address: /cfd/openApi/v1/pub/getTime

Request method:GET

Request data type: application/x-www-form-urlencoded

Response data type:*/*

Interface description:

Get the current time

Request parameters:

no yet

Response parameters:

Response Example:

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

Query contract information list

Interface address: /cfd/openApi/v1/pub/instrument

Request method:GET

Request data type: application/x-www-form-urlencoded

Response data type:*/*

Interface description:

Query contract information list

Request parameters:

Response parameters:

Response Example:

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

Query contract market list

Interface address: /cfd/openApi/v1/pub/marketData

Request method:GET

Request data type: application/x-www-form-urlencoded

Response data type:*/*

Interface description:

Query the list of contract quotations

Request parameters:

Response parameters:

Response Example:

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

Get handicap

Interface address: /cfd/openApi/v1/pub/marketOrder

Request method:GET

Request data type: application/x-www-form-urlencoded

Response data type:*/*

Interface Description:

Get Handicap

Request parameters:

Response parameters:

Response Example:

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