API Documentation — Money & Balance

GET

Get user balance Retrieve user actual balance. -/user/balance

This method requires authorization!

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

This method - requires permissions - balance.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/balance

Query parameters

Identifier	Regulations	Example
currencyNot necessarily	nullablecurrency_code	"USD"

Code examples

JavaScript

async function getUserBalance() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/balance?' + Object.entries({
         "currency": "USD"
      }).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 balance history -/user/balance-history

This method requires authorization!

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

This method - requires permissions - balance.history

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/balance-history

Query parameters

Identifier	Regulations	Example
typeNot necessarily	nullableapp\_validators\_ex_in_rule	""
with-hiddenNot necessarily	nullableex-boolean	false
fromNot necessarily	nullabledate	null
toNot necessarily	nullabledate	null
searchNot necessarily	nullablestring	39
redirect-urlNot necessarily	nullableurl	738
per-pageNot necessarily	nullableinteger	47
pageNot necessarily	nullableinteger	48
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"

Code examples

JavaScript

async function getUserBalanceHistory() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/balance-history?' + Object.entries({
         "type": "",
         "with-hidden": false,
         "from": null,
         "to": null,
         "search": 39,
         "redirect-url": 738,
         "per-page": 47,
         "page": 48,
         "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 balance subscriptions -/user/balance-subscriptions

This method requires authorization!

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

This method - requires permissions - balance.subscriptions

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/balance-subscriptions

Query parameters

Identifier	Regulations	Example
fromNot necessarily	nullabledate	null
toNot necessarily	nullabledate	null
statusNot necessarily	nullablenumeric	0
searchNot necessarily	nullablestring	69
redirect-urlNot necessarily	nullableurl	360
per-pageNot necessarily	nullableinteger	61
pageNot necessarily	nullableinteger	74
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"

Code examples

JavaScript

async function getUserBalanceSubscriptions() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/balance-subscriptions?' + Object.entries({
         "from": null,
         "to": null,
         "status": 0,
         "search": 69,
         "redirect-url": 360,
         "per-page": 61,
         "page": 74,
         "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

View balance history entry -/user/balance-history/{id}

This method requires authorization!

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

This method - requires permissions - balance.history

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/balance-history/{id}

Query parameters

Identifier	Regulations	Example
id	1required	38

Code examples

JavaScript

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

Examples of answers

Success response

DELETE

Unsubscribe Unsubscribe from balance subscription. -/user/balance-subscriptions/{subscription}

This method requires authorization!

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

This method - requires permissions - balance.un-subscribe

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/balance-subscriptions/{subscription}

Query parameters

Identifier	Regulations	Example
subscription	1required	null

Code examples

JavaScript

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

Examples of answers

Success response

PUT

Toggle subscription auto renew Money & Balance User -/user/balance-subscriptions/{subscription}/toggle

This method requires authorization!

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

This method - requires permissions - balance.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/balance-subscriptions/{subscription}/toggle

Query parameters

Identifier	Regulations	Example
subscription	1required	null

Code examples

JavaScript

async function putUserBalanceSubscriptionsToggle() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/balance-subscriptions/{subscription}/toggle'
      .replace("{subscription}", null), {
         method: 'PUT',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

Get currency rates -/money/rates

Query method

GEThttp://apilocal.stableproxy.com/v2/money/rates

Code examples

JavaScript

async function getMoneyRates() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/money/rates', {
         method: 'GET',
         headers: {
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

POSTPUT

User topup Make payment request, then redirect to payment page. -/user/topup

This method requires authorization!

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

This method - requires permissions - topup.upload

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/topup

Query parameters

Identifier	Regulations	Example
method-id	requiredapp\_validators\_ex_in_rule	57
amount	requirednumeric	30894
currency	requiredcurrency_code	"USD"
is-buyingNot necessarily	nullableex_boolean	false
subscriptionNot necessarily	nullable	null
redirect-urlNot necessarily	nullableurl	961

Code examples

JavaScript

async function postUserTopup() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/topup', {
         method: 'POST',
         headers: {
            'Authorization': 'API-Token [YOUR TOKEN]',
            'Content-Type': 'application/json'
         },
         body: JSON.stringify({
            "method-id": 57,
            "amount": 30894,
            "currency": "USD",
            "is-buying": false,
            "subscription": null,
            "redirect-url": 961
         }),
      }
   );
   
   const res = await req.json();
}

Examples of answers

Success response

GET

Get user topup methods Money & Balance User -/user/topup-methods

This method requires authorization!

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

This method - requires permissions - topup.methods

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/topup-methods

Code examples

JavaScript

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

Examples of answers

Success response

GET

Finalize amount Calculates your amount after applying active promocodes / bonuses. -/user/topup/finalize-amount

Query method

GEThttp://apilocal.stableproxy.com/v2/user/topup/finalize-amount

Query parameters

Identifier	Regulations	Example
amount	requirednumeric	36199
currencyNot necessarily	nullablecurrency_code	"USD"

Code examples

JavaScript

async function getUserTopupFinalizeAmount() {
   const baseUrl = 'http://apilocal.stableproxy.com/v2';
   const req = await fetch(baseUrl + '/user/topup/finalize-amount?' + Object.entries({
         "amount": 36199,
         "currency": "USD"
      }).map(([key, value]) => key + "=" + value).join('&'), {
         method: 'GET',
         headers: {
            'Content-Type': 'application/json'
         }
      }
   );
   
   const res = await req.json();
}