Get Earning

info

• Use exchange broker master account to query
• The data can support up to past 1 months until T-1. To extract data from over a month ago, please contact your Relationship Manager
• begin & end are either entered at the same time or not entered, and latest 7 days data are returned by default

API rate limit: 10 req / sec

HTTP Request

GET/v5/broker/earnings-info

Request Parameters

Parameter	Required	Type	Comments
bizType	false	string	Business type. SPOT, DERIVATIVES, OPTIONS, CONVERT, FIAT_CONVERT
begin	false	string	Begin date, in the format of YYYYMMDD, e.g, 20231201, search the data from 1st Dec 2023 00:00:00 UTC (include)
end	false	string	End date, in the format of YYYYMMDD, e.g, 20231201, search the data before 2nd Dec 2023 00:00:00 UTC (exclude)
uid	false	string	To get results for a specific subaccount: Enter the subaccount UID To get results for all subaccounts: Leave the field empty
limit	false	integer	Limit for data size per page. [1, 1000]. Default: 1000
cursor	false	string	Cursor. Use the nextPageCursor token from the response to retrieve the next page of the result set

Response Parameters

Parameter	Type	Comments
totalEarningCat	Object	Category statistics for total earning data
> spot	array	Object. Earning for Spot trading. If do not have any rebate, keep empty array
>> coin	string	Rebate coin name
>> earning	string	Rebate amount of the coin
> derivatives	array	Object. Earning for Derivatives trading. If do not have any rebate, keep empty array
>> coin	string	Rebate coin name
>> earning	string	Rebate amount of the coin
> options	array	Object. Earning for Option trading. If do not have any rebate, keep empty array
>> coin	string	Rebate coin name
>> earning	string	Rebate amount of the coin
> convert	array	Object. Earning for Convert trading. If do not have any rebate, keep empty array
>> coin	string	Rebate coin name
>> earning	string	Rebate amount of the coin
> fiatConvert	array	Object. Earning for Fiat Convert trading. If do not have any rebate, keep empty array
>> coin	string	Rebate coin name
>> earning	string	Rebate amount of the coin
> total	array	Object. Sum earnings of all categories. If do not have any rebate, keep empty array
>> coin	string	Rebate coin name
>> earning	string	Rebate amount of the coin
details	array	Object. Detailed trading information for each sub UID and each category
> userId	string	Sub UID
> bizType	string	Business type. SPOT, DERIVATIVES, OPTIONS, CONVERT, FIAT_CONVERT
> symbol	string	Symbol name
> coin	string	Rebate coin name
> earning	string	Rebate amount
> markupEarning	string	Earning generated from markup fee rate
> baseFeeEarning	string	Earning generated from base fee rate
> orderId	string	Order ID
> execId	string	Trade ID
> execTime	string	Order execution timestamp (ms)
nextPageCursor	string	Refer to the cursor request parameter

Request Example

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);
  });

Response Example

{
    "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
}