Proxiware API

Programmatic access to every product in the dashboard — metered proxies, static ISP, unlimited residential, billing, and reseller sub-users. All requests authenticate with a single API key.

REST / JSON API-KEY header api.proxiware.com/v1 
curl https://api.proxiware.com/v1/account \
  -H "API-KEY: your_api_key_here"

Getting Started

Authentication

curl https://api.proxiware.com/v1/account \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.get(
    "https://api.proxiware.com/v1/account",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/account", {
  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());

Base URL & Errors

Account

GET /account

Get account

curl https://api.proxiware.com/v1/account \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/account",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/account", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{
  "email": "[email protected]",
  "credit": 25.50,
  "max_users": 10,
  "verified": true,
  "notify_credit_enabled": false,
  "notify_credit_threshold": 0,
  "created_at": 1712345678
}

Billing

POST /account/credit/deposit

Deposit credit

Body Parameters
Name Type Required Description
amount number required Amount in USD ($5–$9999) 
curl -X POST https://api.proxiware.com/v1/account/credit/deposit \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"amount":20}'
import requests

r = requests.request(
    "POST",
    "https://api.proxiware.com/v1/account/credit/deposit",
    headers={"API-KEY": "your_api_key_here"}, json={"amount":20}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/account/credit/deposit", {
  method: "POST",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"amount":20})
});
console.log(await res.json());
Response 200 
{
  "id": 5001,
  "description": "$20.00 Credit Deposit",
  "amount_due": 20.00,
  "status": "New",
  "created_at": 1712345678
}
GET /invoices

List invoices

curl https://api.proxiware.com/v1/invoices \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/invoices",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/invoices", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
[
  {
    "id": 5001,
    "description": "$20.00 Credit Deposit",
    "amount_due": 20.00,
    "status": "Paid",
    "payment_method": "stripe",
    "created_at": 1712345678
  }
]
GET /invoices/{id}

Get invoice

Path Parameters
Name Type Required Description
id integer required Invoice ID 
curl https://api.proxiware.com/v1/invoices/5001 \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/invoices/5001",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/invoices/5001", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{
  "id": 5001,
  "description": "Residential Starter Proxy Plan",
  "amount_due": 3.00,
  "status": "Paid",
  "payment_method": "credit",
  "items": [
    {
      "product_type": "metered_plan",
      "name": "Residential Starter Proxy Plan",
      "price_per_unit": 3.00,
      "quantity": 1
    }
  ],
  "created_at": 1712345678
}
POST /invoices/{id}/pay/credit

Pay invoice with credit

Path Parameters
Name Type Required Description
id integer required Invoice ID 
curl -X POST https://api.proxiware.com/v1/invoices/5001/pay/credit \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "POST",
    "https://api.proxiware.com/v1/invoices/5001/pay/credit",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/invoices/5001/pay/credit", {
  method: "POST",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());

Metered Proxies

GET /metered/networks/{network}

Get network info

Path Parameters
Name Type Required Description
network string required
residential residential-eco mobile datacenter 
curl https://api.proxiware.com/v1/metered/networks/residential \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/metered/networks/residential",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{
  "pools": [
    {"id": "1", "geo": "US", "features": ["http", "socks5"], "enabled": true}
  ]
}
GET /metered/networks/{network}/plans

List plans

Path Parameters
Name Type Required Description
network string required
residential residential-eco mobile datacenter 
curl https://api.proxiware.com/v1/metered/networks/residential/plans \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/metered/networks/residential/plans",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/plans", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
[{"id":1,"name":"Starter","bytes":1073741824,"price_per_gb":3.00,"duration_days":30}]
GET /metered/networks/{network}/subscriptions

List active subscriptions

Path Parameters
Name Type Required Description
network string required
residential residential-eco mobile datacenter 
curl https://api.proxiware.com/v1/metered/networks/residential/subscriptions \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
[{"id":200,"network":"residential","bytes":1073741824,"bytes_used":573741824,"active":true,"plan":{"name":"Starter","price_per_gb":3.00,"bytes":1073741824}}]
GET /metered/networks/{network}/subscriptions/{id}

