跳到主要内容

Broker 接口

查询母子万向划转历史-broker用户

请求示例


get /api/v3/broker/sub-account/universalTransfer?timestamp={{timestamp}}&signature={{signature}}

返回示例

[
{
"tranId":"11945860693",
"fromAccount":"master@test.com",
"toAccount":"subaccount1@test.com",
"clientTranId":"test",
"asset":"BTC",
"amount":"0.1",
"fromAccountType":"SPOT",
"toAccountType":"FUTURE",
"fromSymbol":"SPOT",
"toSymbol":"FUTURE",
"status":"SUCCESS",
"timestamp":1544433325000
},
{
"tranId":"11945860693",
"fromAccount":"master@test.com",
"toAccount":"subaccount1@test.com",
"clientTranId":"test",
"asset":"BTC",
"amount":"0.1",
"fromAccountType":"SPOT",
"toAccountType":"FUTURE",
"fromSymbol":"SPOT",
"toSymbol":"FUTURE",
"status":"SUCCESS",
"timestamp":1544433325000
}
]

HTTP请求:

  • GET /api/v3/broker/sub-account/universalTransfer

权限:现货划转读取

请求参数:

参数名数据类型是否必须说明
fromAccountstringno转出账户,不填默认母账户
toAccountstringno转入账户,不填默认母账户
fromAccountTypestringyes划出账户类型
toAccountTypestringyes划入账户类型
startTimestringno起始时间, 13位
endTimestringno结束时间, 13位
pagestringno默认 1
limitstringno默认 500, 最大 500
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
tranIdstring划转ID
fromAccountstring划出账户
toAccountstring划入账户
clientTranIdstringclient ID
assetstring币种
amountstring划转数量
fromAccountTypestring转出账户
toAccountTypestring划入账户
fromsymbolstring转出交易对
tosymbolstring转入交易对
statusstring划转状态【成功,失败,划转中,中断】
timestampnumber划转时间

创建子账户

请求示例


post /api/v3/broker/sub-account/virtualSubAccount?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"code": "0",
"message": "",
"data": [{
"subAccount": "mexc1",
"note": "1",
"timestamp": "1597026383085"
}]
}

HTTP请求:

  • POST /api/v3/broker/sub-account/virtualSubAccount

Query参数:

参数名数据类型是否必须说明
timestampstringyes时间
signaturestringyes签名

Body请求参数:

参数名数据类型是否必须说明
subAccountstringyes子账户名称
notestringyes备注
passwordstringno资金密码【资金密码要求:MD5加密的16进制字符串过来】

返回参数:

参数名类型说明
subAccountstring子账户名称
notestring备注

查看子账户列表

请求示例


get /api/v3/broker/sub-account/list?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"code": "0",
"message": "",
"data": [{
"subAccount": "mexc1",
"note": "1",
"timestamp": "1597026383085"
}, {
"subAccount": "mexc2",
"note": "2",
"timestamp": "1597026383787"
}]
}

HTTP请求:

  • GET /api/v3/broker/sub-account/list

请求参数:

参数名数据类型是否必须说明
subAccountstringno子账户名称
pagestringno分页参数:页码。默认: 1
limitstringno分页参数:页容量。默认: 10, 最大: 200
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
subAccountstring子账户名称
timestampnumber创建时间
notestring备注

查看子账户状态

请求示例


get /api/v3/broker/sub-account/status?subAccount=subAccountName&timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"status": "1",
}

HTTP请求:

  • GET /api/v3/broker/sub-account/status

请求参数:

参数名数据类型是否必须说明
subAccountstringyes子账户名称
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
statusstring1:正常;2:冻结

创建子账户的APIKey

请求示例


post /api/v3/broker/sub-account/apiKey?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"subAccount": "4Eb8rPPhpsAL",
"permissions": "SPOT_ACCOUNT_READ,SPOT_ACCOUNT_WRITE",
"note": "note2",
"apikey": "mx0npKfh57kEEVmyLa",
"secretKey": "51f38875ebe0475dad6236783a95cc19",
"createTime": 1646291300120
}

HTTP请求:

  • POST /api/v3/broker/sub-account/apiKey

Query参数:

参数名数据类型是否必须说明
timestampstringyes时间
signaturestringyes签名

Body请求参数:

参数名数据类型是否必须说明
subAccountstringyes子账户名称
permissionsstringyes权限
ipstringnoip白名单,多个用逗号隔开,目前最大支持4个IP,可选
notestringyes备注

返回参数:

参数名类型说明
subAccountstring子账户名称
notestringAPIKey的备注
apikeystringAPI公钥
secretKeystringAPI私钥
permissionsstringAPIKey权限
ipstringAPIKey绑定的ip地址
createTimenumber创建时间

查询子账户的APIKey

请求示例


