查詢代理用戶列表
要使用此接口,您应该有一个代理商账户,并且在创建 API 密钥时仅勾选“代理商”权限。
代理商网站: https://affiliates.bybit.com
提示
- 僅支持使用母帳戶uid
- 若要查詢該接口, api key僅能擁有代理商權限, 若擁有任何其他權限想, 請移除
HTTP 請求
GET /v5/affiliate/aff-user-list
請求參數
參數 | 是否必需 | 類型 | 說明 |
---|---|---|---|
size | false | integer | 每頁數量限制. [0 , 1000 ]. 默認: 0 |
cursor | false | string | 游標,用於翻頁 |
返回參數
參數 | 類型 | 說明 |
---|---|---|
list | array | Object |
> userId | string | 帳戶uid |
> registerTime | string | 用戶註冊時間 |
> source | integer | 用戶註冊來源,來自哪个Referrer Code |
> remarks | integer | 備註 |
> isKyc | boolean | KYC是否完成 |
> takerVol30Day | string | 過去30天的吃單交易量, T+1更新. 單位: USDT. 所有下方交易量相關的字段, 包含了期貨、期權和現貨的交易量 |
> makerVol30Day | string | 過去30天的掛單交易量, T+1更新. 單位: USDT |
> tradeVol30Day | string | 過去30天的總交易量, T+1更新. 單位: USDT |
> depositAmount30Day | string | 過去30天的入金金額, 5分鐘內更新. 單位: USDT |
> takerVol365Day | string | 過去一年的吃單交易量, T+1更新. 單位: USDT |
> makerVol365Day | string | 過去一年的掛單交易量, T+1更新. 單位: USDT |
> tradeVol365Day | string | 過去一年的總交易量, T+1更新. 單位: USDT |
> depositAmount365Day | string | 過去一年的總入金金額, 5分鐘內更新. 單位: USDT |
nextPageCursor | string | 游標,用於翻頁 |
Request Example
- HTTP
- Python
- Node.js
GET /v5/affiliate/aff-user-list?cursor=""&size=2 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-API-KEY: uQ61dcX0lSe7ygD2EA
X-BAPI-TIMESTAMP: 1685596324209
X-BAPI-RECV-WINDOW: 5000
X-BAPI-SIGN: xxxxxx
Content-Type: application/json
const { RestClientV5 } = require('bybit-api');
const client = new RestClientV5({
testnet: true,
key: 'apikey',
secret: 'apisecret',
});
client
.getAffiliateUserInfo({ size: 2 })
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error(error);
});
Response Example
{
"retCode": 0,
"retMsg": "",
"result": {
"list": [
{
"userId": "101527036",
"registerTime": "2024-06-21",
"source": "1564",
"remarks": "test",
"isKyc": false,
"takerVol30Day": "10",
"makerVol30Day": "20",
"tradeVol30Day": "30",
"depositAmount30Day": "90",
"takerVol365Day": "100",
"makerVol365Day": "500",
"tradeVol365Day": "600",
"depositAmount365Day": "1300",
},
{
"userId": "103929118",
"registerTime": "2024-11-12",
"source": "1564",
"remarks": "",
"isKyc": false,
"takerVol30Day": "10",
"makerVol30Day": "20",
"tradeVol30Day": "30",
"depositAmount30Day": "90",
"takerVol365Day": "100",
"makerVol365Day": "500",
"tradeVol365Day": "600",
"depositAmount365Day": "1300",
}
],
"nextPageCursor": "16197"
},
"retExtInfo": {},
"time": 1733205472513
}