LBank API

https://www.lbank.com/docs/
Admin
LBank API provides authenticated and public endpoints for accessing market data, trading, and...
Tokens:37,893
Snippets:146
Trust Score:9.7
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Deposit History (POST /v2/spot/wallet/deposit_history.do)

Source: https://www.lbank.com/docs/index

Retrieves the user's deposit history. Supports filtering by status, currency, start time, and end time. Returns a list of deposit records, each containing insertion time, amount, address, network name, transaction ID, currency, and status.

```json
[
  {
    "insertTime": 1644378926000,
    "amount": 443,
    "address": "QiEik5W3szxqtjJnzp14apfrY7McUdX9sa",
    "networkName": "lbk20",
    "txId": "0x4baf730c242fe6d85559edb40399daaf8dca16255382a5ce36934f0ff964a776",
    "coin": "lbk",
    "status": "2"
  }
]
```

--------------------------------

### Get Withdrawal History (POST /v2/spot/wallet/withdraws.do)

Source: https://www.lbank.com/docs/index

Fetches the user's coin withdrawal history. Allows filtering by status, currency, withdrawal order ID, start time, and end time. Returns a list of withdrawal records, including amount, currency, address, withdrawal order ID, fee, network name, transfer type, transaction ID, fee asset code, ID, application time, and status.

```json
[
  {
    "amount": 234,
    "coid": "lbk",
    "address": "34252342",
    "withdrawOrderId": "werqwerq123425353",
    "fee": 2,
    "networkName": "lbk30",
    "transferType": "Digital Asset Withdrawal",
    "txId": "",
    "feeAssetCode": "",
    "id": 93182,
    "applyTime": 1644476930000,
    "status": "1"
  }
]
```

--------------------------------

### Get Account Information (HTTP)

Source: https://www.lbank.com/docs/index

Retrieves detailed account information, including trading permissions and asset balances. Requires 'api_key' and 'sign'.

```HTTP
POST /v2/supplement/user_info_account.do

```

--------------------------------

### Get 24hr Ticker Data - HTTP GET

Source: https://www.lbank.com/docs/index

Retrieves the 24-hour LBank coin quote data for a specified trading pair. Excludes Leveraged Tokens. Requires the 'symbol' parameter, which can be a specific pair or 'all'.

```shell
curl "https://api.lbkex.com/v2/ticker/24hr.do?symbol=btc_usdt"
```

--------------------------------

### GET /v2/ticker/24hr.do

Source: https://www.lbank.com/docs/index

Get the 24-hour ticker data for a trading pair, excluding leveraged tokens. This provides a comprehensive overview of market activity.

```APIDOC
## GET /v2/ticker/24hr.do

### Description
GET the LBank coin quote data, excluding Leveraged Tokens trading pairs (get Leveraged Tokens trading pairs `GET /v2/etfTicker/24hr.do`).

### Method
GET

### Endpoint
/v2/ticker/24hr.do

### Parameters
#### Query Parameters
- **symbol** (String) - Yes - Pair. Such as: `eth_btc`, `zec_btc`, `all`.

### Response
#### Success Response (200)
- **symbol** (string) - The trading pair symbol.
- **ticker** (object) - Contains 24-hour market data.
  - **high** (string) - 24 hr highest price.
  - **vol** (string) - 24 hr trading volume.
  - **low** (string) - 24 hr lowest price.
  - **change** (string) - Fluctuation (%) in 24 hr.
  - **turnover** (string) - Total Turn over in 24 hr.
  - **latest** (string) - Latest Price.
- **timestamp** (integer) - Timestamp of latest transaction.

#### Response Example
```json
[
  {
    "symbol": "btc_usdt",
    "ticker": {
      "high": "34161.64",
      "vol": "8925.492",
      "low": "32659.88",
      "change": "-2.67",
      "turnover": "296494557.82",
      "latest": "33220.36"
    },
    "timestamp": 1626170107873
  }
]
```
```

--------------------------------

### Get Leveraged Tokens 24hr Ticker - HTTP GET

Source: https://www.lbank.com/docs/index

Retrieves the 24-hour market data for LBank Leveraged Tokens. Requires the 'symbol' parameter, which can be a specific leveraged token pair or 'all'.

```shell
curl "https://api.lbkex.com/v2/etfTicker/24hr.do?symbol=btc3l_usdt"
```

--------------------------------

### GET /v2/supplement/ticker/bookTicker.do

Source: https://www.lbank.com/docs/index

Retrieve the current optimal pending order (best bid and ask) for a trading pair. This endpoint is useful for high-frequency trading strategies.