Get subscription

Path Parameters
Name Type Required Description
network string required
residential residential-eco mobile datacenter
id integer required Subscription ID 
curl https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200 \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{
  "id": 200,
  "network": "residential",
  "bytes": 1073741824,
  "bytes_used": 573741824,
  "billing_cycle_start_date": 1712000000,
  "billing_cycle_end_date": 1714592000,
  "auto_renewal": true,
  "active": true,
  "plan": {
    "name": "Starter",
    "price_per_gb": 3.00,
    "bytes": 1073741824
  }
}
POST /metered/purchase/plan

Purchase a data plan

Body Parameters
Name Type Required Description
plan_id integer required Plan ID from GET /metered/networks/{network}/plans
pay_with_credit boolean optional Pay immediately from wallet balance 
curl -X POST https://api.proxiware.com/v1/metered/purchase/plan \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"plan_id":1,"pay_with_credit":true}'
import requests

r = requests.request(
    "POST",
    "https://api.proxiware.com/v1/metered/purchase/plan",
    headers={"API-KEY": "your_api_key_here"}, json={"plan_id":1,"pay_with_credit":true}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/purchase/plan", {
  method: "POST",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"plan_id":1,"pay_with_credit":true})
});
console.log(await res.json());
Response 200 
{
  "id": 5010,
  "description": "Residential Starter Proxy Plan",
  "amount_due": 3.00,
  "status": "Paid",
  "created_at": 1712345678
}
POST /metered/purchase/data

Top-up data

Body Parameters
Name Type Required Description
network string required
residential residential-eco mobile datacenter
sub_id integer required Subscription ID to top up
amount integer required GB to add (1–1000)
pay_with_credit boolean optional 
curl -X POST https://api.proxiware.com/v1/metered/purchase/data \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"network":"residential","sub_id":200,"amount":10,"pay_with_credit":true}'
import requests

r = requests.request(
    "POST",
    "https://api.proxiware.com/v1/metered/purchase/data",
    headers={"API-KEY": "your_api_key_here"}, json={"network":"residential","sub_id":200,"amount":10,"pay_with_credit":true}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/purchase/data", {
  method: "POST",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"network":"residential","sub_id":200,"amount":10,"pay_with_credit":true})
});
console.log(await res.json());
Response 200 
{
  "id": 5011,
  "description": "Residential Starter 10 GB Additional Data",
  "amount_due": 30.00,
  "status": "Paid",
  "created_at": 1712345678
}
GET /metered/networks/{network}/analytics/usage-timeseries

Usage timeseries

Path Parameters
Name Type Required Description
network string required
Query Parameters
Name Type Required Description
from integer optional Start Unix timestamp
to integer optional End Unix timestamp 
curl https://api.proxiware.com/v1/metered/networks/residential/analytics/usage-timeseries?from=1712000000&to=1712086400 \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/metered/networks/residential/analytics/usage-timeseries?from=1712000000&to=1712086400",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/analytics/usage-timeseries?from=1712000000&to=1712086400", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{"points":[{"ts":1712000000,"bytes":52428800}]}
GET /metered/networks/{network}/analytics/hosts

Top hosts

Path Parameters
Name Type Required Description
network string required 
curl https://api.proxiware.com/v1/metered/networks/residential/analytics/hosts \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/metered/networks/residential/analytics/hosts",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/analytics/hosts", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{"hosts":[{"host":"example.com","bytes":10485760}]}

Sub-Users

GET /metered/networks/{network}/subscriptions/{id}/users

List sub-users

Path Parameters
Name Type Required Description
network string required
residential residential-eco mobile datacenter
id integer required Subscription ID 
curl https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
[{"id":1,"name":"alice","sub_id":200,"network":"residential","status":"Active","bytes_used":5242880}]
POST /metered/networks/{network}/subscriptions/{id}/users

Create sub-user

