Get Sub-affiliate Info

Rate limit: 10/sec/UID

Description

Query sub-affiliate information.

HTTP Request

• GET /api/v2/broker/sub-affiliate-info

Request

curl "https://api.bitget.com/api/v2/broker/sub-affiliate-info" \
  -H "ACCESS-KEY:your apiKey" \
  -H "ACCESS-SIGN:*" \
  -H "ACCESS-PASSPHRASE:*" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "locale:en-US" \
  -H "Content-Type: application/json"

Request Parameters

Parameter	Type	Required	Description
uid	String	No	User ID Pass a sub-affiliate's UID to query the info for that specific sub-affiliate
startTime	String	No	Query start time Unix millisecond timestamp
endTime	String	No	Query end time Unix millisecond timestamp The interval between startTime and endTime cannot exceed 30 days
idLessThan	String	No	Cursor ID Used for pagination; retrieves data prior to this ID
limit	String	No	Number of results to return Default 100, maximum 100
includeDownLine	String	No	Whether to include downline users yes Yes no No Default yes if not provided

Response

{
  "code": "00000",
  "msg": "success",
  "requestTime": 1758512000000,
  "data": {
    "list": [
      {
        "uid": "123456789",
        "uplineName": "agentUser001",
        "rebateRateList": [
          {
            "rebateType": "futures",
            "rebateRate": "5"
          },
          {
            "rebateType": "spot",
            "rebateRate": "5"
          }
        ],
        "verificationStatus": "verified",
        "directReferrals": "10",
        "subAffiliates": "2",
        "subAffiliateDirectReferrals": "20",
        "volume": "100000",
        "deposit": "5000",
        "transactionFee": "300",
        "rebate": "150"
      }
    ],
    "endId": "123456789"
  }
}

Response Parameter

Parameter	Type	Description
list	Array	Sub-affiliate list
>uid	String	User ID
>uplineName	String	Upline name
>rebateRateList	Array	Rebate rate list
>>rebateType	String	Rebate type futures Futures regular rebate futures_api Futures API rebate futures_trader Futures trading expert rebate futures_trader_api Futures trading expert API rebate spot Spot regular rebate spot_api Spot API rebate spot_trader Spot trading expert rebate spot_trader_api Spot trading expert API rebate onchain Onchain regular rebate onchain_api Onchain API rebate onchain_trader Onchain trading expert rebate onchain_trader_api Onchain trading expert API rebate cfd CFD regular rebate cfd_api CFD API rebate cfd_trader CFD trading expert rebate cfd_trader_api CFD trading expert API rebate stock Stock regular rebate stock_api Stock API rebate stock_trader Stock trading expert rebate stock_trader_api Stock trading expert API rebate
>>rebateRate	String	Rebate rate Percentage value, e.g., 5 represents 5%
>verificationStatus	String	Verification status verified Verified not_verified Not verified Includes both KYC and KYB results; a user who passes either KYC or KYB is considered verified
>directReferrals	String	Number of direct referrals
>subAffiliates	String	Number of sub-affiliates
>subAffiliateDirectReferrals	String	Number of direct referrals under sub-affiliates
>volume	String	Trading volume Unit: USDT
>deposit	String	Deposit amount Unit: USDT
>transactionFee	String	Transaction fee Unit: USDT
>rebate	String	Rebate amount Unit: USDT Rebate paid back to the channel by the sub-affiliate
endId	String	Pagination end ID Used as the query cursor for the next request