```APIDOC
## GET /v2/supplement/ticker/bookTicker.do

### Description
Symbol Order Book Ticker.

### Method
GET

### Endpoint
/v2/supplement/ticker/bookTicker.do

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Coin pair.

### Response
#### Success Response (200)
- **symbol** (string) - The trading pair symbol.
- **askPrice** (string) - The price of the best ask (selling) order.
- **askQty** (string) - The quantity of the best ask order.
- **bidQty** (string) - The quantity of the best bid (buying) order.
- **bidPrice** (string) - The price of the best bid order.

#### Response Example
```json
{
  "symbol": "lbk_usdt",
  "askPrice": "0.011",
  "askQty": "8",
  "bidQty": "1659",
  "bidPrice": "0.01"
}
```
```

--------------------------------

### Get Depth Information - HTTP GET

Source: https://www.lbank.com/docs/index

Retrieves the depth information (bids and asks) for a specified trading pair. Requires 'symbol' and 'size' as parameters. The size determines the number of returned items, ranging from 1 to 200.

```HTTP
GET /v2/depth.do
```

--------------------------------

### Fetch Withdrawal Configurations (REST API)

Source: https://www.lbank.com/docs/index

Retrieves withdrawal configuration details for assets. It is recommended to use the Coin Information endpoint (`GET /v2/assetConfigs.do`) as this endpoint will be deprecated. Returns details such as withdrawal fees, minimums, and scales.

```bash
curl "https://api.lbkex.com/v2/withdrawConfigs.do"
```

--------------------------------

### GET /v2/etfTicker/24hr.do

Source: https://www.lbank.com/docs/index

Retrieve the 24-hour ticker data specifically for LBank Leveraged Tokens. This endpoint provides market data for leveraged products.

```APIDOC
## GET /v2/etfTicker/24hr.do

### Description
Get LBank Leveraged Tokens market data.

### Method
GET

### Endpoint
/v2/etfTicker/24hr.do

### Parameters
#### Query Parameters
- **symbol** (String) - Yes - Pair. Such as: `btc3l_usdt`, `all`.

### Response
#### Success Response (200)
- **symbol** (string) - The leveraged token pair symbol.
- **ticker** (object) - Contains 24-hour market data for the leveraged token.
  - **high** (string) - 24 hr highest price.
  - **vol** (string) - 24 hr trading volume.
  - **low** (string) - 24 hr lowest price.
  - **change** (string) - Fluctuation (%) in 24 hr.
  - **turnover** (string) - Total Turn over in 24 hr.
  - **latest** (string) - Latest Price.
- **timestamp** (integer) - Timestamp of latest transaction.

#### Response Example
```json
[
  {
    "symbol": "btc3l_usdt",
    "ticker": {
      "high": "0.111848",
      "vol": "4460664.1434",
      "low": "0.098938",
      "change": "-3.11",
      "turnover": "463226.2868",
      "latest": "0.104219"
    },
    "timestamp": 1668648723813
  }
]
```
```

--------------------------------

### GET /v2/supplement/ticker/price.do

Source: https://www.lbank.com/docs/index

Fetch the latest price for a specified trading pair. This endpoint provides real-time pricing information.

```APIDOC
## GET /v2/supplement/ticker/price.do

### Description
Get the latest price of the trading pair.

### Method
GET

### Endpoint
/v2/supplement/ticker/price.do

### Parameters
#### Query Parameters
- **symbol** (string) - Optional - Pair

### Response
#### Success Response (200)
- **symbol** (string) - The trading pair symbol.
- **price** (string) - The latest price of the trading pair.

#### Response Example
```json
[
  {
    "symbol": "ht_usdt",
    "price": "97.0000"
  },
  {
    "symbol": "mcc_usdt",
    "price": "10.00"
  },
  {
    "symbol": "un_eth",
    "price": "0.02"
  }
]
```
```

--------------------------------

### Withdrawal Configurations

Source: https://www.lbank.com/docs/index

Retrieves withdrawal configurations for assets. Note: This endpoint is not recommended for use and will be taken down later. Use Coin Information (`GET /v2/assetConfigs.do`) instead.

```APIDOC
## Withdrawal Configurations

### Description
Retrieves withdrawal configurations for assets. **Note:** This endpoint is not recommended for use and will be taken down later. Recommended use: Coin information (`GET /v2/assetConfigs.do`).

### Method
GET

### Endpoint
/v2/withdrawConfigs.do

### Parameters
#### Path Parameters
None

#### Query Parameters
- **assetCode** (String) - Optional - The code of the asset for which to retrieve withdrawal configurations.

### Request Example
```bash
curl "https://api.lbkex.com/v2/withdrawConfigs.do?assetCode=eth"
```

### Response
#### Success Response (200)
- **assetCode** (string) - Code of the token.
- **min** (double) - Minimum amount to withdraw for out-exchange.
- **minTransfer** (double) - Minimum amount to withdraw for in-exchange.
- **canWithDraw** (boolean) - Whether the currency can be withdrawn.
- **fee** (double) - Charged fee for withdrawal (amount).
- **amountScale** (int) - Amount scale for out-exchange.
- **transferAmtScale** (int) - Amount scale for in-exchange.
- **type** (int) - 1: fixed fee, 2: rate fee.
- **chain** (string) - Optional - Chain for USDT (e.g., OMNI or ERC20).

#### Response Example
```json
{
    "amountScale":4,
    "transferAmtScale":4,
    "assetCode":"eth",
    "canWithDraw":"true",
    "fee":0.01,
    "type":1,
    "min":0.01,
    "minTransfer":0.01,
    "chain":1
}
```
```