Path Parameters
Name Type Required Description
network string required
id integer required Subscription ID
Body Parameters
Name Type Required Description
username string required 3–16 alphanumeric characters
bytes_quota integer optional Bandwidth quota in bytes (0 = unlimited)
locked boolean optional Start in locked state
auto_lock integer optional Unix timestamp to automatically lock at
binds array optional IP allowlist (IPv4 addresses)
ports array optional Array of {"range_index":0,"location":"US"} objects 
curl -X POST https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"username":"alice","bytes_quota":1073741824}'
import requests

r = requests.request(
    "POST",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users",
    headers={"API-KEY": "your_api_key_here"}, json={"username":"alice","bytes_quota":1073741824}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users", {
  method: "POST",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"username":"alice","bytes_quota":1073741824})
});
console.log(await res.json());
Response 200 
{"id":1,"name":"alice","password":"r4nd0mPass","sub_id":200,"network":"residential","status":"Active"}
PATCH /metered/networks/{network}/subscriptions/{id}/users/{user_id}

Update sub-user

Path Parameters
Name Type Required Description
network string required
id integer required Subscription ID
user_id integer required
Body Parameters
Name Type Required Description
bytes_quota integer optional
locked boolean optional
auto_lock integer optional Unix timestamp to auto-lock (UTC)
binds array optional Replace IP allowlist
ports array optional Replace port config: [{"range_index":0,"location":"US"}] 
curl -X PATCH https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1 \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"locked":true}'
import requests

r = requests.request(
    "PATCH",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1",
    headers={"API-KEY": "your_api_key_here"}, json={"locked":true}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1", {
  method: "PATCH",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"locked":true})
});
console.log(await res.json());
Response 200 
{"id":1,"name":"alice","status":"Locked"}
DELETE /metered/networks/{network}/subscriptions/{id}/users/{user_id}

Delete sub-user

Path Parameters
Name Type Required Description
network string required
id integer required Subscription ID
user_id integer required 
curl -X DELETE https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1 \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "DELETE",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1", {
  method: "DELETE",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
PUT /metered/networks/{network}/subscriptions/{id}/users/{user_id}/binds

Update IP allowlist

Path Parameters
Name Type Required Description
network string required
id integer required Subscription ID
user_id integer required
Body Parameters
Name Type Required Description
binds array required Array of IPv4 addresses 
curl -X PUT https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/binds \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"binds":["1.2.3.4"]}'
import requests

r = requests.request(
    "PUT",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/binds",
    headers={"API-KEY": "your_api_key_here"}, json={"binds":["1.2.3.4"]}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/binds", {
  method: "PUT",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"binds":["1.2.3.4"]})
});
console.log(await res.json());
PUT /metered/networks/{network}/subscriptions/{id}/users/{user_id}/ports

Update port config

Path Parameters
Name Type Required Description
network string required
id integer required Subscription ID
user_id integer required
Body Parameters
Name Type Required Description
ports array required Array of {"location":"US","range_index":0} objects 
curl -X PUT https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/ports \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"ports":[{"location":"US","range_index":0}]}'
import requests

r = requests.request(
    "PUT",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/ports",
    headers={"API-KEY": "your_api_key_here"}, json={"ports":[{"location":"US","range_index":0}]}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/ports", {
  method: "PUT",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"ports":[{"location":"US","range_index":0}]})
});
console.log(await res.json());
DELETE /metered/networks/{network}/subscriptions/{id}/users/{user_id}/usage

Reset usage counter

Path Parameters
Name Type Required Description
network string required
id integer required Subscription ID
user_id integer required 
curl -X DELETE https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/usage \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "DELETE",
    "https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/usage",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/metered/networks/residential/subscriptions/200/users/1/usage", {
  method: "DELETE",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());

Static Proxies

GET /static/networks/{network}

Get network info

Path Parameters
Name Type Required Description
network string required
isp 
curl https://api.proxiware.com/v1/static/networks/isp \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/static/networks/isp",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/static/networks/isp", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{"name":"isp","alias":"ISP","enabled":true}
GET /static/networks/{network}/stock

Check stock

