Get Position Info

API Description

Retrieves current position information for the authenticated user. This endpoint provides detailed data about open positions including size, entry price, unrealized P&L, and margin information.

HTTP Request

GET /v5/position/list

Request Parameters

Parameter	Type	Required	Description
symbol	string	No	Symbol name (e.g., BTCUSDT)
limit	number	No	Number of records (max 50)
cursor	string	No	Cursor for pagination

Response Parameters

Parameter	Type	Description
side	string	Position side (LONG, SHORT)
size	string	Position size
balance	string	Position balance
averagePrice	string	Average entry price
entryNotional	string	Total entry value
markPrice	string	Current mark price
liquidationPrice	string	Liquidation price
leverage	string	Leverage used
unrealisedPnl	string	Unrealized profit or loss
unrealisedFunding	string	Unrealized funding fee
blockInfo	object	Block information
-> height	number	Block height
-> timestamp	number	Block timestamp

Request Example

cURL

curl -X GET \
  'https://api.synfutures.com/v5/position/list?category=linear' \
  -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/position/list?category=linear",
    {
        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/position/list"
params = {
    'category': 'linear'
}
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, params=params)
result = response.json()
print(result)

Response Example

Success Response

{
    "data": [
        {
            "instrumentAddrress": "0x1a8a5872b5b82686e1271a363556335a5f540dae",
            "symbol": "BTC-USDM-EMG",
            "expiry": 4294967295,
            "side": "SHORT",
            "size": "-2232542969583470342",
            "balance": "219761835607103586531",
            "averagePrice": "230904842111879797449",
            "entryNotional": "448163390059929941125",
            "markPrice": "230904842111879797449",
            "liquidationPrice": "230904842111879797449",
            "leverage": "10",
            "unrealisedPnl": "100.00",
            "unrealisedFunding": "100.00",
            "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"
}