--------------------------------

### Get User All Coins Information

Source: https://www.lbank.com/docs/index

Retrieves comprehensive information about a user's all coin holdings, including asset balance, usable amount, frozen amount, and detailed network-specific information for each coin. This includes details like withdrawal fees, minimum withdrawal amounts, and deposit limits across different networks.

```http
POST /v2/supplement/user_info.do
```

--------------------------------

### Get Coin Information (Deposit and Withdrawal)

Source: https://www.lbank.com/docs/index

Retrieves configuration details for coins, including whether deposits and withdrawals are enabled for each asset and chain. It also provides fee-related information for transactions. This endpoint is crucial for understanding the operational status and transaction parameters of various cryptocurrencies on the LBK platform.

```curl
curl "https://api.lbkex.com/v2/assetConfigs.do"
```

--------------------------------

### POST /v2/supplement/create_order.do

Source: https://www.lbank.com/docs/index

Places an actual order on the exchange. This endpoint is used to execute buy or sell orders based on the provided trading pair, type, price, and amount.

```APIDOC
## Place an Order

### Description
Executes a real trade by placing an order on the exchange. Specify the trading symbol, order type, price, and amount to initiate a buy or sell transaction.

### Method
POST

### Endpoint
/v2/supplement/create_order.do

### Parameters
#### Request Body
- **api_key** (String) - Required - The API key obtained from the user.
- **symbol** (String) - Required - The trading pair (e.g., `eth_btc`, `zec_btc`).
- **type** (String) - Required - The type of order: `buy`, `sell`, `buy_market`, `sell_market`, `buy_maker`, `sell_maker`, `buy_ioc`, `sell_ioc`, `buy_fok`, `sell_fok`.
- **price** (String) - Conditional - Order price. Must be `>= 0` for buy/sell orders.
- **amount** (String) - Conditional - Amount of transaction. For BTC, must be `>= 0.001`.
- **sign** (String) - Required - Signature of the request parameters.
- **custom_id** (String) - Optional - A user-defined unique ID for the order.
- **window** (Long) - Optional - Order expiration time in milliseconds. Recommended not to exceed 5 seconds due to network latency.

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "symbol": "eth_btc",
  "type": "buy",
  "price": "0.05",
  "amount": "10",
  "sign": "YOUR_SIGNATURE",
  "custom_id": "real_order_456"
}
```

### Response
#### Success Response (200)
- **order_id** (string) - The unique identifier for the placed order.
- **symbol** (string) - The trading pair for which the order was placed.
- **custom_id** (string) - The custom ID provided in the request.

### Response Example
```json
{
  "order_id": "12074652-d827-4f8d-8f52-92a005c6ce53",
  "symbol": "lbk_usdt",
  "custom_id": "12074652-d827"
}
```
```

--------------------------------

### Get Current Time - HTTP GET Request

Source: https://www.lbank.com/docs/contract

This snippet demonstrates how to retrieve the current server time using an HTTP GET request to the specified API endpoint. It outlines the request method, data types, and provides an example of the expected JSON response structure.

```HTTP
GET /cfd/openApi/v1/pub/getTime HTTP/1.1
Host: api.lbank.com
Content-Type: application/x-www-form-urlencoded
```

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

--------------------------------

### Signature Generation Process

Source: https://www.lbank.com/docs/index

Explains the steps to generate the 'sign' parameter, which is crucial for authenticating API requests.

```APIDOC
## Signature Process

This process outlines how to generate the `sign` parameter required for API requests.

### 1. Parameter String Preparation

Collect all required API parameters. Exclude the `sign` parameter itself. Additionally, include three parameters: `signature_method`, `timestamp`, and `echostr`. 

Concatenate these parameters into a string, ordered alphabetically by parameter name. 

**Example for `user_info` API:**
`parameters="api_key=c821db84-6fbd-11e4-a9e3-c86000d26d7c&echostr=P3LHfw6tUIYWc8R2VQNy0ilKmdg5pjhbxC7&signature_method=RSA&timestamp=1585119477235"`

### 2. MD5 Digest Calculation

Compute the MD5 digest of the prepared parameter string. The result should be Hex encoded and in uppercase.

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