Path Parameters
Name Type Required Description
network string required 
curl https://api.proxiware.com/v1/static/networks/isp/stock \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/static/networks/isp/stock",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/static/networks/isp/stock", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{"us":{"shared":120,"private":45,"dedicated":10}}
POST /static/purchase

Purchase static proxies

Body Parameters
Name Type Required Description
network string required
isp
location string required e.g. `us`, `uk`
exclusivity string required
shared private dedicated
duration integer required
30 60 90
quantity integer required 1–1000 (minimum 2 for shared/private)
pay_with_credit boolean optional Pay immediately from wallet balance 
curl -X POST https://api.proxiware.com/v1/static/purchase \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"network":"isp","location":"us","exclusivity":"shared","duration":30,"quantity":2,"pay_with_credit":true}'
import requests

r = requests.request(
    "POST",
    "https://api.proxiware.com/v1/static/purchase",
    headers={"API-KEY": "your_api_key_here"}, json={"network":"isp","location":"us","exclusivity":"shared","duration":30,"quantity":2,"pay_with_credit":true}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/static/purchase", {
  method: "POST",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"network":"isp","location":"us","exclusivity":"shared","duration":30,"quantity":2,"pay_with_credit":true})
});
console.log(await res.json());
Response 200 
{
  "id": 5020,
  "description": "ISP Proxies [Shared] (us)",
  "amount_due": 20.00,
  "status": "Paid",
  "created_at": 1712345678
}
GET /static/networks/{network}/subscriptions

List subscriptions

Path Parameters
Name Type Required Description
network string required
Query Parameters
Name Type Required Description
active boolean optional Filter by active status
limit integer optional Max results (1–100, default 10)
offset integer optional Pagination offset
search string optional Search by IP, location, or note 
curl https://api.proxiware.com/v1/static/networks/isp/subscriptions \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/static/networks/isp/subscriptions",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/static/networks/isp/subscriptions", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
[{"id":300,"network":"isp","location":"us","exclusivity":"shared","quantity":2,"billing_cycle_end_date":1714937678,"active":true,"auto_renewal":false}]
GET /static/subscriptions/{id}/proxies

Get proxy list

Path Parameters
Name Type Required Description
id integer required Subscription ID 
curl https://api.proxiware.com/v1/static/subscriptions/300/proxies \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/static/subscriptions/300/proxies",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/static/subscriptions/300/proxies", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
["1.2.3.4:1337:1337:myuser:mypassword","5.6.7.8:1337:1337:myuser:mypassword"]
PUT /static/subscriptions/{id}

Update subscription

Path Parameters
Name Type Required Description
id integer required
Body Parameters
Name Type Required Description
auto_renewal boolean optional Enable or disable auto-renewal
note string optional Label for this subscription (max 32 chars) 
curl -X PUT https://api.proxiware.com/v1/static/subscriptions/300 \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"auto_renewal":false}'
import requests

r = requests.request(
    "PUT",
    "https://api.proxiware.com/v1/static/subscriptions/300",
    headers={"API-KEY": "your_api_key_here"}, json={"auto_renewal":false}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/static/subscriptions/300", {
  method: "PUT",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"auto_renewal":false})
});
console.log(await res.json());
GET /static/networks/{network}/analytics/usage-timeseries

Usage timeseries

Path Parameters
Name Type Required Description
network string required
Query Parameters
Name Type Required Description
from integer optional
to integer optional 
curl https://api.proxiware.com/v1/static/networks/isp/analytics/usage-timeseries \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/static/networks/isp/analytics/usage-timeseries",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/static/networks/isp/analytics/usage-timeseries", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{"points":[{"ts":1712000000,"bytes":10485760}]}

Unlimited Residential

GET /unlimited/plans

List plans

curl https://api.proxiware.com/v1/unlimited/plans \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/unlimited/plans",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/unlimited/plans", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
[
  {"id":1,"name":"10 Mbps — 30 Days","speed":10,"duration":30,"price":29.99,"fulfillment_mode":"routed"},
  {"id":2,"name":"200 Mbps — 30 Days","speed":200,"duration":30,"price":499.00,"fulfillment_mode":"direct","discount_percent":10}
]
POST /unlimited/purchase

