Get Account Referral

Get the authenticated account’s invite code, parent referral code, direct referral count, and fee share rate.

GET /v1/account/referral

Get Account Referral

cURL

curl --request GET \
  --url https://api.perpetuals.polymarket.com/v1/account/referral \
  --header 'POLYMARKET-PROXY: <api-key>' \
  --header 'POLYMARKET-SECRET: <api-key>'

import requests

url = "https://api.perpetuals.polymarket.com/v1/account/referral"

headers = {
    "POLYMARKET-PROXY": "<api-key>",
    "POLYMARKET-SECRET": "<api-key>"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'POLYMARKET-PROXY': '<api-key>', 'POLYMARKET-SECRET': '<api-key>'}
};

fetch('https://api.perpetuals.polymarket.com/v1/account/referral', 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.perpetuals.polymarket.com/v1/account/referral",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "POLYMARKET-PROXY: <api-key>",
    "POLYMARKET-SECRET: <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.perpetuals.polymarket.com/v1/account/referral"

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

	req.Header.Add("POLYMARKET-PROXY", "<api-key>")
	req.Header.Add("POLYMARKET-SECRET", "<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.perpetuals.polymarket.com/v1/account/referral")
  .header("POLYMARKET-PROXY", "<api-key>")
  .header("POLYMARKET-SECRET", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.perpetuals.polymarket.com/v1/account/referral")

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

request = Net::HTTP::Get.new(url)
request["POLYMARKET-PROXY"] = '<api-key>'
request["POLYMARKET-SECRET"] = '<api-key>'

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

200

{
  "code": "ABC123",
  "children_count": 12,
  "referrals_left": 11,
  "fee_share_rate": "0.2",
  "parent": "ABC123"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

{
  "status": "err",
  "error": "insufficient_margin"
}

Request Weight: 1

Authorizations

POLYMARKET-PROXY · string · header · required

Proxy address

POLYMARKET-SECRET · string · header · required

Correponding proxy secret

Response

200

application/json

Account referral response.

code · string · required

Referral or invite code

Example:

"ABC123"

children_count · integer · required

Number of directly referred child accounts

Example:

12

referrals_left · integer · required

Number of additional referrals remaining for this account's invite code

Example:

11

fee_share_rate · string · required

Referral fee share rate. Defaults to 0.2.

Example:

"0.2"

parent · string

Parent referral code, omitted when the account has no parent referral.

Example:

"ABC123"