### 3. Signature Generation

Use your secret key to sign the `preparedStr`. Two methods are supported:

#### RSA Method (`signature_method = RSA`)

- Use your API key's secret key.
- Sign the `preparedStr` using SHA256WithRSA.
- Base64 encode the resulting signature.

**Java Example:**
```java
public static String RSA_Sign(String preparedStr, String secretKey) {
    try {
        PrivateKey priKey = getPrivateKey(secretKey);
        Signature signature = Signature.getInstance("SHA256WithRSA");
        signature.initSign(priKey);
        signature.update(preparedStr.getBytes(CharEncoding.UTF_8)); // Corrected variable name
        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"); // Corrected constant
        privateKey = keyFactory.generatePrivate(keySpec);
    } catch (NoSuchAlgorithmException | InvalidKeySpecException e) {
        e.printStackTrace();
    }
    return privateKey;
}
```

#### HmacSHA256 Method (`signature_method = HmacSHA256`)

- Use your API key's secret key.
- Compute the HMAC-SHA256 hash of `preparedStr`.

**Java Example:**
```java
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(preparedStr.getBytes()); // Corrected variable name
        hash = byteArrayToHexString(bytes);
    } catch (Exception e) {
        e.printStackTrace();
    }
    return hash;
}
```

### 4. API Submission

Combine the generated `sign` parameter with all other required endpoint parameters. Submit these as `application/x-www-form-urlencoded`.

**Example for `user_info` endpoint submission:**
```
api_key=6a8d4f1a-b040-4ac4-9bda-534d71f4cb28
sign=e73f3b77895d3df27c79481d878a517edd674e8496ed3051b6e70b6d0b1e47bc
```
```

--------------------------------

### Get Historical Transaction Details

Source: https://www.lbank.com/docs/index

Retrieves historical transaction details for a given symbol and time range. Requires API key and signature. Supports filtering by start time, end time, starting transaction ID, and limit.

```HTTP
POST /v2/supplement/transaction_history.do

```

--------------------------------

### Subscribe to K-Line Updates (WebSocket)

Source: https://www.lbank.com/docs/index

This snippet demonstrates how to subscribe to real-time k-line updates for a given trading pair. It requires specifying the desired k-line interval. The returned data includes k-line details like time, open, high, low, close, volume, and trade count.

```json
{
    "action":"subscribe",
    "subscribe":"kbar",
    "kbar":"1min",
    "pair":"eth_btc"
}
```

--------------------------------

### POST /v2/supplement/create_order_test.do

Source: https://www.lbank.com/docs/index

Tests the order creation process without actually placing an order. Useful for validating parameters and ensuring the system is ready to accept orders.

```APIDOC
## Test Order

### Description
This endpoint allows you to test the order creation process without executing a trade. It's useful for validating your request parameters and ensuring the API is correctly configured.

### Method
POST

### Endpoint
/v2/supplement/create_order_test.do

### Parameters
#### Request Body
- **api_key** (String) - Required - The API key obtained from the user.
- **symbol** (String) - Required - The trading pair (e.g., `eth_btc`, `zec_btc`).
- **type** (String) - Required - The type of order: `buy`, `sell`, `buy_market`, `sell_market`, `buy_maker`, `sell_maker`, `buy_ioc`, `sell_ioc`, `buy_fok`, `sell_fok`.
- **price** (String) - Conditional - Order price. Must be `>= 0` for buy/sell orders.
- **amount** (String) - Conditional - Amount of transaction. For BTC, must be `>= 0.001`.
- **sign** (String) - Required - Signature of the request parameters.
- **custom_id** (String) - Optional - A user-defined unique ID for the order.
- **window** (Long) - Optional - Order expiration time in milliseconds. Recommended not to exceed 5 seconds due to network latency.

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "symbol": "eth_btc",
  "type": "buy",
  "price": "0.05",
  "amount": "10",
  "sign": "YOUR_SIGNATURE",
  "custom_id": "test_order_123"
}
```

### Response
#### Success Response (200)
- **order_id** (string) - The unique identifier for the test order.
- **symbol** (string) - The trading pair requested.
- **custom_id** (string) - The custom ID provided in the request.

### Response Example
```json
{
  "order_id": "12074652-d827-4f8d-8f52-92a005c6ce53",
  "symbol": "lbk_usdt",
  "custom_id": "12074652-d827"
}
```
```

--------------------------------

### List Asset Details (POST /v2/supplement/asset_detail.do)

Source: https://www.lbank.com/docs/index

Provides details for listed assets. Returns an object where each key is an asset symbol. For each asset, it includes minimum withdrawal amount, status for station transfers, deposits, and withdrawals, and withdrawal fees.

