Skip to main content

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

ParameterRequiredTypeComments
bizTypefalsestringBusiness type. SPOT, DERIVATIVES, OPTIONS, CONVERT
beginfalsestringBegin date, in the format of YYYYMMDD, e.g, 20231201, search the data from 1st Dec 2023 00:00:00 UTC (include)
endfalsestringEnd date, in the format of YYYYMMDD, e.g, 20231201, search the data before 2nd Dec 2023 00:00:00 UTC (exclude)
uidfalsestring
  • To get results for a specific sub-account: Enter the sub-account UID
  • To get results for all sub-accounts: Leave the field empty
limitfalseintegerLimit for data size per page. [1, 1000]. Default: 1000
cursorfalsestringCursor. Use the nextPageCursor token from the response to retrieve the next page of the result set

Response Parameters

ParameterTypeComments
totalEarningCatObjectCategory statistics for total earning data
> spotarrayObject. Earning for Spot trading. If do not have any rebate, keep empty array
>> coinstringRebate coin name
>> earningstringRebate amount of the coin
> derivativesarrayObject. Earning for Derivatives trading. If do not have any rebate, keep empty array
>> coinstringRebate coin name
>> earningstringRebate amount of the coin
> optionsarrayObject. Earning for Option trading. If do not have any rebate, keep empty array
>> coinstringRebate coin name
>> earningstringRebate amount of the coin
> convertarrayObject. Earning for Convert trading. If do not have any rebate, keep empty array
>> coinstringRebate coin name
>> earningstringRebate amount of the coin
> totalarrayObject. Sum earnings of all categories. If do not have any rebate, keep empty array
>> coinstringRebate coin name
>> earningstringRebate amount of the coin
detailsarrayObject. Detailed trading information for each sub UID and each category
> userIdstringSub UID
> bizTypestringBusiness type. SPOT, DERIVATIVES, OPTIONS, CONVERT
> symbolstringSymbol name
> coinstringRebate coin name
> earningstringRebate amount
> markupEarningstringEarning generated from markup fee rate
> baseFeeEarningstringEarning generated from base fee rate
> orderIdstringOrder ID
> execTimestringOrder execution timestamp (ms)
nextPageCursorstringRefer to the cursor request parameter

Request Example

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

Response Example

{
"retCode": 0,
"retMsg": "success",
"result": {
"totalEarningCat": {
"spot": [],
"derivatives": [
{
"coin": "USDT",
"earning": "0.00027844"
}
],
"options": [],
"total": [
{
"coin": "USDT",
"earning": "0.00027844"
}
]
},
"details": [
{
"userId": "117894077",
"bizType": "DERIVATIVES",
"symbol": "DOGEUSDT",
"coin": "USDT",
"earning": "0.00016166",
"markupEarning": "0.000032332",
"baseFeeEarning": "0.000129328",
"orderId": "ec2132f2-a7e0-4a0c-9219-9f3cbcd8e878",
"execTime": "1701275846033"
},
{
"userId": "117894077",
"bizType": "DERIVATIVES",
"symbol": "TRXUSDT",
"coin": "USDT",
"earning": "0.00011678",
"markupEarning": "0.000023356",
"baseFeeEarning": "0.000093424",
"orderId": "28b29c2b-ba14-450e-9ce7-3cee0c1fa6da",
"execTime": "1701245285017"
}
],
"nextPageCursor": ""
},
"retExtInfo": {},
"time": 1701398193964
}