> ## 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.

# 接口

> 用户中心 API：接口。

## 查询账户列表（适用于主账户和子账户）

`GET` `/v4/user/account`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| accountId | string | false | | 账户id | |
| accountName | string | false | | 账户名 | |
| level | integer | false | | 账户等级 | 1：主账户；2：子账户 |

```json Response theme={null}
{
  "rc": 0,
  "mc": "SUCCESS",
  "ma": [
    {}
  ],
  "result": [
    {
        "id": "1352123154436",                     //账户id
        "accountName": "master1",                  //账户名
        "userId": 1352123154435,                   //用户id
        "level": 1,                                //账户等级：1-主账户；2-子账户
        "createTime": "2022-04-19 02:02:42",       //账户创建时间
        "updateTime": "2022-04-19 02:02:42"        //账户更新时间
    }, 
    {
        "id": "1626456841938669570",               //账户id
        "accountName": "first1",                   //账户名
        "userId": 1352123154436,                   //用户id
        "level": 2,                                //账户等级：1-主账户；2-子账户
        "createTime": "2023-02-17 05:41:43",       //账户创建时间
        "updateTime": "2023-02-17 05:41:43"        //账户更新时间
    }
  ]
}
```

## 创建子账户

`POST` `/v4/user/account`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| accountName | string | true | | 子账户名 | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "SUCCESS",
  "ma": [
    {}
  ],
  "result": true   //true 成功；false或null未成功
}
```

## 查询用户apiKey（适用于主账户和子账户）

`GET` `/v4/user/account/api-key`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| userAccountId | string | false | | 账户id | |
| keyName | string | false | | apiKey名称 | |
| isLock | integer | false | | 是否锁定 | 0：否；1：是 |

```json Response theme={null}
{
  "rc": 0,
  "mc": "SUCCESS",
  "ma": [
    {}
  ],
  "result": [
    {
        "id": 1,                     
        "userAccountId": "1352123154435",                         //账户id
        "userAccountLevel": 1,                                    //账户等级：1-主账户；2-子账户
        "userId": 1352123154435,                                  //用户id
        "keyName": "abc",                                         //apiKey名称
        "bindIps": "",                                            //绑定ip列表
        "accessKey": "b5e58714-2382-4e2f-8762-81b5ec9d363a",      //加密key
        "secretKey": "17aef63c0cba308089fae03e2b13a4794bd2d411",  //加密串
        "isLock": 0,                                              //是否锁定：0-否；1：是
        "roleScopes": "QUERY_TRADE",                              //权限code: QUERY_TRADE: 开启交易权限; QUERY_NO_TRADE: 不开启交易权限
        "tags": null,                                             //标签
        "createTime": "2023-02-17 05:41:43",                      //apiKey创建时间
        "updateTime": "2023-02-17 05:41:43"                       //apiKey更新时间
    }, 
    {
        "id": 2,                     
        "userAccountId": "13523123154435",                        //账户id
        "userAccountLevel": 1,                                    //账户等级：1-主账户；2-子账户
        "userId": 1352123154435,                                  //用户id
        "keyName": "bcd",                                         //apiKey名称
        "bindIps": "",                                            //绑定ip列表
        "accessKey": "b5e58714-2382-4e2f-8762-81b5ec9d363a",      //加密key
        "secretKey": "17aef63c0cba308089fae03e2b13a4794bd2d411",  //加密串
        "isLock": 0,                                              //是否锁定：0-否；1：是
        "roleScopes": "QUERY_TRADE",                              //权限code: QUERY_TRADE: 开启交易权限; QUERY_NO_TRADE: 不开启交易权限
        "tags": null,                                             //标签
        "createTime": "2023-02-17 05:41:43",                      //apiKey创建时间
        "updateTime": "2023-02-17 05:41:43"                       //apiKey更新时间
    }
  ]
}
```

## 创建用户账户apiKey

`POST` `/v4/user/account/api-key`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| userAccountId | string | true | | 账户id | |
| keyName | string | true | | apiKey名称 | |
| bindIps | string | false | | 绑定ip，多个用逗号分隔 | |
| roleScopes | string | true | | 权限code | QUERY 查询权限开启,TRADE 现货及杠杆交易开启, WITHDRAW 提币权限开启, LEVER\_LOAN 杠杆质押借币权限开启, FUTURE 合约交易开启, TRANSFER 划转权限开启 |
| tags | string | false | | 标签 | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "SUCCESS",
  "ma": [
    {}
  ],
  "result": {
     "id": 4564,                                             //apiKey id
     "userAccountId": "1626456841938669570",                 //账户id
     "userAccountLevel": 2,                                  //账户等级：1-主账户；2-子账户
     "userId": 1352123154435,                                //用户id
     "keyName": "123aaa",                                    //apiKey名称
     "bindIps": null,                                        //绑定ip列表
     "accessKey": "99258227-f053-46a2-9b10-66c155eb705c",    //加密key
     "secretKey": "4b1839e11bf7a1c6de5f078bd9f4b6e0850da3cf",//加密串
     "isLock": 0,                                            //是否锁定：0-否；1：是
     "roleScopes": "QUERY_TRADE",                            //权限code: QUERY_TRADE: 开启交易权限; QUERY_NO_TRADE: 不开启交易权限
     "tags": null,                                           //标签
     "createTime": "2023-02-20 07:39:56.768",                //apiKey创建时间
     "updateTime": "2023-02-20 07:39:56.768"                 //apiKey更新时间
  }
}
```