Purchase a plan

Body Parameters
Name Type Required Description
plan_id integer required ID of the plan from GET /unlimited/plans
pay_with_credit boolean optional Pay immediately from wallet balance 
curl -X POST https://api.proxiware.com/v1/unlimited/purchase \
  -H "API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"plan_id":1,"pay_with_credit":true}'
import requests

r = requests.request(
    "POST",
    "https://api.proxiware.com/v1/unlimited/purchase",
    headers={"API-KEY": "your_api_key_here"}, json={"plan_id":1,"pay_with_credit":true}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/unlimited/purchase", {
  method: "POST",\n  headers: { "API-KEY": "your_api_key_here", "Content-Type": "application/json" },\n  body: JSON.stringify({"plan_id":1,"pay_with_credit":true})
});
console.log(await res.json());
Response 200 
{
  "id": 5030,
  "description": "10 Mbps Unlimited Residential Proxy Plan (30 days)",
  "amount_due": 29.99,
  "status": "Paid",
  "created_at": 1712345678
}
GET /unlimited/subscriptions

List active subscriptions

curl https://api.proxiware.com/v1/unlimited/subscriptions \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/unlimited/subscriptions",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/unlimited/subscriptions", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
[
  {
    "id": 42,
    "host": "proxy.example.com",
    "http_port": 1337,
    "socks_port": 1337,
    "username": "abc123xyz456",
    "password": "your_proxy_password",
    "sticky_key": "sid",
    "mbps": 10,
    "mode": "routed",
    "auto_renewal": false,
    "billing_amount": 29.99,
    "expires_at": 1751328000
  }
]
GET /unlimited/subscriptions/{id}

Get subscription

Path Parameters
Name Type Required Description
id integer required Subscription ID 
curl https://api.proxiware.com/v1/unlimited/subscriptions/42 \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/unlimited/subscriptions/42",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/unlimited/subscriptions/42", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{
  "id": 42,
  "host": "proxy.example.com",
  "http_port": 1337,
  "socks_port": 1337,
  "username": "abc123xyz456",
  "password": "your_proxy_password",
  "sticky_key": "sid",
  "mbps": 10,
  "mode": "routed",
  "auto_renewal": false,
  "billing_amount": 29.99,
  "expires_at": 1751328000
}
GET /unlimited/subscriptions/{id}/metrics

Usage metrics

Path Parameters
Name Type Required Description
id integer required Subscription ID 
curl https://api.proxiware.com/v1/unlimited/subscriptions/42/metrics \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "GET",
    "https://api.proxiware.com/v1/unlimited/subscriptions/42/metrics",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/unlimited/subscriptions/42/metrics", {
  method: "GET",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
Response 200 
{}
PATCH /unlimited/subscriptions/{id}/auto-renewal

Toggle auto-renewal

Path Parameters
Name Type Required Description
id integer required Subscription ID 
curl -X PATCH https://api.proxiware.com/v1/unlimited/subscriptions/42/auto-renewal \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "PATCH",
    "https://api.proxiware.com/v1/unlimited/subscriptions/42/auto-renewal",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/unlimited/subscriptions/42/auto-renewal", {
  method: "PATCH",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());
DELETE /unlimited/subscriptions/{id}

Cancel subscription

Path Parameters
Name Type Required Description
id integer required Subscription ID 
curl -X DELETE https://api.proxiware.com/v1/unlimited/subscriptions/42 \
  -H "API-KEY: your_api_key_here"
import requests

r = requests.request(
    "DELETE",
    "https://api.proxiware.com/v1/unlimited/subscriptions/42",
    headers={"API-KEY": "your_api_key_here"}
)
print(r.json())
const res = await fetch("https://api.proxiware.com/v1/unlimited/subscriptions/42", {
  method: "DELETE",\n  headers: { "API-KEY": "your_api_key_here" }
});
console.log(await res.json());