> ## Documentation Index
> Fetch the complete documentation index at: https://docs.monochrome.exchange/llms.txt
> Use this file to discover all available pages before exploring further.

# WebSocket：私有频道

> 现货 API：WebSocket 私有频道。

## 基本信息

### 基地址

**wss\://stream.monochrome.exchange/private**

### Request Headers

请求头必须添加压缩扩展协议。

Sec-Websocket-Extensions:permessage-deflate

## 请求报文格式

**param结构**

\{topic}@\{arg},\{arg},…

```javascript 订阅 theme={null}
{
    "method": "subscribe", 
    "params": [
        "{topic}@{arg},{arg}",    //event
        "{topic}@{arg}"
    ], 
    "listenKey": "512312356123123123",   //监听Key，先通过/v4/ws-token接⼝获取accessToken
    "id": "{id}"
}
```

```javascript 取消订阅 theme={null}
{
    "method": "unsubscribe", 
    "params": [
        "{topic}@{arg},{arg}",    //event
        "{topic}@{arg}"
    ], 
    "listenKey": "512312356123123123",   //监听Key，先通过/v4/ws-token接⼝获取accessToken
    "id": "{id}"
}
```

## 响应报⽂格式

```javascript 格式 theme={null}
{
    "id": "{id}",   //请求回调ID
    "code": 1,      //结果1=成功;0=失败;2=listenKey⽆效
    "msg": ""
}
```

## 获取token接口

`POST` `/v4/ws-token`

### 限流规则

1/10s/apikey

### 备注

accessToken有效期是2天，重新调用接口获取token会重置有效期。

accessToken = listenKey

```json Response theme={null}
{
    "rc": 0,
    "mc": "SUCCESS",
    "ma": [],
    "result": {
        "accessToken": "eyJhbqGciOiJSUzI1NiJ9.eyJhY2NvdW50SWQiOiIyMTQ2Mjg1MzIyNTU5Iiwic3ViIjoibGh4dDRfMDAwMUBzbmFwbWFpbC5jYyIsInNjb3BlIjoiYXV0aCIsImlzcyI6Inh0LmNvbSIsImxhc3RBdXRoVGltZSI6MTY2MzgxMzY5MDk1NSwic2lnblR5cGUiOiJBSyIsInVzZXJOYW1lIjoibGh4dDRfMDAwMUBzbmFwbWFpbC5jYyIsImV4cCI6MTY2NjQwNTY5MCwiZGV2aWNlIjoidW5rbm93biIsInVzZXJJZCI6MjE0NjI4NTMyMjU1OX0.h3zJlJBQrK2x1HvUxsKivnn6PlSrSDXXXJ7WqHAYSrN2CG5XPTKc4zKnTVoYFbg6fTS0u1fT8wH7wXqcLWXX71vm0YuP8PCvdPAkUIq4-HyzltbPr5uDYd0UByx0FPQtq1exvsQGe7evXQuDXx3SEJXxEqUbq_DNlXPTq_JyScI",
        "refreshToken": "eyJhbGciOiqJSUzI1NiJ9.eyJhY2NvdW50SWQiOiIyMTQ2Mjg1MzIyNTU5Iiwic3ViIjoibGh4dDRfMDAwMUBzbmFwbWFpbC5jYyIsInNjb3BlIjoicmVmcmVzaCIsImlzcyI6Inh0LmNvbSIsImxhc3RBdXRoVGltZSI6MTY2MzgxMzY5MDk1NSwic2lnblR5cGUiOiJBSyIsInVzZXJOYW1lIjoibGh4dDRfMDAwMUBzbmFwbWFpbC5jYyIsImV4cCI6MTY2NjQwNTY5MCwiZGV2aWNlIjoidW5rbm93biIsInVzZXJJZCI6MjE0NjI4NTMyMjU1OX0.Fs3YVm5YrEOzzYOSQYETSmt9iwxUHBovh2u73liv1hLUec683WGfktA_s28gMk4NCpZKFeQWFii623FvdfNoteXR0v1yZ2519uNvNndtuZICDdv3BQ4wzW1wIHZa1skxFfqvsDnGdXpjqu9UFSbtHwxprxeYfnxChNk4ssei430"
    }
}
```

## 推送报⽂格式

```javascript 格式 theme={null}
{
    "topic": "trade",          //主题
    "event": "trade@btc_usdt", //事件
    "data": { }                //数据
}
```

## 余额变动

param

语法: balance

示例: balance

```json 推送 theme={null}
{
    "topic": "balance", 
    "event": "balance", 
    "data": {
        "a": "123",           // accountId 账号 
        "t": 1656043204763,   // time 发⽣时间
        "c": "btc",           // currency 币种
        "b": "123",           // balance 全部现货资产
        "f": "11",            // frozen 冻结资产
        "z": "SPOT",          // bizType 业务类型[SPOT,LEVER]
        "s": "btc_usdt"       // symbol 交易市场  
    }
}
```

## 订单变动

param

语法: order

示例: order

```json 推送 theme={null}
{
    "topic": "order", 
    "event": "order", 
    "data": {
        "s": "btc_usdt",                // symbol 交易对
        "bc": "btc",                    // baseCurrency 标的币种
        "qc": "usdt",                   // quoteCurrency 报价币种
        "t": 1656043204763,             // time 发⽣时间
        "ct": 1656043204663,            // createTime 下单时间
        "i": "6216559590087220004",     // orderId 订单号
        "ci": "test123",                // clientOrderId 客户端订单号
        "st": "PARTIALLY_FILLED",       // state 状态 NEW/PARTIALLY_FILLED/FILLED/CANCELED/REJECTED/EXPIRED
        "sd": "BUY",                    // side 方向 BUY/SELL
        "tp": "LIMIT",                  // type 类型 LIMIT/MARKET
        "oq":  "4"                      // origQty 原始数量
        "oqq":  48000,                  // origQuoteQty 原始金额
        "eq": "2",                      // executedQty 已执⾏数量
        "lq": "2",                      // leavingQty 待执行数量
        "p": "4000",                    // price 价格
        "ap": "30000",                  // avg price 均价
        "f": "0.001"                    // fee 手续费
    }
}
```

## 订单成交

param

语法: trade

示例: trade

```json 推送 theme={null}
{
    "topic": "trade", 
    "event": "trade", 
    "data": {
        "s": "btc_usdt",           //symbol
        "i": 6316559590087222000,  //成交id
        "t": 1655992403617,        //时间
        "oi": 6616559590087222666, //订单id
        "p": "43000",              //价格
        "q": "0.21",               //数量
        "v": "9030",               //金额
        "b": true,                 //是否是buyerMaker
        "tm": 1                    //1-taker 2-maker
    }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.