Skip to content

GET /api/v1/market/margin-trading

Margin trading balance and flows by market.

Returns margin trading balance, buy, repay, short balance, and short sell data by market.

Request

GET /api/v1/market/margin-trading

Headers

HeaderValue
F-API-KEYYour API key

Query Parameters

ParameterTypeRequiredFilterDescription
marketstringNoexactMarket identifier
trade_datestringNoexactTrade date (YYYY-MM-DD)
sourcestringNoexactData source
date_fromstringNorangeStart date
date_tostringNorangeEnd date
limitintegerNoMax rows per page (default 100, max 1000)
offsetintegerNoRows to skip (default 0)
sortstringNoSort field (default trade_date)
orderasc | descNoSort direction (default desc)

Example

Terminal window
curl -H "F-API-KEY: fk-xxxxx" \
"https://finance-api.xp-java.workers.dev/api/v1/market/margin-trading?market=SH&date_from=2024-01-01&date_to=2024-01-31"

Response

{
"code": 0,
"message": "ok",
"data": [
{
"market": "SH",
"trade_date": "2024-01-02",
"margin_balance": 850000000000,
"margin_buy": 52000000000,
"margin_repay": 48000000000,
"short_balance": 12000000000,
"short_sell": 1500000000,
"short_repay": 1800000000,
"source": "exchange",
"updated_at": "2024-01-02T15:30:00Z"
}
],
"meta": {
"total": 22,
"limit": 100,
"offset": 0,
"has_more": false
}
}