API Documentation

GET

List referral tokens Referral -/user/referral

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/user/referral

Query parameters

Identifier	Regulations	Example
searchNot necessarily	nullablestring	6
per-pageNot necessarily	nullableinteger	5
pageNot necessarily	nullableinteger	60
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"

Code examples

JavaScript

async function getUserReferral() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral?' + Object.entries({
         "search": 6,
         "per-page": 5,
         "page": 60,
         "sort-by": "",
         "sort-order": "asc"
      }).map(([key, value]) => key + "=" + value).join('&'), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

POST

Create referral token Referral -/user/referral

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.create

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

POSThttp://apilocal.stableproxy.com/v2/user/referral

Query parameters

Identifier	Regulations	Example
nameNot necessarily	nullablestring	33
tokenNot necessarily	nullablestring	9

Code examples

JavaScript

async function postUserReferral() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral', {
         method: 'POST',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         },
         body: JSON.stringify({
            "name": 33,
            "token": 9
         }),
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

DELETE

Delete referral token Referral -/user/referral/{id}

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.delete

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

DELETEhttp://apilocal.stableproxy.com/v2/user/referral/{id}

Query parameters

Identifier	Regulations	Example
id	1required	39

Code examples

JavaScript

async function deleteUserReferral() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral/{id}'
      .replace("{id}", 39), {
         method: 'DELETE',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

PUT

Update referral token Referral -/user/referral/{id}

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.update

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

PUThttp://apilocal.stableproxy.com/v2/user/referral/{id}

Query parameters

Identifier	Regulations	Example
nameNot necessarily	nullablestring	39
tokenNot necessarily	nullablestring	12
id	1required	39

Code examples

JavaScript

async function putUserReferral() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral/{id}'
      .replace("{id}", 39), {
         method: 'PUT',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         },
         body: JSON.stringify({
            "name": 39,
            "token": 12
         }),
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

View referral token Referral -/user/referral/{id}

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/user/referral/{id}

Query parameters

Identifier	Regulations	Example
id	1required	39

Code examples

JavaScript

async function getUserReferral() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral/{id}'
      .replace("{id}", 39), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

List registered users Referral -/user/referral/{id}/referrals

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/user/referral/{id}/referrals

Query parameters

Identifier	Regulations	Example
per-pageNot necessarily	nullableinteger	15
pageNot necessarily	nullableinteger	93
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"
id	1required	3

Code examples

JavaScript

async function getUserReferralReferrals() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral/{id}/referrals'
      .replace("{id}", 3) + '?' + Object.entries({
         "per-page": 15,
         "page": 93,
         "sort-by": "",
         "sort-order": "asc"
      }).map(([key, value]) => key + "=" + value).join('&'), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

List received transactions Referral -/user/referral/{id}/transactions

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/user/referral/{id}/transactions

Query parameters

Identifier	Regulations	Example
per-pageNot necessarily	nullableinteger	9
pageNot necessarily	nullableinteger	47
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"
id	1required	25

Code examples

JavaScript

async function getUserReferralTransactions() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral/{id}/transactions'
      .replace("{id}", 25) + '?' + Object.entries({
         "per-page": 9,
         "page": 47,
         "sort-by": "",
         "sort-order": "asc"
      }).map(([key, value]) => key + "=" + value).join('&'), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

List visits by token Referral -/user/referral/{id}/visits

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/user/referral/{id}/visits

Query parameters

Identifier	Regulations	Example
per-pageNot necessarily	nullableinteger	22
pageNot necessarily	nullableinteger	58
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"
id	1required	60

Code examples

JavaScript

async function getUserReferralVisits() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral/{id}/visits'
      .replace("{id}", 60) + '?' + Object.entries({
         "per-page": 22,
         "page": 58,
         "sort-by": "",
         "sort-order": "asc"
      }).map(([key, value]) => key + "=" + value).join('&'), {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

Get user referred by Referral -/user/referred-by

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - referral.by

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/user/referred-by

Code examples

JavaScript

async function getUserReferredBy() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referred-by', {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

Summary statistics Referral -/user/referral-summary

This method requires authorization!

You can use your own API key, which can be obtained at control panel.

This method - requires permissions - packages.read

When creating an API token in your control panel, you can choose certain permissions (for example: prevent the token from placing orders).
You can also find a list of permissions in our documentation.

Query method

GEThttp://apilocal.stableproxy.com/v2/user/referral-summary

Code examples

JavaScript

async function getUserReferralSummary() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/referral-summary', {
         method: 'GET',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}