API For Affiliate
Retrieves aggregated affiliate performance statistics, including referral counts, current level, commission totals, and amounts already processed (withdrawn, converted, or transferred).
Successful response
Affiliate statistics response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/stats HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": {
"registered_users": 1,
"today_commission": 1,
"total_commission": 1,
"total_commission_valid": 1,
"withdrawn_amount": 1,
"current_level": {
"number": 1,
"title": "text",
"rate": 1,
"goal_amount": 1
},
"all_level": [
{
"number": 1,
"title": "text",
"rate": 1,
"goal_amount": 1
}
]
}
}Returns the complete list of affiliate levels, including each level's title, commission rate, and the purchase threshold required to reach the next level.
Successful response
Affiliate levels response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/all-level HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": [
{
"number": 1,
"title": "text",
"rate": 1,
"goal_amount": 1
}
]
}Returns a paginated list of users referred through the affiliate program, including basic identity fields and the invite code used.
Maximum number of items to return per page. Default: 30
Requested page number (1-based). Default: 1
Successful response
Referred users list response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/list-referred-user HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": {
"items": [
{
"username": "text",
"email": "text",
"invite_code_used": "text",
"created_at": 1
}
],
"total_items": 1,
"total_pages": 1
}
}Returns a paginated list of commission records generated from referred users, including amount, rate, payment method, validation status, and creation time.
Maximum number of items to return per page. Default: 30
Requested page number (1-based). Default: 1
Successful response
Commissions list response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/list-commission HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": {
"items": [
{
"id": 1,
"amount": 1,
"rate": 1,
"payment_method": 1,
"is_valid": true,
"created_at": 1,
"account": {
"email": "text",
"username": "text"
}
}
],
"total_items": 1,
"total_pages": 1
}
}Returns a paginated list of commission conversion records, showing the commission amount used and the resulting value received, along with the conversion timestamp.
Maximum number of items to return per page. Default: 30
Requested page number (1-based). Default: 1
Successful response
Conversions list response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/list-conversion HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": {
"items": [
{
"amount": 1,
"number_of_ips": 1,
"created_at": 1
}
],
"total_items": 1,
"total_pages": 1
}
}Returns a paginated list of affiliate invite codes, including code metadata, activation status, and timestamps.
Maximum number of items to return per page. Default: 30
Requested page number (1-based). Default: 1
Successful response
Invite codes list response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/list-invite-code HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": {
"items": [
{
"id": 1,
"account_id": 1,
"code": "text",
"name": "text",
"custom_path": "text",
"is_default": true,
"is_active": true,
"created_at": 1,
"updated_at": 1
}
],
"total_items": 1,
"total_pages": 1
}
}Returns a paginated list of affiliate withdrawal requests, including payout details, destination wallet information, status, and creation time.
Maximum number of items to return per page. Default: 30
Requested page number (1-based). Default: 1
Successful response
Withdrawals list response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/list-withdrawn HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": {
"items": [
{
"id": 1,
"email": "text",
"amount": 1,
"coin": "text",
"wallet_address": "text",
"status": 1,
"created_at": 1
}
],
"total_items": 1,
"total_pages": 1
}
}Returns a paginated list of commission transfers to wallet balance, including amount, processing status, and creation time.
Maximum number of items to return per page. Default: 30
Requested page number (1-based). Default: 1
Successful response
Wallet transfers list response payload.
Indicates whether the request was successful.
Human-readable response message.
Bad request
Authentication error
GET /client/v1/affiliate/list-transfer-to-wallet HTTP/1.1
Host: sandbox.9proxy.com
Accept: */*
{
"success": true,
"message": "text",
"result": {
"items": [
{
"id": 1,
"email": "text",
"amount": 1,
"status": 1,
"created_at": 1
}
],
"total_items": 1,
"total_pages": 1
}
}Last updated
Was this helpful?