Get Referral Statistics

GET

accounts

referrals

stats

curl --request GET \
  --url https://api.predictamarkets.com/v1/accounts/referrals/stats \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.predictamarkets.com/v1/accounts/referrals/stats"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.predictamarkets.com/v1/accounts/referrals/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.predictamarkets.com/v1/accounts/referrals/stats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.predictamarkets.com/v1/accounts/referrals/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.predictamarkets.com/v1/accounts/referrals/stats")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.predictamarkets.com/v1/accounts/referrals/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

{
  "detail": "Not authenticated"
}

{
  "detail": "An unexpected error occurred. Please try again later."
}

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.).

Show child attributes

earning_rules

EarningRuleResponse · object[]

required

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

Show child attributes

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.

List Referral EarningsPaginated history of referral earnings for the authenticated user. Filter by time window or event type.

Get Referral Statistics

curl --request GET \
  --url https://api.predictamarkets.com/v1/accounts/referrals/stats \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.predictamarkets.com/v1/accounts/referrals/stats"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.predictamarkets.com/v1/accounts/referrals/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.predictamarkets.com/v1/accounts/referrals/stats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.predictamarkets.com/v1/accounts/referrals/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.predictamarkets.com/v1/accounts/referrals/stats")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.predictamarkets.com/v1/accounts/referrals/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
    }
  ]
}

{
  "detail": "Not authenticated"
}

{
  "detail": "An unexpected error occurred. Please try again later."
}

Overview

Markets

Orders

Account

Referrals

Authorizations

Query Parameters

Response