API Documentation — Money & Balance

GET

Get user 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

1async function getUserBalance() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/balance?' + Object.entries({
4         "currency": "USD"
5      }).map(([key, value]) => key + "=" + value).join('&'), {
6         method: 'GET',
7         headers: {
8            'Authorization': 'API-Token [YOUR TOKEN]',
9            'Content-Type': 'application/json'
10         }
11      }
12   );
13   
14   const res = await req.json();
15}

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

1async function getUserBalanceHistory() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/balance-history?' + Object.entries({
4         "type": "",
5         "with-hidden": false,
6         "from": null,
7         "to": null,
8         "search": 39,
9         "redirect-url": 738,
10         "per-page": 47,
11         "page": 48,
12         "sort-by": "",
13         "sort-order": "asc"
14      }).map(([key, value]) => key + "=" + value).join('&'), {
15         method: 'GET',
16         headers: {
17            'Authorization': 'API-Token [YOUR TOKEN]',
18            'Content-Type': 'application/json'
19         }
20      }
21   );
22   
23   const res = await req.json();
24}

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

1async function getUserBalanceSubscriptions() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/balance-subscriptions?' + Object.entries({
4         "from": null,
5         "to": null,
6         "status": 0,
7         "search": 69,
8         "redirect-url": 360,
9         "per-page": 61,
10         "page": 74,
11         "sort-by": "",
12         "sort-order": "asc"
13      }).map(([key, value]) => key + "=" + value).join('&'), {
14         method: 'GET',
15         headers: {
16            'Authorization': 'API-Token [YOUR TOKEN]',
17            'Content-Type': 'application/json'
18         }
19      }
20   );
21   
22   const res = await req.json();
23}

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

1async function getUserBalanceHistory() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/balance-history/{id}'
4      .replace("{id}", 38), {
5         method: 'GET',
6         headers: {
7            'Authorization': 'API-Token [YOUR TOKEN]',
8            'Content-Type': 'application/json'
9         }
10      }
11   );
12   
13   const res = await req.json();
14}

Examples of answers

Success response

DELETE

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

1async function deleteUserBalanceSubscriptions() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/balance-subscriptions/{subscription}'
4      .replace("{subscription}", null), {
5         method: 'DELETE',
6         headers: {
7            'Authorization': 'API-Token [YOUR TOKEN]',
8            'Content-Type': 'application/json'
9         }
10      }
11   );
12   
13   const res = await req.json();
14}

Examples of answers

Success response

PUT

Toggle subscription auto renew -/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

1async function putUserBalanceSubscriptionsToggle() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/balance-subscriptions/{subscription}/toggle'
4      .replace("{subscription}", null), {
5         method: 'PUT',
6         headers: {
7            'Authorization': 'API-Token [YOUR TOKEN]',
8            'Content-Type': 'application/json'
9         }
10      }
11   );
12   
13   const res = await req.json();
14}

Examples of answers

Success response

GET

Get currency rates -/money/rates

Query method

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

Code examples

JavaScript

1async function getMoneyRates() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/money/rates', {
4         method: 'GET',
5         headers: {
6            'Content-Type': 'application/json'
7         }
8      }
9   );
10   
11   const res = await req.json();
12}

Examples of answers

Success response

POSTPUT

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

1async function postUserTopup() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/topup', {
4         method: 'POST',
5         headers: {
6            'Authorization': 'API-Token [YOUR TOKEN]',
7            'Content-Type': 'application/json'
8         },
9         body: JSON.stringify({
10            "method-id": 57,
11            "amount": 30894,
12            "currency": "USD",
13            "is-buying": false,
14            "subscription": null,
15            "redirect-url": 961
16         }),
17      }
18   );
19   
20   const res = await req.json();
21}

Examples of answers

Success response

GET

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

1async function getUserTopupMethods() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/topup-methods', {
4         method: 'GET',
5         headers: {
6            'Authorization': 'API-Token [YOUR TOKEN]',
7            'Content-Type': 'application/json'
8         }
9      }
10   );
11   
12   const res = await req.json();
13}

Examples of answers

Success response

GET

Finalize amount -/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

1async function getUserTopupFinalizeAmount() {
2   const baseUrl = 'http://apilocal.stableproxy.com/v2';
3   const req = await fetch(baseUrl + '/user/topup/finalize-amount?' + Object.entries({
4         "amount": 36199,
5         "currency": "USD"
6      }).map(([key, value]) => key + "=" + value).join('&'), {
7         method: 'GET',
8         headers: {
9            'Content-Type': 'application/json'
10         }
11      }
12   );
13   
14   const res = await req.json();
15}