Get Liquidity Info

API Description

Retrieves liquidity position information for the authenticated user. This endpoint provides detailed data about active liquidity positions including price ranges, liquidity amounts, entry prices, and fees earned.

HTTP Request

GET /v5/liquidity

Request Parameters

Parameter	Type	Required	Description
symbol	string	No	Symbol name (e.g., BTCUSDT)

Response Parameters

Parameter	Type	Description
instrumentAddrress	string	Contract address of the instrument
symbol	string	Trading pair symbol
expiry	number	Expiry timestamp (0 for perpetual)
rid	number	Range ID
lowerPrice	string	Lower price of the range
upperPrice	string	Upper price of the range
entryPrice	string	Entry price for the liquidity position
liquidity	string	Liquidity amount
balance	string	Position balance
feeEarned	string	Total fees earned
blockInfo	object	Block information
-> height	number	Block height
-> timestamp	number	Block timestamp

Request Example

cURL

curl -X GET \
  'https://api.synfutures.com/v5/liquidity' \
  -H 'Content-Type: application/json' \
  -H 'X-BAPI-API-KEY: [api_key]' \
  -H 'X-BAPI-SIGN: [signature]' \
  -H 'X-BAPI-TIMESTAMP: [timestamp]' \
  -H 'X-BAPI-RECV-WINDOW: 5000'

JavaScript (Fetch)

const response = await fetch("https://api.synfutures.com/v5/liquidity", {
    method: "GET",
    headers: {
        "Content-Type": "application/json",
        "X-BAPI-API-KEY": "[api_key]",
        "X-BAPI-SIGN": "[signature]",
        "X-BAPI-TIMESTAMP": "[timestamp]",
        "X-BAPI-RECV-WINDOW": "5000",
    },
});

const data = await response.json();
console.log(data);

Python (requests)

import requests

url = "https://api.synfutures.com/v5/liquidity"
headers = {
    'Content-Type': 'application/json',
    'X-BAPI-API-KEY': '[api_key]',
    'X-BAPI-SIGN': '[signature]',
    'X-BAPI-TIMESTAMP': '[timestamp]',
    'X-BAPI-RECV-WINDOW': '5000'
}

response = requests.get(url, headers=headers)
result = response.json()
print(result)

Response Example

Success Response

{
    "data": [
        {
            "instrumentAddrress": "0x1a8a5872b5b82686e1271a363556335a5f540dae",
            "symbol": "BTC-USDM-EMG",
            "expiry": 4294967295,
            "rid": 667733264400,
            "lowerPrice": "53506386107071788822",
            "upperPrice": "862350691427534759312",
            "entryPrice": "214989165806408815186",
            "liquidity": "5653245650710138332",
            "balance": "100000000000000000000",
            "feeEarned": "1137512146606146",
            "blockInfo": {
                "height": 162708,
                "timestamp": 1761278396
            }
        }
    ],
    "msg": "",
    "code": 200,
    "requestId": "bbf4fa1a-0f41-449f-8d9c-44fdceae0bf7"
}

Error Response

{
    "code": 400,
    "msg": "Request parameter error",
    "data": {},
    "requestId": "bbf4fa1a-0f41-449f-8d9c-44fdceae0bf7"
}