导航
English

独立经纪商

简介

独立经纪商(Non-disclosed Broker) 是一种非披露经纪商。如果您有一定的研发运营能力，想要搭建独有的交易平台和自主管理您的用户，独立经纪商服务是最好的选择。您则负责前端开发和用户运营，而欧易为您提供后端技术和市场的流动性，赋能您的交易增值服务。

独立经纪商的优势如下

API

获取独立经纪商账户信息

查看独立经纪商母账户的账户信息

限速：1次/s

HTTP请求

GET /api/v5/broker/nd/info

请求示例

GET /api/v5/broker/nd/info

返回结果

{
    "code": "0",
    "data": [
        {
            "level": "lv1",
            "maxSubAcctQty": "1000",
            "subAcctQty": "6",
            "ts": "1637301641775"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
subAcctQty String 已创建子账户的数量
maxSubAcctQty String 最多可以创建子账户数量
level String 交易等级，例如 lv1
ts String 数据返回时间，Unix时间戳的毫秒数格式 ，如 1597026383085

创建子账户

独立经纪商母账户创建子账户

限速：40次/s

HTTP请求

POST /api/v5/broker/nd/create-subaccount

请求示例

POST /api/v5/broker/nd/create-subaccount
body
{
    "subAcct":"brokerTest5",
    "label":"5566"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
6-20位字母（区分大小写）或数字，可以是纯字母、不可以是纯数字。
label String 否 子账户的备注
不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。

返回结果

{
    "code": "0",
    "data": [
        {
            "acctLv": "1",
            "label": "5566",
            "subAcct": "brokerTest5",
            "uid": "345173667552038914",
            "ts": "1637141950450"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
label String 子账户的备注
acctLv String 账户模式
1：简单交易模式
uid String 账户ID
ts String 创建时间

删除子账户

独立经纪商母账户删除子账户，该子账户被删除前，需将子账户的资金全部划转出去。

限速：10次/s

HTTP请求

POST /api/v5/broker/nd/delete-subaccount

请求示例

POST /api/v5/broker/nd/delete-subaccount
body
{
    "subAcct":"yonxws"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "subAcct": "test-1"
    }]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称

获取子账户列表

独立经纪商母账户查询子账户列表

限速：1次/s

HTTP请求

GET /api/v5/broker/nd/subaccount-info

请求示例

GET /api/v5/broker/nd/subaccount-info

请求参数

参数名 类型 是否必须 描述
subAcct String 否 子账户名称
page String 否 查询页数
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "details": [
                {
                    "acctLv": "1",
                    "label": "11122",
                    "subAcct": "yonxws",
                    "uid": "1****124",
                    "ts": "1637052976000"
                },
                {
                    "acctLv": "1",
                    "label": "11122",
                    "subAcct": "brokerTest1",
                    "uid": "1****321",
                    "ts": "1637056638000"
                }
            ],
            "page": "1",
            "totalPage": "1"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
totalPage String 总的页数
page String 当前页数
details Array 子账户列表
> subAcct String 子账户名称
> uid String 子账户ID
> label String 子账户的备注
> acctLv String 账户模式
1：简单交易模式，2：单币种保证金模式 ，3：跨币种保证金模式 ，4：组合保证金模式
> ts String 子账户创建时间，Unix时间戳的毫秒数格式 ，如 1597026383085

创建子账户的APIKey

仅适用于母账户

调用时，APIKey 需要有交易权限

限速：40次/s

限速规则：UserID

HTTP请求

POST /api/v5/broker/nd/subaccount/apikey

请求示例

POST /api/v5/broker/nd/subaccount/apikey
body
{
    "subAcct":"panpanBroker2",
    "label":"broker3",
    "passphrase":"Qwr4321!",
    "perm":"trade",
    "ip":"10.0.108.9"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称，支持6-20位字母和数字组合（区分大小写，不支持空格符号）
label String 是 API Key的备注
不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。
passphrase String 是 API Key的密码，8-32位字母数字组合，至少包含一个数字、一个大写字母、一个小写字母、一个特殊字符
ip String 可选 绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip
如果子账户APIKey拥有交易权限，必须绑定IP地址
perm String 否 API Key权限
read_only：只读，trade：交易，withdraw：提币
默认拥有read_only权限

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "subAcct": "test-1",
        "label": "v5",
        "apiKey": "arg13sdfgs",
        "secretKey": "arg13sdfgs",
        "passphrase": "Qwr4321!",
        "perm": "read_only,trade",
        "ip": "1.1.1.1,2.2.2.2",
        "ts": "1597026383085"
    }]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
label String API Key的备注
apiKey String API公钥
secretKey String API的私钥
passphrase String API Key的密码
perm String API Key权限
ip String API Key绑定的ip地址
ts String 创建时间，Unix时间戳的毫秒数格式，如 1597026383085

查询子账户的API Key

仅适用于母账户

限速：1次/s

限速规则：UserID

HTTP请求

GET /api/v5/broker/nd/subaccount/apikey

请求示例

GET /api/v5/broker/nd/subaccount/apikey?subAcct=panpanBroker2

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
apiKey String 否 API的公钥

返回结果

    "code":"0",
    "msg":"",
    "data":[
        {
            "label":"v5",
            "apiKey":"arg13sdfgs",
            "perm":"read_only,trade",
            "ip":"1.1.1.1,2.2.2.2",
            "ts":"1597026383085"
        },
        {
            "label":"v5.1",
            "apiKey":"arg13sdfgs",
            "perm":"read_only",
            "ip":"1.1.1.1,2.2.2.2",
            "ts":"1597026383085"
        }
    ]
}

返回参数

参数名 类型 描述
label String APIKey的备注
apiKey String API公钥
perm String APIKey权限 read_only：只读 ；trade ：交易
ip String APIKey绑定的ip地址
ts String 创建时间

重置子账户的APIKey

仅适用于母账户

限速：10次/s

限速规则：UserID

HTTP请求

POST /api/v5/broker/nd/subaccount/modify-apikey

请求示例

POST /api/v5/broker/nd/subaccount/modify-apikey
body
{
    "subAcct":"yongxu",
    "perm":"read_only",
    "label":"test7",
    "apiKey":"49e1b84b-6dee-4894-80ee-ce9eb7ad614f"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
apiKey String 是 API的公钥
label String 否 APIKey的备注，如果填写该字段，那该字段会被重置
不超过50位字母（区分大小写）或数字，可以是纯字母或纯数字。
perm String 否 APIKey权限
read_only：只读
trade：交易
withdraw：提币
多个权限用半角逗号隔开。
如果填写该字段，那该字段会被重置。
ip String 否 绑定ip地址，多个ip用半角逗号隔开，最多支持20个ip。
如果填写该字段，则该字段会被重置
如果子账户APIKey拥有交易权限，则必须绑定IP地址。

返回结果

{
    "code": "0",
    "msg": "",
    "data": [
        {
            "apiKey": "49e1b84b-6dee-4894-80ee-ce9eb7ad614f",
            "perm": "read_only",
            "subAcct": "yongxu",
            "ip": "",
            "label": "1234",
            "ts": "1657113434000"
        }
    ]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
label String API Key的备注
apiKey String API公钥
perm String API Key权限
ip String API Key绑定的ip地址
ts String 更新时间，Unix时间戳的毫秒数格式，如 1597026383085

删除子账户的APIKey

仅适用于母账户

限速：10次/s

限速规则：UserID

HTTP请求

POST /api/v5/broker/nd/subaccount/delete-apikey

请求示例

POST /api/v5/broker/nd/subaccount/delete-apikey
body
{
    "subAcct":"test00001",
    "apiKey":"b521e11c-b4ed-4c80-9624-346d69749a85"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
apiKey String 是 API的公钥

返回结果

{
    "code": "0",
    "msg": "",
    "data": [{
        "subAcct": "test-1"
    }]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称

设置子账户的账户等级

独立经纪商母账户调整子账户的账户等级

限速：5次/2s

HTTP请求

POST /api/v5/broker/nd/set-subaccount-level

请求示例

POST /api/v5/broker/nd/set-subaccount-level
body
{
    "acctLv":"3",
    "subAcct":"brokerTest3"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
acctLv String 是 账户模式
1：简单交易模式，2：单币种保证金模式 ，3：跨币种保证金模式 ，4：组合保证金模式

返回结果

{
    "code": "0",
    "data": [
        {
            "acctLv": "3"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
acctLv String 账户模式
1：简单交易模式，2：单币种保证金模式 ，3：跨币种保证金模式 ，4：组合保证金模式

设置子账户的交易手续费费率

子账户交易费率是当前层级的基础费率加上绝对或百分比的变化。设置子账户手续费费率后，生效日期为T+1的0点(HKT)。 例如今天调整子账户的手续费率，明天的0点生效。生效时间可能存在15分钟左右的延迟。

限速：5次/2s

HTTP请求

POST /api/v5/broker/nd/set-subaccount-fee-rate

请求示例

POST /api/v5/broker/nd/set-subaccount-fee-rate
body
{
    "subAcct":"broker4",
    "chgType":"absolute",
    "chgTaker":"90",
    "chgMaker":"90",
    "effDate":"20211219"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 否 子账户名称
instType String 否 产品类型
SPOT：币币
SWAP：永续合约
FUTURES：交割合约
OPTION：期权
quoteCcyType String 否 计价币类型
2：USDT/USDⓈ/Crypto
3：USDC
适用于币币
当指定该参数时，instType必传
mgnType String 否 保证金类型
1：USDT本位
2：币本位
3：USDC本位
适用于交割/永续
当指定该参数时，instType必传
chgType String 是 手续费加点类型
absolute:固定加点
percentage:百分比加点
chgTaker String 可选 Taker手续费加点
固定加点：单位bp(1bp = 0.01%)，范围【0.0bp，1,000bp】，即【0.00%，10%】，精度为0.1bp
百分比加点：单位%范围【0%，1,0000%】，精度为1%
chgMaker String 可选 Maker手续费加点
固定加点：单位bp(1bp = 0.01%)，范围【0.0bp，1,000bp】，即【0.00%，10%】，精度为0.1bp
百分比加点：单位%范围【0%，1,0000%】，精度为1%
chgTaker和chgMaker必须填写一个
effDate String 否 手续费加点的生效日期
格式：YYYYMMdd ，例如：20210623
如果不填写，就是第二天0点(HKT)生效（T+1生效）
如果填写，就在指定日期0点(HKT)生效

返回结果

{
    "code": "0",
    "data": [
        {
            "subAcct": "brokerTest4",
            "effTs": "20211119"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
effDate String 手续费加点的生效日期
格式：YYYYMMdd ，例如：20210623

创建子账户充值地址

独立经纪商母账户创建子账户的充值地址，每个币种最多20个充值地址

限速：5次/2s

HTTP请求

POST /api/v5/asset/broker/nd/subaccount-deposit-address

请求示例

POST /api/v5/asset/broker/nd/subaccount-deposit-address
body
{
    "ccy":"BTC",
    "subAcct":"brokerTest5"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
ccy String 是 币种名称，仅支持大写，如 BTC
chain String 否 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
如果不填此参数，则默认为主链
addrType String 否 充值地址类型
1:普通地址
2:隔离验证地址
默认为普通地址，仅适用于btc和ltc
to String 否 充值到账账户
6：资金账户 18：交易账户
默认是6

返回结果

{
    "code": "0",
    "data": [
        {
            "chain": "EOS-EOS",
            "ccy": "EOS",
            "memo": "10810086",
            "addr": "okbtothemoon",
            "ts": "1637141950450"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 充值币种
addr String 充值地址
chain String 币种链信息
pmtId String 部分币种提币需要此字段，如果不需要此字段的币种吗，返回”“ ，如 xmr
tag String 部分币种提币需要此字段，如果不需要此字段的币种吗，返回”“ ， 如XRP
memo String 部分币种充值需要标签，若不需要则不返回此字段，返回”“，如eos
ts String 创建时间，Unix 时间戳的毫秒数格式，如 1597026383085

重置子账户充值地址

目前仅支持充值到账账户的调整

限速：6次/s

HTTP请求

POST /api/v5/asset/broker/nd/modify-subaccount-deposit-address

请求示例

POST /api/v5/asset/broker/nd/modify-subaccount-deposit-address
body
{
    "subAcct":"test",
    "ccy":"USDT",
    "chain":"USDT-ERC20"
    "addr":"1123456",
    "to":"18"
}

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
ccy String 是 币种名称，仅支持大写，如 BTC
chain String 否 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
如果不填此参数，则默认为主链
addr String 是 充值地址
某些数字货币地址格式为:地址+标签，如 ARDOR-7JF3-8F2E-QUWZ-CAN7F:123456
to String 是 充值到账账户
6：资金账户 18：交易账户

返回结果

{
    "code": "0",
    "data": [
        {
            "chain": "USDT-ERC20",
            "ccy": "USDT",
            "to": "18",
            "addr": "1123456",
            "ts": "1654778132000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ccy String 充值币种
addr String 充值地址
chain String 币种链信息
pmtId String 部分币种提币需要此字段，如果不需要此字段的币种吗，返回"" ，如 xmr
tag String 部分币种提币需要此字段，如果不需要此字段的币种吗，返回"" ， 如XRP
memo String 部分币种充值需要标签，若不需要则不返回此字段，返回""，如eos
to String 调整后的充值到账账户
6：资金账户 18：交易账户
ts String 修改时间，Unix 时间戳的毫秒数格式，如 1597026383085

获取充值地址

获取子账户的充值地址

限速：6次/s

HTTP请求

GET /api/v5/asset/broker/nd/subaccount-deposit-address

请求示例

GET /api/v5/asset/broker/nd/subaccount-deposit-address?ccy=BTC&subAcct=brokerTest1

请求参数

参数名 类型 是否必须 描述
subAcct String 是 子账户名称
ccy String 是 币种，仅支持大写：如 BTC

返回结果

{
    "code": "0",
    "data": [
        {
            "chain": "XMR-Monero",
            "ctAddr": "",
            "ccy": "XMR",
            "to": "6",
            "addr": "884ifkSCavs9X759FZhfmrNmEbimqnXdofsd5kqXwuxfJMKZPKCfSAubrnwanuUf2JJi6hwskfcYzAUGodkJj3RsHAVFoDm",
            "selected": false
        },
        {
            "chain": "XMR-Monero",
            "ctAddr": "",
            "ccy": "XMR",
            "to": "6",
            "addr": "88aCNpJgfX1DGZ2HPd5i9DaAmyuRiQbnFGVbc8AFXgAhi4i7eX6sRm75m1UuJNZxwfMh4xBwV5fv6h4A5v1qQET5LHnXqgn",
            "selected": false
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
addr String 充值地址
tag String 部分币种充值需要标签，若不需要则不返回此字段
memo String 部分币种充值需要标签，若不需要则不返回此字段
pmtId String 部分币种充值需要此字段（payment_id），若不需要则不返回此字段
ccy String 币种，如BTC
chain String 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
to String 转入账户
6：资金账户 18：交易账户
selected Boolean 该地址是否为页面选中的地址
ctAddr String 合约地址后6位

获取子账户充值记录

根据币种，充值状态，时间范围获取充值记录，按照时间倒序排列，默认返回 100 条数据。

限速：5次/2s

HTTP请求

GET /api/v5/asset/broker/nd/subaccount-deposit-history

请求示例

查询最近的充值记录
GET /api/v5/asset/broker/nd/subaccount-deposit-history?subAcct=brokerTest1&state=1

请求参数

参数名 类型 是否必须 描述
subAcct String 否 子账户名称
ccy String 否 币种名称，如 BTC
txId String 否 区块转账哈希记录
type String 否 充值方式
3：内部转账
4：链上充值
state String 否 充值状态
0：等待确认
1：确认到账
2：充值成功
8：因该币种暂停充值而未到账，恢复充值后自动到账
11：命中黑名单地址
12：账户或充值被冻结
13：子账户充值拦截
14：KYC限额
after String 否 查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
before String 否 查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1597026383085
limit string 否 返回的结果集数量，默认为 100，最大为 100

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "amt": "0.01044408",
      "actualDepBlkConfirm": "17",
      "txId": "1915737_3_0_0_asset",
      "ccy": "BTC",
      "chain":"BTC-Bitcoin",
      "from": "13801825426",
      "areaCodeFrom": "86",
      "to": "",
      "ts": "1597026383085",
      "state": "2",
      "subAcct": "brokerTest1",
      "depId": "4703879"
    }
  ]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
ccy String 币种名称，如 BTC
chain String 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
amt String 充值数量
from String 充值账户，只显示内部账户转账地址，不显示区块链充值地址
areaCodeFrom String 如果from为手机号，该字段为该手机号的区号
to String 到账地址
txId String 区块转账哈希记录
ts String 充值到账时间，Unix 时间戳的毫秒数格式，如 1597026383085
state String 充值状态
0：等待确认
1：确认到账
2：充值成功
8：因该币种暂停充值而未到账，恢复充值后自动到账
11：命中黑名单地址
12：账户或充值被冻结
13：子账户充值拦截
14：KYC限额
depId String 充值记录 ID
actualDepBlkConfirm String 最新的充币网络确认数

获取子账户提币记录

根据币种，提币状态，时间范围获取提币记录，按照时间倒序排列，默认返回 100 条数据。

限速：5次/2s

限速规则：UserID

HTTP 请求

GET /api/v5/asset/broker/nd/subaccount-withdrawal-history

请求示例

GET /api/v5/asset/broker/nd/subaccount-withdrawal-history?subAcct=brokerTest1

请求参数

参数名 类型 是否必须 描述
subAcct String 否 子账户名称
ccy String 否 币种名称，如 BTC
wdId String 否 提币申请ID
clientId String 否 客户自定义ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
txId String 否 区块转账哈希记录
type String 否 提币方式
3：内部转账
4：链上提币
state String 否 提币状态
-3：撤销中
-2：已撤销
-1：失败
0：等待提币
1：提币中
2：提币成功
7: 审核通过
10: 等待划转
4, 5, 6, 8, 9, 12: 等待客服审核
after String 否 查询在此之前的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1654041600000
before String 否 查询在此之后的内容，值为时间戳，Unix 时间戳为毫秒数格式，如 1656633600000
limit string 否 返回的结果集数量，默认为100，最大为100，不填默认返回100条

返回结果

{
  "code": "0",
  "msg": "",
  "data": [
    {
      "subAcct":"brokerTest1",
      "chain": "ETH-Ethereum",
      "fee": "0.007",
      "feeCcy": "ETH",
      "ccy": "ETH",
      "clientId": "",
      "amt": "0.029809",
      "txId": "0x35c******b360a174d",
      "to": "0xa30d1fab********7CF18C7B6C579",
      "areaCodeTo": "",
      "state": "2",
      "ts": "1655251200000",
      "wdId": "15447421"
    }
  ]
}

返回参数

参数名 类型 描述
subAcct String 子账户名称
ccy String 币种
chain String 币种链信息
有的币种下有多个链，必须要做区分，如USDT下有USDT-ERC20，USDT-TRC20，USDT-Omni多个链
nonTradableAsset Boolean 是否为不可交易资产
true：不可交易资产，false：可交易资产
amt String 数量
ts String 提币申请时间，Unix 时间戳的毫秒数格式，如 1655251200000
to String 收币地址
areaCodeTo String 如果to为手机号，该字段为该手机号的区号
tag String 部分币种提币需要标签，若不需要则不返回此字段
pmtId String 部分币种提币需要此字段（payment_id），若不需要则不返回此字段
memo String 部分币种提币需要此字段，若不需要则不返回此字段
addrEx Object 提币地址备注，部分币种提币需要，若不需要则不返回此字段。如币种TONCOIN的提币地址备注标签名为comment,则该字段返回：{'comment':'123456'}
txId String 提币哈希记录
内部转账该字段返回""
fee String 提币手续费数量
feeCcy String 提币手续费币种，如 USDT
state String 提币状态
-3：撤销中
-2：已撤销
-1：失败
0：等待提币
1：提币中
2：提币成功
7: 审核通过
10: 等待划转
4, 5, 6, 8, 9, 12: 等待客服审核
wdId String 提币申请ID
clientId String 客户自定义ID

获取子账户返佣记录

独立经纪商账户查看子账户的返佣记录，返佣记录数据更新时间为T+1。

限速：1次/10s

HTTP请求

GET /api/v5/broker/nd/rebate-daily

请求示例

GET /api/v5/broker/nd/rebate-daily

请求参数

参数名 类型 是否必须 描述
subAcct String 否 子账户名称
begin String 否 获取历史记录的时间区间
格式: YYYYMMdd，例如：20210623
end String 否 获取历史记录的时间区间
格式: YYYYMMdd，例如：20210627
page String 否 页码
例如：1第一页
limit String 否 分页返回的结果集数量，最大为100，不填默认返回100条

返回结果

{
    "code": "0",
    "data": [
        {
            "details": [
                {
                    "income": "1.9050116363636365",
                    "rebateDate": "20211119",
                    "subAcct": "brokerTest2"
                },
                {
                    "income": "3.5728228419999565",
                    "rebateDate": "20211119",
                    "subAcct": "brokerTest1"
                },
                {
                    "income": "10.6047378063846898",
                    "rebateDate": "20211119",
                    "subAcct": "brokerTest2"
                }
            ],
            "page": "",
            "totIncome": "16.0630733992516302",
            "totPage": "1",
            "ts": "1637303853605"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
ts String 接口数据时间，Unix时间戳的毫秒数格式 ，如 1597026383085
totIncome String 所有子账户总返佣金额
totPage String 总的页数
page String 当前页数
details Array 子账户返佣记录列表
> subAcct String 子账户名称
> income String 返佣金额 ，单位usdt
> rebateDate String 子账户返佣金额的更新时间

爆仓预警推送

推送：爆仓预警通知
频道名：liquidation-warning
此推送频道仅作为风险提示，不建议作为策略交易的风险判断
在行情剧烈波动的情况下，可能会出现此消息推送的同时仓位已经被强平的可能性。

获取已经申请成功的返佣明细下载链接，下载链接生成后，仅保留9小时有效。

限速：2次/1min

HTTP请求

GET /api/v5/broker/nd/rebate-per-orders

请求示例

GET https://www.okx.com/api/v5/broker/nd/rebate-per-orders?type=false&begin=20211109&end=20211208

请求参数

参数名 类型 是否必须 描述
type String 是 筛选条件类型，true： 获取当前用户所有已生成的历史记录 false：查询指定的历史记录
begin String 否 起始日期（格式: YYYYMMdd，例如："20210623"）
如果tpye填写false，该字段必填写
end String 否 结束日期（格式: YYYYMMdd，例如："20210626"）
如果tpye填写false，该字段必填写

返回结果

{
    "code": "0",
    "data": [
        {
            "fileHref": "http://okg-pri-hk.oss-cn-hongkong.aliyuncs.com/okex/broker/ndbroker_reward/da670b9f3b5ad2d7dd7d752c7291153d338f9b1887f_20211109_20211208.zip?Expires=1646913672&OSSAccessKeyId=LTAI5tKNPwWs7AttSB4asuUlDM8%3D",
            "state": "finished",
            "ts": "1646892328000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
fileHref String 文件链接
ts String 下载链接生成时间，Unix时间戳的毫秒数格式 ，如 1597026383085
state String 下载链接状态，"finished"：已生成，"ongoing"：进行中

解压后CSV里的字段说明

参数名 描述
subAcct 子账户名称
instId 交易产品
ordId 订单id
rebate 返佣金额，"USDT"为单位
ts 该笔订单最后一次成交时间

生成NDBroker下所有ND账户的历史返佣明细，

限速：1次/1h

HTTP请求

POST /api/v5/broker/nd/rebate-per-orders

请求示例

POST /api/v5/broker/nd/rebate-per-orders
body
{
    "begin":"20210623",
    "end":"20210626"
}

请求参数

参数名 类型 是否必须 描述
begin String 是 起始日期 （格式：YYYYMMdd，例如："20210623"）
end String 是 结束日期 （格式：YYYYMMdd，例如："20210626"）

返回结果

{
    "code": "0",
    "data": {
        "result": "false",
        "ts": "1646892328000"
    },
    "msg": ""
}

返回参数

参数名 类型 描述
result String 是否已经存在该区间的下载链接
true：已存在，可以通过"获取返佣明细下载链接"接口获取
false：不存在，正在生成，请6个小时后查看下载链接
ts String 服务端接收生成历史返佣明细请求的时间，Unix时间戳的毫秒数格式，如 1597026383085

获取双币赢产品列表

返回产品详细信息列表和预估报价。

限速：30次/2s

限速规则：IP

HTTP请求

GET /api/v5/finance/sfp/dcd/products

请求示例

GET /api/v5/finance/sfp/dcd/products
body
{
    "ccy": "BTC",
    "alternativeCcy": "USDT",
    "optType" : "C",
    "tag" : "123456789ABCDEFG"
}

请求参数

参数 类型 是否必须 描述
ccy String 是 风险货币 (如BTC,ETH)
alternativeCcy String 是 稳定货币 (如USDT)
optType String 是 期权类型，
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
tag String 是 经纪商订单标签

返回结果

{
    "code": 0,
    "data": [
        {
            "absYield": "0.01302066",
            "altCcy": "USDT",
            "annualYield": "0.683",
            "ccy": "BTC",
            "expTime": "1683878400000",
            "interestAccrualTime": "1683277200000",
            "listTime": "1682969037000",
            "maxSize": "200.0000000000000000",
            "minSize": "0.0001000000000000",
            "notionalCcy": "BTC",
            "optType": "C",
            "productId": "BTC-USDT-230512-29500-C",
            "quota": "198.9990000000000000",
            "quoteTime": "1683275022001",
            "settTime": "1683885600000",
            "stepSize": "0.0001",
            "stk": "29500",
            "tag": "123456789ABCDEFG",
            "uly": "BTC-USD"
        }
    ],
    "msg": ""
}

返回参数

参数 类型 描述
absYield String 产品预估回报
alternativeCcy String 稳定货币 (如USDT)
annualYield String 产品预估年化回报
ccy String 风险货币 (如BTC,ETH)
expTime String 到期时间
interestAccrualTime String 起息时间
listTime String 产品上线时间
maxSize String 订单最大数量（申购货币）
minSize String 订单最小数量（申购货币）
notionalCcy String 申购货币
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
optType String 期权类型，
C：看涨期权
P：看跌期权
productId String 产品ID
quota String 剩余额度（申购货币）
quoteTime String 报价时间
settTime String 结算时间
stopTradingTime String 最后申购时间
stepSize String 下单数量精度
stk String 行权价格
tag String 经纪商订单标签
uly String 标的指数

双币赢询价

返回产品最终报价

限速：2次/2s

限速规则：UserID

HTTP请求

POST /api/v5/finance/sfp/dcd/quote

请求示例

POST /api/v5/finance/sfp/dcd/quote
body
{
    "clReqId": "Q001",  
    "markUp": "0.05",
    "notional": "1", 
    "notionalCcy": "BTC", 
    "productId": "BTC-USDT-220414-30800-C", 
    "tag": "123456789ABCDEFG"
}

请求参数

参数 类型 是否必须 描述
clReqId String 否 客户端自定义的订单标识
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
markUp String 否 覆盖预设的分佣。如果省略，系统将应用预设的分佣值
必须0<=x<1
notional String 是 申购金额
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
notionalCcy String 是 申购货币，必须对应产品的申购货币
productId String 是 产品ID
tag String 是 经纪商订单标签

返回结果

{
    "code": 0,
    "msg": "",
    "data": [
        {
            "absYield": "0.001",
            "annualYield": "0.0822",
            "clQReqId": "Q001",
            "notional": "5", 
            "notionalCcy": "BTC",
            "productId": "BTC-USDT-221221-16900-C",
            "quoteId": "quoterbcDCD-QUOTE16715309383851388", 
            "ttlMs": "30000",
            "tag": "123456789ABCDEFG",
            "markUp": "0.05"
        }
    ]
}

返回参数

参数 类型 描述
absYield String 产品预估回报
annualYield String 产品预估年化回报
clReqId String 客户端自定义的订单标识
notional String 申购金额
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
notionalCcy String 申购货币，必须对应产品的申购货币
productId String 产品ID
quoteId String 报价ID
ttlMs String 报价有效期，单位为毫秒
tag String 经纪商订单标签
markUp String 覆盖的分佣。返回“”代表系统用预设的分佣值

双币赢交易

用拿到的quote ID下单。 下单时间一定是报价有效期内。

限速：2次/2s

限速规则：UserID

HTTP请求

POST /api/v5/finance/sfp/dcd/order

请求示例

POST /api/v5/finance/sfp/dcd/order
body
{
    "clOrdId": "T001",
    "quoteId": "quoterbcDCD-QUOTE16715309383851388"
}

请求参数

参数 类型 是否必须 描述
clOrdId String 否 用户自定义ID
字母（区分大小写）与数字的组合，可以是纯字母、纯数字且长度要在1-32位之间。
不能与所有订单的clOrdId重复
quoteId String 是 系统报价ID

返回结果

{
    "code": 0,
    "data": {
        "clOrdId": "T001",
        "orderId": "fa478b7a60d24cac966ea97c7e837380",
        "quoteId": "quoterbcDCD-QUOTE16715309383851388"
    },
    "msg": ""
}

返回参数

Parameter参数 Type类型 描述
clOrdId String 用户自定义ID
ordId String 订单ID
quoteId String 系统报价ID

获取双币赢订单

限速：10次/2s

限速规则：UserID

HTTP请求

GET /api/v5/finance/sfp/dcd/order

请求示例

GET /api/v5/finance/sfp/dcd/order
body
{
    "ordId": "1"
}

请求参数

参数 类型 是否必须 描述
ordId String 可选 系统报价ID
ordId或clOrdId 必填其一。若传ordId和clOrdId，以ordId为主
clOrdId String 可选 用户自定义ID

返回结果

{
    "code": 0,
    "data": [
        {
            "absYield": "0.00282333",
            "alternativeCcy": "USDT",
            "annualYield": "1.12420000",
            "cTime": "1683193229000",
            "ccy": "BTC",
            "clOrdId": "fa478b7a60d24cac966ea97c7e837380",
            "notional": "0.0100000000000000",
            "notionalCcy": "BTC",
            "ordId": "1",
            "productId": "BTC-USDT-230505-29250-C",
            "quoteId": "abcd1234",
            "settAmt": "0.01002823",
            "settCcy": "BTC",
            "settPrice": "23000.0000000000000000",
            "settledTime": "1683280819000",
            "state": "settled",
            "stk": "29250",
            "tag": "123456789ABCDEFG",
            "uTime": "1683280819000",
            "uly": "BTC-USD",
            "yieldAmt": "0.00002823",
            "yieldCcy": "BTC"
        }
    ],
    "msg": ""
}

返回参数

参数 类型 描述
absYield String 产品预估回报
alternativeCcy String 稳定货币 (如USDT)
annualYield String 产品预估年化回报
ccy String 风险货币(如BTC,ETH)
clOrdId String 用户自定义ID
cTime String 询价单创建时间，Unix时间戳的毫秒数格式。
optType String 期权类型，
C：看涨期权
P：看跌期权
ordId String 订单ID
notional String 申购金额
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
notionalCcy String 申购货币
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
productId String 产品ID
quoteId String 系统报价ID
settTime String 结算时间
settAmt String 结算金额（结算货币）
settCcy String 结算货币
settPrice String 计算价格。状态在 pending_settled 和 settled 才会有值返回
state String 订单状态
initial:处理中, live：赚币中, pending_settled:等待结算, settled：已结算, rejected：失败
stk String 行权价格
uTime String 订单状态更新时间，Unix时间戳的毫秒数格式
tag String 经纪商订单标签
uly String 标的指数

获取双币赢所有订单

限速：10次/2s

限速规则：UserID

HTTP请求

GET /api/v5/finance/sfp/dcd/orders

请求示例

GET /api/v5/finance/sfp/dcd/orders
body
{
    "productId": "BTC-USDT-230505-29250-C",
    "state": "settled"
}

请求参数

参数 类型 是否必须 描述
productId String 否 产品ID
uly String 否 标的指数
state String 否 订单状态
initial, live, pending_settled, settled, rejected
beginId String 否 请求的起始询价单ID，请求此ID之后（更新的数据）的分页内容，不包括 beginId
endId String 否 请求的结束询价单ID，请求此ID之前（更旧的数据）的分页内容，不包括 endId
begin String 否 "用开始时间戳筛创建时间，Unix时间戳的毫秒数格式，不包括 begin
end String 否 用结束时间戳筛选创建时间，Unix时间戳的毫秒数格式，不包括 end
limit String 否 返回结果的数量，最大为100，默认100条。 如果请求范围内的交易数量大于100，则返回该范围内最近的100笔交易。

返回结果

{
    "code": 0,
    "data": [
        {
            "absYield": "0.01163784",
            "alternativeCcy": "USDT",
            "annualYield": "0.51750000",
            "cTime": "1683166630000",
            "ccy": "BTC",
            "clOrdId": "fa478b7a60d24cac966ea97c7e837376",
            "notional": "0.0100000000000000",
            "notionalCcy": "BTC",
            "ordId": "1",
            "productId": "BTC-USDT-230512-30000-C",
            "quoteId": "abcd1234",
            "settAmt": "",
            "settCcy": "",
            "settPrice": "",
            "settledTime": "",
            "state": "live",
            "stk": "30000",
            "tag": "123456789ABCDEFG",
            "uTime": "1683166632000",
            "uly": "BTC-USD",
            "yieldAmt": "",
            "yieldCcy": ""
        }
    ],
    "msg": ""
}

返回参数

参数 类型 描述
absYield String 产品预估回报
alternativeCcy String 稳定货币 (如USDT)
annualYield String 产品预估年化回报
ccy String 风险货币(如BTC,ETH)
clOrdId String 用户自定义ID
cTime String 询价单创建时间，Unix时间戳的毫秒数格式。
optType String 期权类型，
C：看涨期权
P：看跌期权
ordId String 订单ID
notional String 申购金额
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
notionalCcy String 申购货币
C：看涨期权，申购货币是风险货币
P：看跌期权，申购货币是稳定货币
productId String 产品ID
quoteId String 系统报价ID
settTime String 结算时间
settAmt String 结算金额（结算货币）
settCcy String 结算货币
settPrice String 计算价格。状态在 pending_settled 和 settled 才会有值返回
state String 订单状态
initial:处理中, live：赚币中, pending_settled:等待结算, settled：已结算, rejected：失败
stk String 行权价格
uTime String 订单状态更新时间，Unix时间戳的毫秒数格式
tag String 经纪商订单标签
uly String 标的指数

FD (API和OAuth) 经纪商

OAuth 经纪商

简介

通过欧易OAuth 2.0用户仅需要在第三方应用内一键授权，即可进行交易。无需用户提供账户API Key或者登录密码。
欧易OAuth 2.0支持WEB和APP应用，基于OAuth 2.0协议（RFC 6749）和 OAuth 2.1草案协议中的一些新特征开发。

接入前的准备

  1. 官网注册账户申请经纪商
    您需要先申请成为OAuth经纪商，审核通过后您可以获取到client_id，client_secret信息。专属客户经理会提供给您相应的开发文档。
    接入步骤：
    1) 经纪商申请OKX的账户 2) 经纪商进入OKX经纪商官网申请OAuth经纪商，填写申请表，红色星为必填 3) OKX收到申请表后2天内会进行审核 4) 申请表在OKX的后台审核通过后，经纪商会收到邮件通知，邮件内容包括client_id和client_secret
  2. OAuth返佣设置
    当前接入的OAuth经纪商的返佣需要设置标签，下单时需要将BrokerCode标识填写到tag字段里，作为返佣订单统计的标识。

授权模式介绍

欧易OAuth 2.0提供的授权模式：授权码模式、PKCE模式。

授权模式 描述 使用场景
授权码模式 用户授权，第三方应用提供client_secret获取授权码。通过授权码获取访问令牌和刷新令牌。 应用有服务器，可存储应用密钥，与欧易OAuth服务器进行密钥交互。
PKCE模式 用户授权，第三方应用提供临时密钥code_verifier获取授权码。通过授权码获取访问令牌和刷新令牌 应用无服务器（或不愿意后端服务器介入授权过程），无法存储应用密钥，通过随机字符串与欧易OAuth服务器进行交互。

授权码模式

同时支持App与Web应用的接入，呈现授权页面给用户，第三方应用在获取用户的授权码后，可以凭借此授权码换取访问令牌，调用OKX OpenAPI，访问用户授权的数据资源。

PKCE模式

若第三方应用无服务端或者不希望服务端参与授权过程，无法存储第三方应用密钥（client_secret），则推荐此模式，通过应用客户端接入获取令牌，有效提升开发者应用的安全防护。

令牌的使用

令牌的区别

第三方应用通过授权码调用换取令牌接口后，会得到两种令牌。

如何使用

请求示例

curl -H "Content-Type:application/json" \
-H "Authorization:Bearer eyJhbGciOiJIUzUxMiIsImNpZCI6ImFhIn0.eyJqdGkiOiJleDExMDE2Mzg4NDM3ODg1MzIxMzMzNUVGMkVGRTNGOUM2Y1BJWiIsInVpZCI6IlEybEZxMnY2N0VybnVMZ0o1cFYzdUE9PSIsIm1pZCI6InFGbG5lVEc4dnlJeDNMSnNSa29qZ0E9PSIsImlhdCI6MTYzODg0Mzc4OCwiZXhwIjoxNjM4ODQ3Mzg4LCJzdWIiOiIxMC4yNTQuMjcuMTIwIiwiYW95IjoiOSIsInZlciI6IjEiLCJkZXYiOiIzMmNmOWM2My02NzM3LTRhYjUtYjFhYi04ODU4YWU2NTkxODUiLCJndHkiOiJhdXRob3JpemUifQ.bWXsgN7hTszxmdFB9xhr0Qh67HQWIp2zoxoqMCUzw2y1MBFPm38nNJJY9coljkivgAQPso81YUnHoLsFOLjxGg"  \
-H "TERMID:32cf9c63-6737-4ab5-b1ab-8858ae659185" \
https://www.okx.com/api/v5/asset/currencies

第三方应用完成授权并获取到令牌后，就可以通过访问令牌调用OKX OpenAPI接口了。 请求时需要在请求头中携带如下信息：

请求头字段 是否必须 描述
Authorization 是 将访问令牌以Bearer的方式填写到此字段
TERMID 可选 用于校验请求合法性的设备号信息
如果请求是由第三方应用客户端应用发起的（如选择了PKCE模式），则客户端应将客户端设备号在请求时带上
如果请求是由第三方应用服务端发起的（如选择了授权码模式），则无需填写此字段

令牌的有效期

超过了访问令牌的有效期，接口会调用失败，如果刷新令牌还在有效期内，第三方应用需要调用刷新令牌接口，获取新的一对访问令牌和刷新令牌。新的访问令牌可以继续使用。需要注意的是，一旦刷新了令牌，无论原来的令牌有没有过期，都不再有效。
当您撤销令牌后，原令牌将不再有效。

权限

权限 描述
read_only 拥有只读功能的权限（不包含子账户模块）
trade 拥有交易功能的权限（不包含子账户模块）

Fast API

简介

Fast API是帮助OKX用户快速授权第三方应用，创建APIKey并绑定第三方应用的功能。

Fast API工作流程

API Broker的界面上Broker用户登录之后，可以通过Oauth授权跳转到登录OKX页面，在OKX页面登录授权以后，OKX会授权该API Broker 拥有为其用户创建拥有只读和交易权限的API Key。

申请流程

  1. 在OKX申请API和OAuth经纪商
    • 建议申请第三方APP IP白名单
  2. 在OauthBroker应用程序中，提供
    • 第三方服务器IP白名单
    • 重定向URL
    • Logo
    • Fast API权限
    • 跨域域名
  3. 申请成功后，您会收到一封电子邮件，包含client_id和client_secret。请务必妥善保存此信息，不要对他人展示。

获取已经申请成功的返佣明细下载链接，每次请求时获取新的链接，且2小时内有效。

限速：2次/1min

HTTP请求

GET /api/v5/broker/fd/rebate-per-orders

请求示例

GET /api/v5/broker/fd/rebate-per-orders?type=false&begin=20211109&end=20211208

请求参数

参数名 类型 是否必须 描述
type String 是 筛选条件类型，true： 获取当前用户所有已生成的历史记录 false：查询指定的历史记录
begin String 否 起始日期，（格式: YYYYMMdd，例如："20210623"）
如果tpye填写false，该字段必填写
end String 否 结束日期 （格式: YYYYMMdd，例如："20210626"）
如果tpye填写false，该字段必填写
brokerType String 可选 经纪商类型
api：API经纪商
oauth：Oauth经纪商
当经纪商只有一种类型时，该参数可以不填
当经纪商有多种类型时，该参数必填

返回结果

{
    "code": "0",
    "data": [
        {
            "fileHref": "http://okg-pri-hk.oss-cn-hongkong.aliyuncs.com/okex/broker/pap/brokerRebateInfo/2c0ca94923dca9f53659507ee20a1f/2022-05-16/RebateDetails/RebateDetails0510-0513.xls?Expires=1652880844&OSSAccessKeyId=LTAIKNPwWs7ASPZn4iaa&Signature=ro%2BD2OMAgVzDrfguxjIM%2FY%3D",
            "state": "finished",
            "ts": "1646892328000"
        }
    ],
    "msg": ""
}

返回参数

参数名 类型 描述
fileHref String 文件链接
ts String 下载链接生成时间，Unix时间戳的毫秒数格式 ，如 1597026383085
state String 下载链接状态，"finished"：已生成，"ongoing"：进行中

解压后CSV里的字段说明

参数名 描述
brokerCode 申请到的BrokerCode标识
level 用户等级，如Lv1, Lv2, VIP1, VIP2
instId 产品ID
ordId 订单ID
spotTradeAmt 现货交易量（单位: USDT）
derivativeTradeAmt 衍生品交易量（单位: USDT）
fee 手续费（单位: USDT）
brokerRebate 经纪商返佣量（单位: USDT）
suBrokerRebate 经纪商助力人返佣量（单位: USDT）
userRebate 用户返佣量（单位: USDT）
affiliated 是否有节点返佣, true 或 false
ts 该笔订单当天最后一次成交时间
Unix 时间戳为毫秒数格式，如 1597026383085

生成FD Broker的历史返佣明细。

限速：1次/1h

HTTP请求

POST /api/v5/broker/fd/rebate-per-orders

请求示例

POST /api/v5/broker/fd/rebate-per-orders
body
{
    "begin":"20210623",
    "end":"20210626"
}

请求参数

参数名 类型 是否必须 描述
begin String 是 起始日期，（格式: YYYYMMdd，例如："20210623"）
end String 是 结束日期 格式: YYYYMMdd，例如："20210626"）
brokerType String 可选 经纪商类型
api：API经纪商
oauth：Oauth经纪商
当经纪商只有一种类型时，该参数可以不填
当经纪商有多种类型时，该参数必填

返回结果

{
    "code": "0",
    "data": {
        "result": "true",
        "ts": "1646892328000"
    },
    "msg": ""
}

返回参数

参数名 类型 描述
result String 是否请求成功
true：请求成功，false：请求失败
如果为true，请6个小时后查看下载链接
ts String 服务端接收生成历史返佣明细请求的时间，Unix时间戳的毫秒数格式 ，如 1597026383085

获取用户的 Broker 返佣信息

FD broker 查询用户是否有返佣条件，满足Broker返佣条件、下单时指定了 brokerCode、且用户的交易产生手续费时，Broker 会获得返佣。

限速：5次/2s

HTTP请求

GET /api/v5/broker/fd/if-rebate

请求示例

GET https://www.okx.com/api/v5/broker/fd/if-rebate?apiKey=63d54aa0-0020-4ad9-a9f0-ac92654bc831

请求参数

参数名 类型 是否必须 描述
apiKey String 是 用户的 API key
brokerType String 可选 经纪商类型
api：API经纪商
oauth：Oauth经纪商
当经纪商只有一种类型时，该参数可以不填
当经纪商有多种类型时，该参数必填

返回结果

{
    "code": "0",
    "data": {
        "affiliated": false,
        "brokerCode": "6099c63a8d75SCDE",
        "type": "0"
    },
    "msg": ""
}

返回参数

参数名 类型 描述
type Boolean 账户无法Broker返佣的原因：
0 可以返佣
1 Broker 身份过期
2 用户手续费等级是VIP3或以上
brokerCode String FD broker 申请到的 BrokerCode 标识
affiliated String 绑定关系的情况，有无节点返佣
false：无节点返佣
true：有节点返佣

错误码

错误提示 HTTP 状态码 错误码
53000 400 无效的token
53001 400 无效的授权，用户已取消授权
53002 400 token已过期
53003 400 token已撤销
53004 400 用户已被冻结
53005 400 刷新令牌不正确
53006 401 无效的设备
53009 400 授权失败
53010 400 参数{0}错误
53011 400 必填参数{0}不能为空
53012 400 授权码已过期
53013 400 接口权限不足
53014 401 无效的IP
53015 400 参数{参数名}长度超过最大限制{长度}
53016 400 无效的redirect_uri
53017 400 快捷 API 权限尚未开启