get /api/v3/broker/sub-account/apiKey?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"subAccount": [{
"note": "v5",
"apiKey": "arg13sdfgs",
"permissions": "SPOT_ACCOUNT_READ,SPOT_ACCOUNT_WRITE",
"ip": "1.1.1.1,2.2.2.2",
"creatTime": 1597026383085
}, {
"note": "v5.1",
"apiKey": "arg13sdfgs",
"permissions": "read_only",
"ip": "1.1.1.1,2.2.2.2",
"creatTime": 1597026383085
}]
}

HTTP请求:

  • GET /api/v3/broker/sub-account/apiKey

请求参数:

参数名数据类型是否必须说明
subAccountstringyes子账户名称
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
notestring子账户备注
apikeystringAPI公钥
permissionsstringAPIKey权限
ipstringAPIKey绑定的ip地址
creatTimenumber创建时间

删除子账户的APIKey

请求示例


delete /api/v3/broker/sub-account/apiKey?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"subAccount": "mexc1"
}

HTTP请求:

  • DELETE /api/v3/broker/sub-account/apiKey

Query参数:

参数名数据类型是否必须说明
timestampstringyes时间
signaturestringyes签名

Body请求参数:

参数名数据类型是否必须说明
subAccountstringyes子账户名称
apiKeystringyesAPI公钥

返回参数:

参数名类型说明
subAccountstring子账户名称

生成子账户充值地址

请求示例


post /api/v3/broker/capital/deposit/subAddress?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"address": "TDunhSa7jkTNuKrusUTU1MUHtqXoBPKETV",
"coin": "USDT",
"network": "ERC-20",
"memo": ""
}

HTTP请求:

  • POST /api/v3/broker/capital/deposit/subAddress

权限:现货充值写

Query参数:

参数名数据类型是否必须说明
recvWindowstringno同步时间
timestampstringyes时间
signaturestringyes签名

Body请求参数:

参数名数据类型是否必须说明
coinstringyes充值币种
networkstringyes充值网络

返回参数:

参数名类型说明
addressstring充值地址
coinstring充值币种
networkstring充值网络
memostringmemo值

获取子账户充值地址

请求示例


get /api/v3/broker/capital/deposit/subAddress?timestamp={{timestamp}}&signature={{signature}}

返回示例

[{
"address": "TDunhSa7jkTNuKrusUTU1MUHtqXoBPKETV",
"coin": "USDT",
"network": "ERC-20",
"memo": ""
}, {
"address": "TDunhSa7jkTNuKrusUTU1MUHtqXoBPKETV",
"coin": "USDT",
"network": "TRC-20",
"memo": ""
}]

HTTP请求:

  • GET /api/v3/broker/capital/deposit/subAddress

权限:现货充值读取

请求参数:

参数名数据类型是否必须说明
coinstringyes充值币种
recvWindowstringno同步时间
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
addressstring充值地址
coinstring充值币种
networkstring充值网络
memostringmemo值

获取子账户充值记录

请求示例


get /api/v3/broker/capital/deposit/subHisrec?timestamp={{timestamp}}&signature={{signature}}

返回示例

[
{
"amount":"0.00999800",
"coin":"PAXG",
"network":"ETH",
"status":,
"address":"0x788cabe9236ce061e5a892e1a595a81fc8d62c",
"addressTag":"",
"txId":"0xaad4654a3234aa6118af9b4b335f5aec360b2394721c019b5d1e75328b09f3",
"unlockConfirm":"12",
"confirmTimes":"7"
},
{
"amount":"0.50000000",
"coin":"IOTA",
"network":"IOTA",
"status":1,
"address":"SIZ9VLMHWATXKV99LH99CIGFJFUMLEVZVNNZXRJJVWBPHYWPPBOSDORZ9EQSHCZAMPVAPGFYQAUUV9DROOXJLNW",
"addressTag":"",
"txId":"ESBFVQUTPIWQNJSPXFNHNYHSQNTGKRVBQWTAXCDWOAKDKYWPTVG9BGXNVNKTLEJGESAVXIKIZ9999",
"unlockConfirm":"12",
"confirmTimes":"7"
}
]

HTTP请求:

  • GET /api/v3/broker/capital/deposit/subHisrec

请求参数:

参数名数据类型是否必须说明
coinstringno币种
statusstringno状态
startTimestringno开始时间,如果没有传,默认查询10天
endTimestringno结束时间
limitstringno默认值20,目前无最大值限制
pagestringno默认值1
recvWindowstringno同步时间
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
amountstring充值数量
coinstring充值币种
networkstring充值网络
statusnumber状态
addressstring充值地址
addressTagstring地址标签
txIdstringtxid
unlockConfirmstring解锁需要的网络确认次数
confirmTimesstring确认进度

获取所有子账户的所有充值记录(最近三天)

母账户查询三天(三天前从0点计时)内,子账户充值记录

请求示例


get /api/v3/broker/capital/deposit/subHisrec/getall?timestamp={{timestamp}}&signature={{signature}}

返回示例

