Skip to main content
GET
/
v1
/
accounts
/
referrals
/
stats
Get Referral Statistics
curl --request GET \
  --url https://api.predictamarkets.com/v1/accounts/referrals/stats \
  --header 'X-Api-Key: <api-key>'
{
  "referral_code": "JANE42",
  "interval_days": 30,
  "total_referred": 42,
  "total_earnings": "126.00",
  "total_visits": 310,
  "pending_referrals": 5,
  "completed_referrals": 37,
  "unverified_referrals": 8,
  "period_earnings": "45.00",
  "qualified_referrals": 15,
  "first_trade_volume": "220.50",
  "earnings_by_event_type": [
    {
      "event_type": "DEPOSIT",
      "total": "33.00",
      "count": 11
    },
    {
      "event_type": "TRADE",
      "total": "12.00",
      "count": 8
    }
  ],
  "earning_rules": [
    {
      "id": 1,
      "name": "Partner deposit bonus",
      "event_type": "DEPOSIT",
      "earn_type": "FIXED",
      "fixed_amount": "3.00",
      "rate": null,
      "percentage_base": null,
      "min_trigger_amount": "15.00",
      "max_occurrences": 1,
      "is_global": false
    },
    {
      "id": 2,
      "name": "First trade commission",
      "event_type": "TRADE",
      "earn_type": "PERCENTAGE",
      "fixed_amount": null,
      "rate": "0.015000",
      "percentage_base": "TRANSACTION_AMOUNT",
      "min_trigger_amount": null,
      "max_occurrences": 1,
      "is_global": false
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.predictamarkets.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
default:your-api-key-here
required

Query Parameters

​
interval_days
integer

Scope period-specific stats to the last N days. Omit for all-time.

Required range: x >= 1
Example:

30

Response

Referral stats

Aggregated referral performance statistics for the authenticated account. All-time totals are always present; period-scoped stats (qualified_referrals, first_trade_volume, period_earnings, earnings_by_event_type) are filtered to the interval_days window if provided.

​
total_referred
integer
required

All-time total number of accounts that signed up using this referral code.

​
total_earnings
string
required

All-time total referral earnings credited to this account (in PT).

Example:

"126.00"

​
total_visits
integer
required

All-time total number of visits tracked via this referral code (before or without registration).

​
pending_referrals
integer
required

Referred accounts that have signed up but not yet completed the qualifying action (e.g. first trade or verification).

​
completed_referrals
integer
required

Referred accounts that have completed all qualifying actions and triggered a payout.

​
unverified_referrals
integer
required

Referred accounts that registered but have not yet verified their identity.

​
period_earnings
string
required

Total earnings within the interval_days window (in PT). Null if no interval was specified.

Example:

"45.00"

​
qualified_referrals
integer
required

Number of referred accounts within the interval that met the first qualifying action threshold (e.g. placed their first trade).

​
first_trade_volume
string
required

Total volume of first trades placed by referred accounts within the interval.

Example:

"220.50"

​
earnings_by_event_type
EarningsByEventTypeResponse · object[]
required

Breakdown of period earnings grouped by the event type that triggered each earning (DEPOSIT, TRADE, SIGNUP, etc.).

​
earning_rules
EarningRuleResponse · object[]
required

The active referral earning rules that apply to this account's program.

​
referral_code
string | null

The authenticated account's referral code. Share this to earn commissions.

​
interval_days
integer | null

The time window (in days) used for period-scoped stats. Null if all-time stats were requested.