API Documentation

PUT

Change proxy pool

/package/proxy/{id}/{proxyIndex}/pool

Change the pool for an already-added residential proxy.

Passing pool_id=null reverts to the default pool. Only applicable to residential_gb and residential_city_gb package types.

This method requires authorization!

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

This method - requires permissions -packages-proxies.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/v2/package/proxy/{id}/{proxyIndex}/pool

Query parameters

Identifier	Regulations	Example
pool_idNot necessarily	nullablestring	22
id	1required	81
proxyIndex	1required	93

Code examples

1const baseUrl = "https://api.stableproxy.com/v2";
2const response = await fetch(baseUrl + "/package/proxy/{id}/{proxyIndex}/pool", {
3  method: "PUT",
4  headers: {
5    "Authorization": "API-Token [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  },
8  body: JSON.stringify({
9    "pool_id": 22
10  })
11});
12const data = await response.json();

GET

Get note

/package/note/{id}/{proxyIndex}

You can read note for proxy.

This method requires authorization!

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

This method - requires permissions -packages.set-note

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/v2/package/note/{id}/{proxyIndex}

Query parameters

Identifier	Regulations	Example
noteNot necessarily	nullablestring	98
id	1required	6
proxyIndex	1required	95

Code examples

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

Examples of answers

Success response200application/json

{
  "data": {
    "note": "A note"
  },
  "good": true,
  "timestamp": 1731487566,
  "cause": {
    "type": "user",
    "user_id": 1,
    "token_id": 9845,
    "token_sign": "edd87db549cd52292a47ad455bbea947"
  }
}

PUT

Change all proxies pool

/package/proxy/{id}/pool

Change the pool for ALL proxies in a package at once.

Iterates over all sub-users and updates every proxy's pool_id. Passing pool_id=null removes the explicit pool (reverts to upstream default routing). Only applicable to residential_gb and residential_city_gb package types.

This method requires authorization!

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

This method - requires permissions -packages-proxies.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/v2/package/proxy/{id}/pool

Query parameters

Identifier	Regulations	Example
pool_idNot necessarily	nullablestring	47
id	1required	89

Code examples

1const baseUrl = "https://api.stableproxy.com/v2";
2const response = await fetch(baseUrl + "/package/proxy/{id}/pool", {
3  method: "PUT",
4  headers: {
5    "Authorization": "API-Token [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  },
8  body: JSON.stringify({
9    "pool_id": 47
10  })
11});
12const data = await response.json();

GET

Get proxy pools

/package/proxy/{id}/pools

Get available proxy pools for a package. Only applicable to residential_gb and residential_city_gb package types.

This method requires authorization!

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

This method - requires permissions -packages-proxies.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/v2/package/proxy/{id}/pools

Query parameters

Identifier	Regulations	Example
id	1required	87

Code examples

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

Proxies

Query method

Query parameters

Code examples

Query method

Query parameters

Code examples

Examples of answers

Query method

Query parameters

Code examples

Query method

Query parameters

Code examples