## 修改用户账户apiKey

`PUT` `/v4/user/account/api-key`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| id | string | true | | apiKey id | |
| accessKey | string | true | | access key | |
| keyName | string | false | | apiKey名称 | |
| bindIps | string | false | | 绑定ip 多个ip英文逗号分割 | |
| roleScopes | string | true | | 权限code | QUERY 查询权限开启,TRADE 现货及杠杆交易开启, WITHDRAW 提币权限开启, LEVER\_LOAN 杠杆质押借币权限开启, FUTURE 合约交易开启, TRANSFER 划转权限开启 |
| tags | string | false | | 标签 | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "SUCCESS",
  "ma": [
    {}
  ],
  "result": {
     "id": 4564,                                             //apiKey id
     "userAccountId": "1626456841938669570",                 //账户id
     "userAccountLevel": 2,                                  //账户等级：1-主账户；2-子账户
     "userId": 1352123154435,                                //用户id
     "keyName": "123aaa",                                    //apiKey名称
     "bindIps": null,                                        //绑定ip列表
     "accessKey": "99258227-f053-46a2-9b10-66c155eb705c",    //加密key
     "secretKey": "4b1839e11bf7a1c6de5f078bd9f4b6e0850da3cf",//加密串
     "isLock": 0,                                            //是否锁定：0-否；1：是
     "roleScopes": "QUERY_TRADE",                            //权限code: QUERY_TRADE: 开启交易权限; QUERY_NO_TRADE: 不开启交易权限
     "tags": null,                                           //标签
     "createTime": "2023-02-20 07:39:56.768",                //apiKey创建时间
     "updateTime": "2023-02-20 07:39:56.768"                 //apiKey更新时间
  }
}
```

## 删除用户账户apiKey

`DELETE` `/v4/user/account/api-key/{apikeyId}`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| apikeyId | string | true | | apiKey id | |

```json Response theme={null}
{
  "rc": 0,
  "mc": "SUCCESS",
  "ma": [
    {}
  ],
  "result": true    //true 成功；false或null未成功
}
```

## 查询所有下级代理及子代理（含直客）

`GET` `/v4/referal/invite/users`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| startTime | number | false | | 开始时间 | |
| endTime | number | false | | 结束时间 | |
| fromId | number | false | | 分页查询开始id | |
| direction | string | false | NEXT | 上一页/下一页 | PREV, NEXT |
| limit | int | false | 10 | 每页数量，最大100 | 1\<=limit\<=100 |

```json Response theme={null}
{
  "ma": [],
  "mc": "SUCCESS",
  "rc": 0,
  "result": {
    "hasNext": true,
    "hasPrev": true,
    "items": [
        {
        "id": 123,
        "regTime": 1721962593000, //注册时间
        "role": "PARTNER",        //用户角色: CHANNEL/PARTNER/DIRECTOR
        "userId": 123456789       //用户id
        }
    ]
  }
}
```

## 查询该用户充值及交易数据

`GET` `/v4/referal/invite/user/data`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| startTime | number | false | | 开始时间 | |
| endTime | number | false | | 结束时间 | |
| uid | number | true | | 查询的用户id | |

```json Response theme={null}
{
  "ma": [],
  "mc": "SUCCESS",
  "rc": 0,
  "result": {
    "userId": 123456789,                //用户id
    "role": "PARTNER",                  //用户角色
    "deposit": true,                    //是否充值
    "depositDetails": [
        {
            "amount": 100,              //充值数量
            "amountU": 100,             //充值兑U数量
            "currency": "USDT",         //充值币种
            "timestamp": 1721962593000  //充值时间
        }
    ],
    "trade": true,                      //是否交易
    "tradeAmount": 1000.1234            //交易兑U数量
  }
}
```

## 查询用户信息

`GET` `/v4/referal/invite/single/user/info`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| uid | number | true | | 用户ID | |

```json Response theme={null}
{
  "ma": [],
  "mc": "SUCCESS",
  "rc": 0,
  "result": {
    "uid": 123456789,                //用户id
    "registerTime": 1737095389000,   //注册时间
    "countryCode": "86",             //国家编码
    "mobile": "123****4567",         //手机号，脱敏处理
    "email": "639***3@gmail.com",    //邮箱，脱敏处理
    "riskControlStatus": 0,          //风控状态(0-未风控 1-已被风控)
    "kycStatus": 2,                  //kyc状态(0-未认证，1-初级认证，2-高级认证，3-企业认证)
    "registerInviteCode": 23456,     //注册邀请码
  }
}
```

## 批量查询用户信息

`GET` `/v4/referal/invite/multi/user/info`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| uidList | array | true | | 用户ID集合 | |
| fromId | number | false | | 分页查询开始id | |
| direction | string | false | NEXT | 上一页/下一页 | PREV, NEXT |
| limit | int | false | 10 | 每页数量，最大100 | 1\<=limit\<=100 |

```json Response theme={null}
{
  "ma": [],
  "mc": "SUCCESS",
  "rc": 0,
  "result": {
     "totalCount": 1,
     "pageCount": 20,
     "items": [
         {
            "uid": 123456789,                //用户id
            "registerTime": 1737095389000,   //注册时间
            "countryCode": "86",             //国家编码
            "mobile": "123****4567",         //手机号，脱敏处理
            "email": "639***3@gmail.com",    //邮箱，脱敏处理
            "riskControlStatus": 0,          //风控状态(0-未风控 1-已被风控)
            "kycStatus": 2,                  //kyc状态(0-未认证，1-初级认证，2-高级认证，3-企业认证)
            "registerInviteCode": 23456,     //注册邀请码
         }
     ]
  }
}
```

## 查询用户KYC状态

`GET` `/v4/referal/invite/kyc/status`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| uid | number | true | | 用户ID | |

```json Response theme={null}
{
  "ma": [],
  "mc": "SUCCESS",
  "rc": 0,
  "result": {
    "userid": 123456789,                //用户id
    "status": 2,                     //kyc状态(0-未认证，1-初级认证，2-高级认证，3-企业认证)
  }
}
```

## 查询代理商返佣数据

`GET` `/v4/referal/invite/agent/rebate/data`

**Parameters**

| 参数 | 数据类型 | 是否必须 | 默认值 | 描述 | 取值范围 |
| - | - | - | - | - | - |
| startTime | number | false | | 佣金入金数据开始时间 | |
| endTime | number | false | | 佣金入金数据结束时间 | |
| inviteCode | string | false | | 注册邀请码 | |
| type | number | true | | 佣金类型 | 1-spot 2-future |
| fromId | number | false | | 分页查询开始id | |
| direction | string | false | NEXT | 上一页/下一页 | PREV, NEXT |
| limit | int | false | 10 | 每页数量，最大100 | 1\<=limit\<=100 |

```json Response theme={null}
{
  "ma": [],
  "mc": "SUCCESS",
  "rc": 0,
  "result": {
     "totalCount": 1,
     "pageCount": 20,
     "items": [
        {
            "amountCurrency": 666,              //币种金额
            "commission": 23,                   //返佣金额
            "currency": "usdt"                  //返佣币种
            "date": "2025-01-22T09:57:01.601Z", //交易日期
            "makerAmount": 32,                  //maker金额
            "rate": 2,                          //返佣比例
            "sourceType": 1,                    //1-直客 2-子代理
            "state": 1,                         //返佣状态 0-正常 1-异常
            "symbol": "btc_usdt",               //交易对
            "takerAmount": 23,                  //taker金额
            "totalCommissionUsdtAmount": 123,   //总佣金
            "totalTradeUsdtAmount": 2222,       //总交易量
            "type": 1,                          //1-spot 2-future
            "usdtAmount": 243253,               //usdt金额
        }
     ]
  }
}
```


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