Download Referee History

Downloads a detailed history of referee trading activity, individual performance, and commission rewards in a CSV format.

This API is restricted to Flipster Affiliates only. If you are not an affiliate, requests to these endpoints will return a 400 Bad Request with the error type UserNotKol.

This endpoint allows affiliates to export comprehensive historical data regarding their referral network, including active referee counts, total trading volumes, and specific commission distributions. The data provided through this API is identical to the information available in the "Referee history" section at the bottom of the Flipster support page (https://flipster.io/support/affiliate).

It supports granular filtering by date range and username, and also enables partners to view data for their sub-affiliates via a referral code. The generated CSV file provides in-depth insights—such as taker fee rates, effective commission rates, and individual referee UIDs—making it an essential tool for performance tracking and auditing referral growth.

CSV Data Columns

The exported CSV file contains the following fields:

date	Date and time of the record (Format: YYYYMMDDTHH)
totalRewards	Total rewards for the specified day (USDT)
activeReferees	Number of active referees for the day
totalTradingVolume	Total trading volume including bonus (USDT)
totalEligibleTradingVolume	Total eligible trading volume excluding bonus (USDT)
totalTradingFee	Total trading fee including bonus (USDT)
totalEligibleTradingFee	Total eligible trading fee excluding bonus (USDT)
username	Referee's username
uid	Referee's unique identifier (UID)
referralType	Referral type (e.g., AFFILIATE or REFERRAL)
vipTier	VIP tier of the referee
takerFee	Taker fee rate applied to the referee
reward	Individual reward generated from the referee (USDT)
tradingVolume	Individual trading volume including bonus (USDT)
eligibleTradingVolume	Individual eligible trading volume excluding bonus (USDT)
tradingFee	Individual trading fee including bonus (USDT)
eligibleTradingFee	Individual eligible trading fee excluding bonus (USDT)
effectiveCommissionRate	The effective commission rate applied

Download Referee History

get

Required scopes

This endpoint requires the following scopes:

Authorizations

thirdPartyApiKeyAuth

api-keystringRequired

For third party retail API users

Query parameters

startDateanyOptional

start date in YYYY-MM-DD, inclusive. omit for all period.

endDateanyOptional

end date in YYYY-MM-DD, inclusive. omit for all period.

usernamestringOptional

username filter

referralCodestringOptional

Optional: referral code of a sub-affiliate to view their data

Responses

200

Returns affiliate_child_daily_record table data in CSV format.

CSV Columns:

• date: Date (YYYYMMDDTHH)
• totalRewards: Total rewards for the day (USDT)
• activeReferees: Number of active referees for the day
• totalTradingVolume: Total trading volume including bonus (USDT)
• totalEligibleTradingVolume: Total eligible trading volume excluding bonus (USDT)
• totalTradingFee: Total trading fee including bonus (USDT)
• totalEligibleTradingFee: Total eligible trading fee excluding bonus (USDT)
• username: Referee username
• uid: Referee UID
• referralType: Referral type (AFFILIATE or REFERRAL)
• vipTier: VIP tier of the referee
• takerFee: Taker fee rate
• reward: Individual reward for the referee (USDT)
• tradingVolume: Individual trading volume including bonus (USDT)
• eligibleTradingVolume: Individual eligible trading volume excluding bonus (USDT)
• tradingFee: Individual trading fee including bonus (USDT)
• eligibleTradingFee: Individual eligible trading fee excluding bonus (USDT)
• effectiveCommissionRate: Effective commission rate

text/csv

ResponsestringExample: date,totalRewards,activeReferees,totalTradingVolume,totalEligibleTradingVolume,totalTradingFee,totalEligibleTradingFee,username,uid,referralType,vipTier,takerFee,reward,tradingVolume,eligibleTradingVolume,tradingFee,eligibleTradingFee,effectiveCommissionRate 20260101T00,0.15847291,2,599.92968000,200.00000000,0.29996484,0.28795622,user1,U1A2B3C,REFERRAL,0,0.00050000,0.05279381,199.97656000,0.00000000,0.09998828,0.09598874,0.55000000 20260101T00,0.15847291,2,599.92968000,200.00000000,0.29996484,0.28795622,subaffiliate1,S4D5E6F,AFFILIATE,1,0.00045000,0.10567910,399.95312000,200.00000000,0.19997656,0.19196748,0.52500000

400

Bad Request

• invalidDateAffiliateOverview (api.affiliateOverview.invalidDate): Invalid date range
• UserNotKol (api.user.notKol): Caller or the target user (if provided via referralCode parameter) is not an affiliate
• InvalidParameter (api.invalidParameter): Invalid referral code

application/json

401

Unauthorized

• Unauthorized (api.unauthorized)

application/json

403

Forbidden

• Forbidden (api.forbidden): Referral code is not a sub-affiliate of the caller

application/json

get

/api/v1/affiliate/overview-referral-history-csv

HTTPcURLJavaScriptPython

GET /api/v1/affiliate/overview-referral-history-csv HTTP/1.1
Host: trading-api.flipster.io
api-key: YOUR_API_KEY
Accept: */*

date,totalRewards,activeReferees,totalTradingVolume,totalEligibleTradingVolume,totalTradingFee,totalEligibleTradingFee,username,uid,referralType,vipTier,takerFee,reward,tradingVolume,eligibleTradingVolume,tradingFee,eligibleTradingFee,effectiveCommissionRate
20260101T00,0.15847291,2,599.92968000,200.00000000,0.29996484,0.28795622,user1,U1A2B3C,REFERRAL,0,0.00050000,0.05279381,199.97656000,0.00000000,0.09998828,0.09598874,0.55000000
20260101T00,0.15847291,2,599.92968000,200.00000000,0.29996484,0.28795622,subaffiliate1,S4D5E6F,AFFILIATE,1,0.00045000,0.10567910,399.95312000,200.00000000,0.19997656,0.19196748,0.52500000