[
{
"amount":"0.00999800",
"coin":"PAXG",
"network":"ETH",
"status":,
"address":"0x788cabe9236ce061e5a92e1a59395a81fc8d62c",
"txId":"0xaad4654a3234aa6118af9b4bf5ae81c360b2394721c019b5d1e75328b09f3",
"unlockConfirm":"12",
"confirmTimes":"7"
},
{
"amount":"0.50000000",
"coin":"IOTA",
"network":"IOTA",
"status":1,
"address":"SIZ9VLMHWATXKV99LHIGFJFUMLEHGWVZVNNZXRJJVWBPHYWPPBOSDORZ9EQSHCZAMPVAPGFYQAUUV9DROOXJLNW",
"txId":"ESBFVQUTPIWQNJSPXFNHNYQNTGKRABQWTAXCDWOAKDKYWPTVG9BGXNVNKTLEJGESAVXIKIZ9999",
"unlockConfirm":"12",
"confirmTimes":"7"
}
]

HTTP请求:

  • GET /api/v3/broker/capital/deposit/subHisrec/getall

请求参数:

参数名数据类型是否必须说明
coinstringno币种
statusstringno状态
startTimestringno开始时间
endTimestringno结束时间
limitstringno默认值100,最大1000
pagestringno默认值1
recvWindowstringno同步时间
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
amountstring充值数量
coinstring充值币种
networkstring充值网络
statusnumber状态
addressstring充值地址
txIdstringtxid
unlockConfirmstring解锁需要的网络确认次数
confirmTimesstring确认进度

提币

【只支持子账号提币,不支持母提子】

请求示例


post /api/v3/broker/capital/withdraw/apply?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"id":"7213fea8e94b4a5593d507237e5a555b"
}

HTTP请求:

  • POST /api/v3/broker/capital/withdraw/apply

权限:现货划转读取

Query参数:

参数名数据类型是否必须说明
recvWindowstringno同步时间
timestampstringyes时间
signaturestringyes签名

Body请求参数:

参数名数据类型是否必须说明
coinstringyes提币币种
networkstringyes提币网络
addressstringyes提币地址
amountstringyes数量
passwordstringno资金密码【传此参数不交验提现地址簿】【资金密码要求:MD5加密的16进制字符串过来】
remarkstringno标记

返回参数:

参数名类型说明
idstring提币ID

母子用户万向划转

只支持broker账户使用

请求示例


post /api/v3/broker/sub-account/universalTransfer?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"tranId": "7213fea8e94b4a5593d507237e5a555b"
}

HTTP请求:

  • POST /api/v3/broker/sub-account/universalTransfer

权限:现货划转读取

Query参数:

参数名数据类型是否必须说明
timestampstringyes时间
signaturestringyes签名

Body请求参数:

参数名数据类型是否必须说明
fromAccountstringno母子账户,可填subAccout账户名,不填默认母账户
toAccountstringno母子账户,可填subAccout账户名,不填默认母账户
fromAccountTypestringyes划出账户类型
toAccountTypestringyes划入账户类型
assetstringyes划转资产,eg:USDT
amountstringyes划转数量,eg:1.82938475

返回参数:

参数名类型说明
tranIdstring划转ID

开通子账户的合约业务

请求示例


post /api/v3/broker/sub-account/futures?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"code": "0",
"message": "",
"data": [{
"subAccount": "mexc1",
"isFuturesEnabled": true,
"timestamp": "1597026383085"
}]
}

HTTP请求:

  • POST /api/v3/broker/sub-account/futures

Query参数:

参数名数据类型是否必须说明
timestampstringyes时间
signaturestringyes签名

Body请求参数:

参数名数据类型是否必须说明
subAccountstringyes子账户名称

返回参数:

参数名类型说明
subAccountstring子账户名称
isFuturesEnabledboolean开通合约业务,开通:true
timestampstring返回时间

获取broker返佣记录

请求示例


get /api/v3/broker/rebate/taxQuery?timestamp={{timestamp}}&signature={{signature}}

返回示例

{
"page": 1, //当前页
"totalRecords": 1, //总记录数
"totalPageNum": 1, //总页数
"data": [
{
"asset": "USDT", // 返佣资产
"amount": "0.00082273", // 返佣金额
"type": "spot", // 返佣类型
"uid": "221827", // 返佣用户UID
"time": "20221022" // 返佣时间
},
{
"asset": "USDT", // 返佣资产
"amount": "0.00082273", // 返佣金额
"type": "spot", // 返佣类型
"uid": "221827", // 返佣用户UID
"time": "20221022" // 返佣时间
}
]
}

HTTP请求:

  • GET /api/v3/broker/rebate/taxQuery

请求参数:

参数名数据类型是否必须说明
startTimestringno开始时间
endTimestringno结束时间
pagestringno默认值1
pageSizestringno默认值10
recvWindowstringno同步时间
timestampstringyes时间
signaturestringyes签名

返回参数:

参数名类型说明
assetstring返佣资产
amountstring返佣金额
uidstring返佣用户UID
typestring返佣类型,现货/合约
timestring返佣时间