Cross-Margin Orders Channel

Description

Request Example

{
    "args":[
        {
            "channel":"orders-crossed",
            "instId":"BTCUSDT",
            "instType":"MARGIN"
        }
    ],
    "op":"subscribe"
}

Request Parameters

Parameter	Type	Required	Description
op	String	Yes	Operation subscribe Subscribe unsubscribe Unsubscribe
args	List<Object>	Yes	List of channels to request subscription
> instType	String	Yes	Product type: MARGIN
> channel	String	Yes	Channel name
> instId	String	Yes	Product ID e.g. ETHUSDT

Response Example

{
    "event":"subscribe",
    "arg":{
        "instType":"MARGIN",
        "channel":"orders-crossed",
        "instId":"BTCUSDT"
    }
}

Response Parameters

Parameter	Type	Description
event	String	Yes Event
arg	Object	Subscribed channels
> instType	String	Product type: MARGIN
> channel	String	Channel name
> instId	String	Product ID e.g. ETHUSDT
code	String	Error code, returned only on error
msg	String	Error message

Push Data

{
    "action":"snapshot",
    "arg":{
        "instType":"MARGIN",
        "channel":"orders-crossed",
        "instId":"BTCUSDT"
    },
    "data":[
        {
            "force":"gtc",
            "orderType":"market",
            "price":"0.000000000",
            "quoteSize":"0.000000000",
            "side":"buy",
            "feeDetail":[
                {
                    "feeCoin":"USDT",
                    "deduction":"no",
                    "totalDeductionFee":"0",
                    "totalFee":"0.01538693"
                }
            ],
            "enterPointSource":"web",
            "status":"partially_filled",
            "baseSize":"0.000000000",
            "cTime":"1695881543701",
            "clientOid":"2000000000",
            "fillPrice":"26426.800000000",
            "baseVolume":"0.000200000",
            "fillTotalAmount":"5.285360000",
            "loanType":"normal",
            "orderId":"1",
            "stpMode": "cancel_taker"
        }
    ],
    "ts":1695881543805
}

Push Data Parameters

Parameter	Type	Description
arg	Object	Successful channel subscriptions
> instType	String	Product type: MARGIN
> channel	String	Channel name
> instId	String	Product ID, e.g. ETHUSDT
action	String	Push data action, snapshot or update
data	List<Object>	Subscribed data
> baseSize	String	Number of base coins
> cTime	String	Time of order
> clientOid	String	Client Unique Identifier
> fillPrice	String	Sale price
> baseVolume	String	Filled quantity
> fillTotalAmount	String	sum of money sold
> loanType	String	Margin order model normal: place a normal order autoLoan place an order with auto-borrow autoRepay place an order with auto-repay autoLoanAndRepay place an order with auto-borrow and auto-repay
> orderId	String	Order ID
> orderType	String	Order type limit: limit order market
> price	String	Order price
> quoteSize	String	Number of denominated coins
> side	String	Methods of Sale and Purchase
> feeDetail	List<Object>	Transaction fee of the order
>> deduction	String	Is discount
>> totalDeductionFee	String	Fee of discount
>> totalFee	String	Order transaction fee, the transaction fee charged by the platform from the user.
>> feeCoin	String	The currency of the transaction fee
> enterPointSource	String	Order source WEB: Orders created on the website API: Orders created on API SYS: System managed orders, usually generated by forced liquidation logic ANDROID: Orders created on the Android app IOS: Orders created on the iOS app
> status	String	Order status live:new order; partially_filled:partially filled; filled:full filled; cancelled: cancelled;
> symbol	String	Trading pair
> force	String	Order Strategy
> stpMode	String	STP Mode none not setting STP cancel_taker cancel taker order cancel_maker cancel maker order cancel_both cancel both of taker and maker orders
ts	Long	Timestamp ms