# Websocket 介紹

# 接入方式

行情Websocket的接入URL:wss://open-api-ws.bingx.com/market

# 數據壓縮

WebSocket 行情介面返回的所有數據都進行了 GZIP 壓縮,需要 client 在收到數據之後解壓。

# 心跳信息

當用戶的Websocket客戶端連接到Bingx Websocket伺服器後,伺服器會定期(當前設為5秒)向其發送心跳字元串Ping,

 {"ping":"2177c68e4d0e45679965f482929b59c2","time":"2022-06-07T16:27:36.323+0800"}

當用戶的Websocket客戶端接收到此心跳消息後,應返回字元串Pong消息

 {"pong":"2177c68e4d0e45679965f482929b59c2","time":"2022-06-07T16:27:36.323+0800"}

# 訂閱方式

成功建立與Websocket伺服器的連接後,Websocket客戶端發送如下請求以訂閱特定主題:

{
"id": "id1",
"dataType": "data to sub"
}
參數名 參數類型 必填 描述
id String id是用戶傳入的唯一id,返回時將返回,用於用戶區分冪等性校驗

成功訂閱後,Websocket客戶端將收到確認:

{
"id": "id1",
"code": 0,
"msg": ""
}

之後, 一旦所訂閱的數據有更新,Websocket客戶端將收到伺服器推送的更新消息

code錯誤碼說明

    0:"SUCCESS"
    /**
     * 100xxx為通用狀態碼.
     */
    // 伺服器搜索無數據
    100204:"SEARCH_NO_CONTENT"

    // 重複請求
    100205:"REPEAT_REQUEST"

    // 客戶端請求參數錯誤
    100400:"ILLEGAL_ARGUMENT"

    // 客戶端認證失敗
    100401:"AUTHENTICATION_FAIL"

    // 客戶端許可權校驗失敗
    100403:"AUTHORIZATION_FAIL"

    // 客戶端請求頻率限制
    100410:"FREQUENCY_LIMIT"

    // 伺服器錯誤
    100500:"INTERNAL_SERVER_ERROR"

    // 伺服器繁忙
    100503:"SERVER_BUSY"

# 取消訂閱

取消訂閱的格式如下:

{
"id": "id1",
"reqType": "unsub",
"dataType": "data to unsub"
}

取消訂閱成功確認:

{
"id": "id1",
"code": 0,
"msg": ""
}

# symbol說明

symbol必須全大寫

Last Updated: 12/19/2022, 12:41:33 PM