```json
{
  "htmoon": {
    "minWithdrawAmount": 0,
    "stationDrawStatus": true,
    "depositStatus": false,
    "withdrawFee": 0,
    "withdrawStatus": false
  },
  "phx": {
    "minWithdrawAmount": 0,
    "stationDrawStatus": true,
    "depositStatus": true,
    "withdrawFee": 0,
    "withdrawStatus": true
  }
}
```

--------------------------------

### Obtain Deposit Address (POST /v2/supplement/get_deposit_address.do)

Source: https://www.lbank.com/docs/index

Retrieves the user's deposit address for a specific currency. Requires API key, signature, and currency. Optionally accepts a network name. Returns the deposit address, memo (if applicable), and currency.

```json
{
  "address": "0x1ccbf66250c9a665710e56e00b3a1502495dd269",
  "memo": null,
  "coin": "lbk"
}
```

--------------------------------

### Get Latest Trading Pair Price - HTTP GET

Source: https://www.lbank.com/docs/index

Fetches the latest price for a given trading pair. An optional 'symbol' parameter can be provided to query a specific pair.

```HTTP
GET /v2/supplement/ticker/price.do
```

--------------------------------

### Subscribe to Market Depth Data (WebSocket)

Source: https://www.lbank.com/docs/index

This snippet shows how to subscribe to market depth information, including bid and ask prices and quantities. Users can specify the depth level (e.g., 10, 50, 100) and the trading pair. The returned data provides structured lists of asks and bids.

```json
{
    "action":"subscribe",
    "subscribe":"depth",
    "depth":"100",
    "pair":"eth_btc"
}
```

--------------------------------

### Create LBank Subscribe Key

Source: https://www.lbank.com/docs/index

Generates a subscription key that is valid for 60 minutes. This key is required for subscribing to real-time data streams. It requires an api_key and a signature for authentication.

```curl
curl "https://api.lbkex.com/v2/subscribe/get_key.do"
```

--------------------------------

### Test Order Placement

Source: https://www.lbank.com/docs/index

Simulates placing an order without executing it, allowing users to test their order logic. It requires an API key, symbol, order type, price, and amount. The response includes an order ID, symbol, and custom ID for reference.

```json
{
  "order_id":"12074652-d827-4f8d-8f52-92a005c6ce53",
  "symbol": "lbk_usdt",
  "custom_id": "12074652-d827"
}
```

--------------------------------

### Get Symbol Order Book Ticker - HTTP GET

Source: https://www.lbank.com/docs/index

Retrieves the current optimal pending order information, including ask and bid prices and quantities, for a specified trading pair. Requires the 'symbol' parameter.

```HTTP
GET /v2/supplement/ticker/bookTicker.do
```

--------------------------------

### Get Deposit Address API

Source: https://www.lbank.com/docs/index

Retrieves the deposit address for a specific currency and network.

```APIDOC
## POST /v2/supplement/get_deposit_address.do

### Description
Retrieves the deposit address for a specific currency.

### Method
POST

### Endpoint
/v2/supplement/get_deposit_address.do

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **api_key** (string) - Required - The `api_key` applied by the user
- **sign** (string) - Required - Signature of request parameter
- **networkName** (string) - Optional - Chain name
- **coin** (string) - Required - Currency

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "sign": "YOUR_SIGNATURE",
  "networkName": "eth",
  "coin": "USDT"
}
```

### Response
#### Success Response (200)
- **address** (string) - Deposit address
- **memo** (string) - Memo, if applicable
- **coin** (string) - Currency

#### Response Example
```json
{
  "address": "0x1ccbf66250c9a665710e56e00b3a1502495dd269",
  "memo": null,
  "coin": "lbk"
}
```
```

--------------------------------

### Subscribe to Trade Records (WebSocket)

Source: https://www.lbank.com/docs/index

This snippet demonstrates how to subscribe to real-time trade records for a specific trading pair. The returned data includes trade details such as volume, amount, price, direction (buy/sell), and timestamp.

```json
{
    "action":"subscribe",
    "subscribe":"trade",
    "pair":"eth_btc"
}
```

--------------------------------

### API Key and Authentication

Source: https://www.lbank.com/docs/index

Details on how to authenticate API requests using signatures and required headers.

```APIDOC
## Authentication

### Description
All non-public API calls require signing to protect against unauthorized changes. Specific signature methods and header requirements are detailed below.

### Request Header Setting
Ensure the following parameters are included in every HTTP request:

- `contentType`: `'application/x-www-form-urlencoded'`
- `timestamp`: Current time in milliseconds. It is recommended to obtain this from the `/v2/timestamp.do` endpoint.
- `signature_method`: Either `RSA` or `HmacSHA256`.
- `echostr`: A string of 30 to 40 digits or letters. This can be obtained directly from the SDK and is considered safe.
```

--------------------------------

### POST /v2/supplement/system_ping.do

Source: https://www.lbank.com/docs/index

Test the connectivity of the REST API. This endpoint is useful for health checks and verifying API accessibility.

```APIDOC
## POST /v2/supplement/system_ping.do

