查詢返佣信息

信息

• 使用經紀商的母帳戶進行查詢
• 支持查詢過去1個月的數據至T-1. 要取得1個月之前的數據, 請聯繫您的客戶經理
• begin & end兩個入参, 要麼同時輸入, 要麼都不輸入. 当不输入时, 默认返回最近7天的数据

API頻率: 10次/秒

HTTP 請求

GET/v5/broker/earnings-info

請求參數

參數	是否必需	類型	說明
bizType	false	string	業務類型. SPOT, DERIVATIVES, OPTIONS, CONVERT, FIAT_CONVERT
begin	false	string	開始時間, 格式: YYYYMMDD, 比如, 20231201, 表示搜尋時間是從2023年12月1日 00:00:00 UTC (包含)
end	false	string	結束時間, 格式: YYYYMMDD, 比如, 20231201, 表示搜尋時間是結束於2023年12月2日 00:00:00 UTC (不包含)
uid	false	string	輸入子UID來查詢指定UID的具體數據 要向獲得所有子UID的數據, 則不傳
limit	false	integer	每頁數量限制. [1, 1000]. 默認: 1000
cursor	false	string	游標，用於翻頁

響應參數

參數	類型	說明
totalEarningCat	Object	按照業務類型統計的總的返佣數據
> spot	array	Object. 現貨交易的返佣. 如果沒有對應的返佣或者沒有查詢該類型, 則返回空數組 []
>> coin	string	返佣幣種
>> earning	string	返佣金額
> derivatives	array	Object. 期貨交易的返佣. 如果沒有對應的返佣或者沒有查詢該類型, 則返回空數組 []
>> coin	string	返佣幣種
>> earning	string	返佣金額
> options	array	Object. 期權交易的返佣. 如果沒有對應的返佣或者沒有查詢該類型, 則返回空數組 []
>> coin	string	返佣幣種
>> earning	string	返佣金額
> convert	array	Object. 閃兌交易的返佣. 如果沒有對應的返佣或者沒有查詢該類型, 則返回空數組 []
>> coin	string	返佣幣種
>> earning	string	返佣金額
> fiatConvert	array	Object. 法幣閃兌交易的返佣. 如果沒有對應的返佣或者沒有查詢該類型, 則返回空數組 []
>> coin	string	返佣幣種
>> earning	string	返佣金額
> total	array	Object. 所有業務類型的返佣總和. 如果沒有對應的返佣或者沒有查詢該類型, 則返回空數組 []
>> coin	string	返佣幣種
>> earning	string	返佣金額
details	array	Object. 每個子UID以及每個業務類型的交易細節
> userId	string	子帳戶
> bizType	string	業務類型. SPOT, DERIVATIVES, OPTIONS, CONVERT, FIAT_CONVERT
> symbol	string	幣對名
> coin	string	返佣幣種
> earning	string	返佣金額
> markupEarning	string	加點佣金
> baseFeeEarning	string	基礎佣金
> orderId	string	訂單ID
> execId	string	成交ID
> execTime	string	訂單執行時間戳 (毫秒)
nextPageCursor	string	游標，用於翻頁

請求示例

HTTP

GET /v5/broker/earnings-info?begin=20231129&end=20231129&uid=117894077 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1701399431920
X-BAPI-RECV-WINDOW: 5000
X-BAPI-SIGN: 32d2aa1bc205ddfb89849b85e2a8b7e23b1f8f69fe95d6f2cb9c87562f9086a6
Content-Type: application/json

Python

from pybit.unified_trading import HTTP
session = HTTP(
    testnet=True,
    api_key="xxxxxxxxxxxxxxxxxx",
    api_secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
)
print(session.get_exchange_broker_earnings(
    begin="20231129",
    end="20231129",
    uid="117894077",
))

Node.js

const { RestClientV5 } = require('bybit-api');

const client = new RestClientV5({
  testnet: true,
  key: 'xxxxxxxxxxxxxxxxxx',
  secret: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
});

client
  .getExchangeBrokerEarnings({
    bizType: 'SPOT',
    begin: '20231201',
    end: '20231207',
    limit: 1000,
  })
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(error);
  });

響應示例

{
    "retCode": 0,
    "retMsg": "success",
    "result": {
        "totalEarningCat": {
            "spot": [],
            "derivatives": [],
            "options": [],
            "convert": [],
            "fiatConvert": [
                {
                    "coin": "USDT",
                    "earning": "0.00054991"
                }
            ],
            "total": [
                {
                    "coin": "USDT",
                    "earning": "0.00054991"
                }
            ]
        },
        "details": [
            {
                "userId": "1008564218",
                "bizType": "FIAT_CONVERT",
                "symbol": "MNTUSDT",
                "coin": "USDT",
                "earning": "0.00054991",
                "markupEarning": "0.00031423",
                "baseFeeEarning": "0.00023568",
                "orderId": "f26255a9-3db4-43d6-8c4a-9b31e295a16b",
                "execId": "35c3ac53-2d71-5e0a-9098-69aa5c911a65",
                "execTime": "1719785271731"
            }
        ],
        "nextPageCursor": ""
    },
    "retExtInfo": {},
    "time": 1701398193964
}