Skip to Content
Indexify
Social

Get referral data

GET
/api/referrals.php

Returns the authenticated user's multi-level referral tree with volume data for each referred user.

Authorization

ApiKeyAuth
headerX-API-KEY<token>

API key with the ix_ prefix. You can generate an API Key by navigating to Settings -> API Key in the web app. Pass it in the X-API-KEY header on every request.

Response Body

Multi-level referral data with volume statistics.

application/json
  1. response
level1?array<>
level2?array<>
level3?array<>
summary?
pagination?

Pagination metadata from the incentive service.

Example Request
curl -X GET 'https://api.indexify.finance/api/referrals.php'
Example Response
{  "level1": [    {      "userId": "string",      "username": "string",      "volume_data": {        "username": "string",        "total_successful_orders": 0,        "total_orders": 0,        "total_volume_micro_usdc": 0,        "total_volume_usdc": 0,        "total_platform_fees_micro_usdc": 0,        "total_platform_fees_usdc": 0,        "total_creator_fees_micro_usdc": 0,        "total_creator_fees_usdc": 0,        "first_order_timestamp": 0,        "last_order_timestamp": 0,        "buy_volume_micro_usdc": 0,        "buy_volume_usdc": 0,        "sell_volume_micro_usdc": 0,        "sell_volume_usdc": 0,        "buy_orders_count": 0,        "sell_orders_count": 0,        "success_rate": 0      }    }  ],  "level2": [    {      "userId": "string",      "username": "string",      "volume_data": {        "username": "string",        "total_successful_orders": 0,        "total_orders": 0,        "total_volume_micro_usdc": 0,        "total_volume_usdc": 0,        "total_platform_fees_micro_usdc": 0,        "total_platform_fees_usdc": 0,        "total_creator_fees_micro_usdc": 0,        "total_creator_fees_usdc": 0,        "first_order_timestamp": 0,        "last_order_timestamp": 0,        "buy_volume_micro_usdc": 0,        "buy_volume_usdc": 0,        "sell_volume_micro_usdc": 0,        "sell_volume_usdc": 0,        "buy_orders_count": 0,        "sell_orders_count": 0,        "success_rate": 0      }    }  ],  "level3": [    {      "userId": "string",      "username": "string",      "volume_data": {        "username": "string",        "total_successful_orders": 0,        "total_orders": 0,        "total_volume_micro_usdc": 0,        "total_volume_usdc": 0,        "total_platform_fees_micro_usdc": 0,        "total_platform_fees_usdc": 0,        "total_creator_fees_micro_usdc": 0,        "total_creator_fees_usdc": 0,        "first_order_timestamp": 0,        "last_order_timestamp": 0,        "buy_volume_micro_usdc": 0,        "buy_volume_usdc": 0,        "sell_volume_micro_usdc": 0,        "sell_volume_usdc": 0,        "buy_orders_count": 0,        "sell_orders_count": 0,        "success_rate": 0      }    }  ],  "summary": {    "total_referrals": 0,    "total_volume_usdc": 0,    "total_platform_fees_usdc": 0,    "total_successful_orders": 0,    "by_level": {      "property1": {        "count": 0,        "total_volume_usdc": 0,        "total_platform_fees_usdc": 0,        "total_successful_orders": 0      },      "property2": {        "count": 0,        "total_volume_usdc": 0,        "total_platform_fees_usdc": 0,        "total_successful_orders": 0      }    }  },  "pagination": {}}