### Description
Test whether the Rest API can be connected.

### Method
POST

### Endpoint
/v2/supplement/system_ping.do

### Parameters
This interface does not accept any parameters.

### Response
#### Success Response (200)
An empty JSON object indicates a successful connection.

#### Response Example
```json
{}
```
```

--------------------------------

### Get Current Time

Source: https://www.lbank.com/docs/contract

Retrieves the current server time. This endpoint is useful for timestamping requests or synchronizing with the server.

```APIDOC
## GET /cfd/openApi/v1/pub/getTime

### Description
Get the current time from the server.

### Method
GET

### Endpoint
/cfd/openApi/v1/pub/getTime

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - Empty object.
- **error_code** (integer(int32)) - The error code, 0 for success.
- **msg** (string) - The message associated with the response.
- **result** (string) - The result of the operation.
- **success** (boolean) - Indicates if the request was successful.

#### Response Example
```json
{
    "data": {},
    "error_code": 0,
    "msg": "",
    "result": "",
    "success": true
}
```
```

--------------------------------

### Withdraw User Funds (POST /v2/spot/wallet/withdraw.do)

Source: https://www.lbank.com/docs/index

Initiates a user withdrawal request. Requires API key, signature, withdrawal address, currency, amount, and fee. Optional parameters include network name, memo, mark, address name, and withdrawal order ID. Returns the fee and a unique withdrawal ID.

```json
{
  "fee": 2,
  "withdrawId": 93182
}
```

--------------------------------

### Get Recharge History API

Source: https://www.lbank.com/docs/index

Retrieves the user's recharge history. Allows filtering by status, currency, and time range.

```APIDOC
## POST /v2/spot/wallet/deposit_history.do

### Description
Retrieves the user's recharge history.

### Method
POST

### Endpoint
/v2/spot/wallet/deposit_history.do

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **api_key** (string) - Required - The `api_key` applied by the user
- **sign** (string) - Required - Signature of request parameter
- **status** (string) - Optional - Recharge status: ("1","Applying"),("2","Recharge successful"),("3","Recharge failed"),("4","Already Cancel"), ("5", "Transfer")
- **coin** (string) - Optional - Currency
- **startTime** (string) - Optional - Start time, timestamp in milliseconds, default 90 days ago
- **endTime** (string) - Optional - End time, timestamp in milliseconds, default day

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "sign": "YOUR_SIGNATURE",
  "coin": "USDT",
  "startTime": "1678886400000",
  "endTime": "1678972800000"
}
```

### Response
#### Success Response (200)
- **insertTime** (timestamp) - Insert Time
- **amount** (BigDecimal) - Amount of deposit
- **address** (String) - Quantity
- **networkName** (string) - Chain name
- **txId** (string) - Transaction hash
- **coin** (string) - Currency
- **status** (string) - Status

#### Response Example
```json
[
  {
    "insertTime": 1644378926000,
    "amount": 443,
    "address": "QiEik5W3szxqtjJnzp14apfrY7McUdX9sa",
    "networkName": "lbk20",
    "txId": "0x4baf730c242fe6d85559edb40399daaf8dca16255382a5ce36934f0ff964a776",
    "coin": "lbk",
    "status": "2"
  }
]
```
```

--------------------------------

### POST /v2/supplement/withdraw.do

Source: https://www.lbank.com/docs/index

Initiates a cryptocurrency withdrawal. Supports intra-site transfers and custom withdrawal details.

```APIDOC
## POST /v2/supplement/withdraw.do

### Description
Initiates a cryptocurrency withdrawal. Supports intra-site transfers and custom withdrawal details.

### Method
POST

### Endpoint
/v2/supplement/withdraw.do

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **api_key** (string) - Required - The `api_key` applied by the user
- **sign** (string) - Required - Signature of request parameter
- **address** (string) - Required - Withdrawal address, when type=1, it is the transfer account
- **networkName** (string) - Optional - Chain name, get it through the **Get All Coin Information** interface
- **coin** (string) - Required - Currency
- **amount** (string) - Required - Withdrawal amount
- **memo** (string) - Optional - memo: memo word of bts and dct
- **mark** (string) - Optional - Withdrawal Notes
- **fee** (string) - Required - fee
- **name** (string) - Optional - Remarks of the address. After filling in this parameter, it will be added to the withdrawal address book of the currency.
- **withdrawOrderId** (string) - Optional - Custom withdrawal id
- **type** (string) - Optional - type=1 is for intra-site transfer

### Request Example
```json
{
  "api_key": "your_api_key",
  "sign": "your_signature",
  "address": "withdrawal_address",
  "coin": "BTC",
  "amount": "0.1",
  "fee": "0.0001",
  "networkName": "BTC",
  "type": "0"
}
```

### Response
#### Success Response (200)
- **fee** (BigDecimal) - Fees
- **withdrawId** (int) - Withdrawal ID

#### Response Example
```json
{
  "fee": 0.0001,
  "withdrawId": 93182
}
```
```

