API Documentation

GET

Get your account

New/account/view

Replaces older v2 methods

This API v3 method replaces these API v2 methods (they still work):

Info

Your account

Profile, currency and — when the token may read it — the balance.

Notes

Needs user.read (OAuth scope account:read); the balance needs balance.read, which account:read includes.

This method requires authorization!

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

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

GEThttps://api.stableproxy.com/v3/account/view

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/view", {
3  method: "GET",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

GET

Balance history

New/account/balance-history

Balance history

Every top-up, purchase, renewal and refund on the balance, newest first, paginated.

Notes

Filter with type, from, to (dates) or search; amounts are in the account currency.

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

GEThttps://api.stableproxy.com/v3/account/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	131
redirect-urlNot necessarily	nullableurl	1003
per-pageNot necessarily	nullableinteger	83
pageNot necessarily	nullableinteger	44
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/balance-history", {
3  method: "GET",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

GET

List saved payment subscriptions

New/account/subscriptions

Saved payment subscriptions

Cards and wallets saved for automatic top-ups, with whether auto-renew is on.

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

GEThttps://api.stableproxy.com/v3/account/subscriptions

Query parameters

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

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/subscriptions", {
3  method: "GET",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

PUT

Turn auto-renew of a subscription on or off

New/account/subscriptions/{subscription}/auto-renew

Toggle auto-renew

Switches automatic renewal of one saved subscription. Each call flips it.

Notes

Needs account:manage.

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

PUThttps://api.stableproxy.com/v3/account/subscriptions/{subscription}/auto-renew

Query parameters

Identifier	Regulations	Example
subscription	1requiredinteger	1

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/subscriptions/{subscription}/auto-renew", {
3  method: "PUT",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

DELETE

Cancel a saved subscription

New/account/subscriptions/{subscription}

Cancel a subscription

Stops and removes a saved payment subscription. Nothing already paid is refunded.

Notes

Needs account:manage. Ask the user before calling it.

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

DELETEhttps://api.stableproxy.com/v3/account/subscriptions/{subscription}

Query parameters

Identifier	Regulations	Example
subscription	1requiredinteger	1

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/subscriptions/{subscription}", {
3  method: "DELETE",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

GET

Get the low-balance alert

New/account/balance-alert

Replaces older v2 methods

This API v3 method replaces these API v2 methods (they still work):

Low-balance alert

Whether the user is notified when the balance drops below a threshold, and that threshold in the account currency.

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

GEThttps://api.stableproxy.com/v3/account/balance-alert

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/balance-alert", {
3  method: "GET",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

PUT

Set the low-balance alert

New/account/balance-alert

Replaces older v2 methods

This API v3 method replaces these API v2 methods (they still work):

Set the low-balance alert

Turns the alert on or off and sets its threshold.

Notes

enabled (boolean) and amount in the account currency. Needs account:manage.

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

PUThttps://api.stableproxy.com/v3/account/balance-alert

Query parameters

Identifier	Regulations	Example
enabled	requiredboolean	false
amount	requirednumeric	91924

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/balance-alert", {
3  method: "PUT",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  },
8  body: JSON.stringify({
9    "enabled": "false",
10    "amount": 91924
11  })
12});
13const data = await response.json();

GET

List notifications

New/account/notifications

Replaces older v2 methods

This API v3 method replaces these API v2 methods (they still work):

Notifications

Notifications

The user's notifications, newest first, paginated.

Notes

mark-as-read=true also marks them read — only when the user has seen them.

This method requires authorization!

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

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

GEThttps://api.stableproxy.com/v3/account/notifications

Query parameters

Identifier	Regulations	Example
mark-as-readNot necessarily	nullableex-boolean	false
searchNot necessarily	nullablestring	92
per-pageNot necessarily	nullableinteger	40
pageNot necessarily	nullableinteger	67
sort-byNot necessarily	nullablestringapp\_validators\_ex_in_rule	""
sort-orderNot necessarily	nullablestringin:asc, desc	"asc"

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/notifications", {
3  method: "GET",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

GET

List top-up methods

New/account/topup-methods

Top-up methods

Payment methods available to this user for topping up the balance, with their limits.

Notes

Top up with Create an order (action: topup) and Confirm and pay an order.

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

GEThttps://api.stableproxy.com/v3/account/topup-methods

Code examples

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/topup-methods", {
3  method: "GET",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

Account

Your account

Notes

Query method

Code examples

Balance history

Notes

Query method

Query parameters

Code examples

Saved payment subscriptions

Query method

Query parameters

Code examples

Toggle auto-renew

Notes

Query method

Query parameters

Code examples

Cancel a subscription

Notes

Query method

Query parameters

Code examples

Low-balance alert

Query method

Code examples

Set the low-balance alert

Notes

Query method

Query parameters

Code examples

Notifications

Notes

Query method

Query parameters

Code examples

Top-up methods

Notes

Query method

Code examples