--------------------------------

### Subscribe to Market Ticks (WebSocket)

Source: https://www.lbank.com/docs/index

This snippet illustrates how to subscribe to market tick data, which provides a summary of market conditions. It includes information like the highest and lowest prices in the last 24 hours, the latest traded price, trading volume, turnover, and price conversions to CNY and USD.

```json
{
    "action":"subscribe",
    "subscribe":"tick",
    "pair":"eth_btc"
}
```

--------------------------------

### GET /v2/depth.do

Source: https://www.lbank.com/docs/index

Retrieve the depth information for a given trading pair, including asks and bids. This endpoint is crucial for understanding market liquidity.

```APIDOC
## GET /v2/depth.do

### Description
Get depth information.

### Method
GET

### Endpoint
/v2/depth.do

### Parameters
#### Query Parameters
- **symbol** (String) - Required - Trading Pair.
- **size** (Integer) - Required - The count of returned items (1-200).

### Response
#### Success Response (200)
- **asks** (Array) - Depth of asks (Sellers'). Each element is a pair of [price, quantity].
- **bids** (Array) - Depth of bids (Buyers'). Each element is a pair of [price, quantity].

#### Response Example
```json
{
  "asks":[
    [5370.4, 0.32],
    [5369.5, 0.28],
    [5369.24, 0.05],
    [5368.2, 0.079],
    [5367.9, 0.023]
  ],
  "bids":[
    [5367.24, 0.32],
    [5367.16, 1.31],
    [5366.18, 0.56],
    [5366.03, 1.42],
    [5365.77, 2.64]
  ]
}
```
```

--------------------------------

### Get Withdrawal History API

Source: https://www.lbank.com/docs/index

Retrieves the user's coin withdrawal history. Supports filtering by status, currency, and time range.

```APIDOC
## POST /v2/spot/wallet/withdraws.do

### Description
Retrieves the user's coin withdrawal history.

### Method
POST

### Endpoint
/v2/spot/wallet/withdraws.do

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **api_key** (string) - Required - The `api_key` applied by the user
- **sign** (string) - Required - Signature of request parameter
- **status** (string) - Optional - status: ("1","Applying"),("2","Cancelled"),("3","Withdrawal failed"),("4","Withdrawal complete")
- **coin** (string) - Optional - Currency
- **withdrawOrderId** (string) - Optional - Custom withdrawal id
- **startTime** (string) - Optional - Start time, timestamp in milliseconds, default 90 days ago
- **endTime** (string) - Optional - End time, timestamp in milliseconds, default day

### Request Example
```json
{
  "api_key": "YOUR_API_KEY",
  "sign": "YOUR_SIGNATURE",
  "coin": "USDT",
  "status": "4",
  "startTime": "1678886400000",
  "endTime": "1678972800000"
}
```

### Response
#### Success Response (200)
- **amount** (BigDecimal) - Amount
- **coid** (string) - Currency
- **address** (string) - Withdrawal address
- **withdrawOrderId** (string) - Withdraw customer custom id
- **fee** (BigDecimal) - Fee
- **networkName** (string) - Chain name
- **transferType** (string) - Withdrawal type
- **txId** (string) - Transaction hash
- **feeAssetCode** (string) - The currency of the fee, the currency of the delisting will be displayed
- **id** (int) - Reminder ID
- **applyTime** (timestamp) - Application time
- **status** (string) - Status

#### Response Example
```json
 [
  {
    "amount": 234,
    "coid": "lbk",
    "address": "34252342",
    "withdrawOrderId": "werqwerq123425353",
    "fee": 2,
    "networkName": "lbk30",
    "transferType": "Digital Asset Withdrawal",
    "txId": "",
    "feeAssetCode": "",
    "id": 93182,
    "applyTime": 1644476930000,
    "status": "1"
  }
]
```
```

--------------------------------

### GET /v2/supplement/trades.do

Source: https://www.lbank.com/docs/index

Retrieves a list of recent transactions for a given trading pair. You can specify the number of results and a timestamp to fetch data after a certain point.

```APIDOC
## Recent Transactions List

### Description
Lists recent transactions for a specified trading symbol. Allows filtering by the number of records and a timestamp.

### Method
GET

### Endpoint
/v2/supplement/trades.do

### Parameters
#### Query Parameters
- **symbol** (string) - Required - Coin pair (e.g., 'BTC_USDT').
- **size** (string) - Required - Number of transactions to return.
- **time** (string) - Optional - Returns data after this timestamp. If empty, returns the latest data.

### Response
#### Success Response (200)
- **quoteQty** (number) - The quantity of the quote currency traded.
- **price** (number) - The price at which the transaction occurred.
- **qty** (number) - The quantity of the base currency traded.
- **id** (string) - Unique identifier for the transaction.
- **time** (number) - Timestamp of the transaction in milliseconds.
- **isBuyerMaker** (boolean) - Indicates if the buyer was the maker.

### Response Example
```json
[
  {
    "quoteQty": 0.022,
    "price": 0.011,
    "qty": 2,
    "id": "10e71fd6-99ab-425e-939d-1447dfbe594e",
    "time": 1644396172793,
    "isBuyerMaker": true
  }
]
```
```

--------------------------------

### Query All Orders History (Lbank API)

Source: https://www.lbank.com/docs/index

Retrieves a history of all orders, with a default query for orders placed within the last 24 hours. Requires api_key, sign, symbol, current_page, and page_length. The status parameter can filter orders. Returns a JSON array of order objects.

```json
[
  {
    "symbol": "lbk_usdt", 
    "orderId": "5ca3ced8-74ea-46eb-9365-ad78c2c6f606", 
    "clientOrderId": "10e71fd6-99ab-425e-939d-1447dfbe594e", 
    "price": "0.1", 
    "origQty": "1.0", 
    "executedQty": "0.0", 
    "cummulativeQuoteQty": "0.0", 
    "status": "3", 
    "type": "buy", 
    "time": 1499827319559, 
    "updateTime": 1499827319559, 
    "origQuoteOrderQty": "0.000000"
  }
]
```

--------------------------------

### System Status API

Source: https://www.lbank.com/docs/index

Checks the current system status of the LBKEX platform.

```APIDOC
## POST /v2/supplement/system_status.do

### Description
Get system status.

### Method
POST

### Endpoint
/v2/supplement/system_status.do

### Parameters
This interface does not accept any parameters.

### Request Example
```json
{
  "status": "1"
}
```

### Response
#### Success Response (200)
- **status** (string) - System status: 0 for system maintenance, 1 for normal operation.

#### Response Example
```json
{
  "status": "1"
}
```
```

--------------------------------

### Order Placement API

Source: https://www.lbank.com/docs/index

Endpoint for placing various types of orders (limit, market, maker, IOC, FOK) with detailed parameter specifications.

```APIDOC
## POST /v1/supplement/order.do

### Description
Endpoint for placing various types of orders including limit, market, maker, IOC, and FOK orders. It requires detailed parameter specifications for order execution.

### Method
POST

### Endpoint
/v1/supplement/order.do

### Parameters
#### Query Parameters
- **api_key** (String) - Required - the `api_key` applied by the user
- **symbol** (String) - Required - Transaction pair `eth_btc`: Ethereum; `zec_btc`: Zerocoin
- **type** (String) - Required - The type of the order, including `buy, sell, buy_market, sell_market, buy_maker, sell_maker, buy_ioc, sell_ioc, buy_fok, sell_fok`
- **price** (String) - Optional - Order price. For Buy and sell orders: `greater than or equal to 0`
- **amount** (String) - Optional - Amount of transactions. For Sell order and sell order: `BTC` amount is greater than or equal to `0.001`
- **sign** (String) - Required - signature of request parameter
- **custom_id** (String) - Optional - User-defined ID, do not repeat by yourself
- **window** (Long) - Optional - Expiration time of order in milliseconds. Automatic cancellation of order after timeout (considering the public network time, it is recommended not to exceed 5s).

### Request Example
```json
{
  "api_key": "your_api_key",
  "symbol": "eth_btc",
  "type": "buy_limit",
  "price": "0.05",
  "amount": "1.0",
  "sign": "your_signature",
  "custom_id": "user_defined_id_123",
  "window": 5000
}
```

### Response
#### Success Response (200)
- **symbol** (String) - The trading pair
- **origClientOrderId** (String) - User-defined ID
- **orderId** (String) - Order ID
- **price** (String) - Order price
- **origQty** (String) - Original quantity
- **executedQty** (String) - Executed quantity
- **status** (Integer) - Order status (e.g., 3 for filled)
- **timeInForce** (String) - Time in force
- **tradeType** (String) - Type of trade (buy/sell)

#### Response Example
```json
{
  "symbol": "lbk_usdt",
  "origClientOrderId": "10e71fd6-99ab-425e-939d-1447dfbe594e",
  "orderId": "46a1e423-be95-4ded-8887-a489d38577a8",
  "price": "2.00000000",
  "origQty": "1.00000000",
  "executedQty": "0.00000000",
  "status": 3,
  "timeInForce": "GTC",
  "tradeType": "buy"
}
```
```
Tokens:
Raw