API Documentation

Introduction

The VaultProxies Reseller API gives you programmatic control over the same proxy infrastructure exposed in the dashboard. Read your balance, list the catalog, place orders, pull live credentials for every service you have provisioned and generate ready-to-use proxy lines with geo targeting and sticky sessions. The surface is intentionally tiny: six endpoints, one header, JSON over HTTPS.

No SDKs, no proprietary client to install. Drop a curl command into your stack and you are running. If you prefer Python or Node, examples are inline on every endpoint below.

Authentication

Every request must include your API key in the X-API-Key header. For POST /api/reseller/order also send Content-Type: application/json. Keys are issued from the reseller dashboard after your account is approved.

curl -H "X-API-Key: YOUR_API_KEY" \
  https://vaultproxies.net/api/reseller/balance

Base URL

All endpoints below are relative to:

https://vaultproxies.net

Reseller pricing

Every order placed with a reseller API key is billed at the reseller rate, not the public retail rate, so there is nothing to enable. Your reseller loyalty discount, if any, applies on top at checkout. The table below is live, read from GET /api/reseller/pricing, so it always matches what you are charged. From code, call GET /api/reseller/categories with your key: its price_per_unit_cents is your rate.

Want the full retail price book in one page? See /pricing.

Get balance

Returns your current account balance in cents. Divide by 100 for the dollar amount. The same value is shown on the reseller dashboard wallet card.

curl -X GET \
  -H "X-API-Key: YOUR_API_KEY" \
  "https://vaultproxies.net/api/reseller/balance"

Response

{
  "balance_cents": 15000
}

List categories

Returns every plan you can order, priced for your key. price_per_unit_cents is the reseller rate you are billed at, not retail; retail_price_per_unit_cents is our public price for the same unit, so the difference is your margin. volume_tiers is null whenever your rate is flat. Pass a key as category_key when ordering. Cache the response on your side, the catalog moves slowly.

curl -X GET \
  -H "X-API-Key: YOUR_API_KEY" \
  "https://vaultproxies.net/api/reseller/categories"

Response

{
  "categories": [
    {
      "id": 1,
      "key": "resi_pergb",
      "display_name": "Residential /GB",
      "pricing_type": "pergb",
      "unit": "GB",
      "price_per_unit_cents": 50,
      "retail_price_per_unit_cents": 100,
      "min_units": 1,
      "max_units": 5000,
      "unit_block_hours": 0,
      "hidden": false,
      "volume_tiers": null
    },
    {
      "id": 3,
      "key": "dc_unlim",
      "display_name": "Datacenter Unlimited",
      "pricing_type": "unlim",
      "unit": "DAY",
      "price_per_unit_cents": 250,
      "retail_price_per_unit_cents": 500,
      "min_units": 1,
      "max_units": 61,
      "unit_block_hours": 24,
      "hidden": false,
      "volume_tiers": null
    }
  ]
}

Create order

Provisions a new proxy service against your balance. Specify the plan with category_key, the quantity with units, and for unlimited plans the billing window with time_unit. The response includes the freshly minted credentials and the matching invoice.

curl -X POST \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_key": "resi_pergb", "units": 5}' \
  "https://vaultproxies.net/api/reseller/order"

Request body

{
  "category_key": "resi_pergb",
  "units": 5,
  "time_unit": "day"
}

category_key accepts resi_pergb, resi_unlim, dc_unlim, dc_pergb, mobile_pergb and dedicated_isp.

Dedicated ISP orders

dedicated_isp takes two extra fields. pool is required, stock is finite per pool and is validated before you are charged, so an order without it is rejected with a 400. Fetch the pools and their live stock from GET /api/reseller/proxy/isp-pools first, with your X-API-Key.

{
  "category_key": "dedicated_isp",
  "units": 1,
  "pool": "ISP_US_SNEAKERS",   // required, see GET /api/reseller/proxy/isp-pools
  "term_days": 30              // optional: 30, 60 or 90 (default 30)
}

The term is fixed at purchase. Dedicated ISP has no renewal path, so extending an existing plan is rejected, order a fresh one instead. units is the number of exclusive IPs, and each is delivered with its own credential rather than one pair for the plan.

Pools available for dedicated_isp, with live stock. Only pools that can be fulfilled right now are returned, so any pool value from here is safe to order against - subject to stock covering your units.

{
  "pools": [
    {
      "pool": "ISP_US_SNEAKERS",
      "title": "US Sneaker Proxies (ISP)",
      "stock": 6279,
      "in_stock": true,
      "is_subnet": false
    }
  ]
}

Response

{
  "service": {
    "id": 123,
    "user_id": 1,
    "category_id": 1,
    "status": "active",
    "pricing_type": "pergb",
    "unit": "GB",
    "remaining_gb": 5,
    "username": "abc123xyz",
    "password": "secretpass123",
    "created_at": "2026-05-05T12:00:00Z"
  },
  "invoice": {
    "id": 456,
    "amount_cents": 425,
    "status": "paid"
  }
}

List services

Returns every active service on your account along with its live credentials, status and remaining bandwidth. Use this to hand fresh credentials to your downstream customers, or to poll for top-up triggers.

curl -X GET \
  -H "X-API-Key: YOUR_API_KEY" \
  "https://vaultproxies.net/api/reseller/services"

Response

{
  "services": [
    {
      "id": 123,
      "username": "abc123xyz",
      "password": "secretpass123",
      "remaining_gb": 4.5,
      "status": "active",
      "expires_at": "2026-07-06T12:00:00Z"
    }
  ]
}

Generator locations

Lists what you can geo-target for a plan. Pass the plan with plan_key (defaults to resi_unlim); add country to narrow to one country. What comes back depends on the plan:

• resi_pergb: every country, and with country=US the US states. Cities are not listed: this pool rejects a city name, so target a city with extra.geoname_id (e.g. 5368361 for Los Angeles). Other countries' states still work as ISO 3166-2 codes in state.
• pool4_pergb: countries, US states and their cities.
• mobile_pergb, shared_isp, eu_isp, dc_pergb and resi_unlim_budget: countries only.
• ipv6_pergb: an empty list, it has no geo targeting.

curl -X GET \
  -H "X-API-Key: YOUR_API_KEY" \
  "https://vaultproxies.net/api/reseller/proxy/generator/locations?plan_key=resi_pergb&country=US"

Response

{
  "countries": [
    {
      "code": "US",
      "name": "United States",
      "states": [
        { "code": "CA", "name": "California" },
        { "code": "NY", "name": "New York" }
      ]
    }
  ]
}

Generate proxies

Turns one of your active services into ready-to-use proxy lines. Supports rotating and sticky sessions, geo targeting (where the plan allows it), HTTP and SOCKS5, and several output formats. The response always carries the exact hostname and port to connect to, so you never have to hardcode gateways.

curl -X POST \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "service_id": 123,
    "plan_key": "resi_pergb",
    "country": "US",
    "protocol": "HTTP",
    "format": "user:pass@ip:port",
    "extra": { "mode": "sticky", "count": 5, "session_seconds": 600 }
  }' \
  "https://vaultproxies.net/api/reseller/proxy/generations/create"

Response

{
  "generations": [
    {
      "id": 1751712000000000000,
      "user_id": 1,
      "service_id": 123,
      "plan_key": "resi_pergb",
      "country": "us",
      "protocol": "HTTP",
      "format": "user:pass@ip:port",
      "hostname": "gate-eu.vaultproxies.com",
      "port": 80,
      "username": "abc123xyz-geo-us-sess-k2j9x1pq-life-600",
      "password": "secretpass123",
      "output_line": "abc123xyz-geo-us-sess-k2j9x1pq-life-600:[email protected]:80",
      "created_at": "2026-07-05T12:00:00Z"
    }
  ],
  "generation": { "...": "first entry of generations, same shape" }
}

Request parameters

Per-plan hosts, ports & capabilities

Every plan runs its own gateway. HTTP and SOCKS5 may sit on different ports; geo targeting and sticky-session limits also vary. The generate response always returns the correct hostname and port, so treat this table as a reference rather than something to hardcode.

Hostnames are always ours. To give your customers your own domain, point a CNAME at the plan host (or an A record at its IP) and substitute it in the lines you hand out, or run your own gateway in front and forward with the credential. Authentication is by username and password alone, so any of these works with no setup on our side.

Targeting tokens

Targeting rides inside the proxy username as -key-value pairs appended to the base username. The generator builds these for you when you pass country, state and city - this reference is for hand-built credentials and for anything you expose to your own customers.

ca3ddbbd85591e7f-geo-us-st-california-sess-drfse9co-life-21600

A plan only honours the tokens its pool can actually act on. Sending one it does not support is an error, not a silent downgrade, so you never end up somewhere you did not ask for.

GET /api/plans/catalog is public and returns the same per-plan targeting list, alongside each plan’s gateway host and ports, read it from your code rather than hard-coding this table.

Order parameters

Error responses

Errors are returned as JSON with an error field and the matching HTTP status code. The most common cases are missing parameters (400), invalid keys (401), insufficient balance (402), suspended accounts (403) and rate-limit hits (429).

{
  "error": "insufficient balance"
}

Rate limits

The default rate limit is 120 requests per second per API key (7,200 / min) , generous enough for production scrapers, schedulers, and CI jobs without us getting in your way. Each response carries the standard rate-limit headers:

• X-RateLimit-Limit: max requests per window
• X-RateLimit-Remaining: remaining requests in this window
• X-RateLimit-Reset: seconds until the window resets

If you genuinely need uncapped throughput for production scale, message us on /support and we will raise it on your account. Live network status is at /status.

Quick start

Complete workflow: check balance, browse the catalog, place an order, read back the credentials, then generate proxy lines.

# 1. Check your balance
curl -H "X-API-Key: YOUR_API_KEY" "https://vaultproxies.net/api/reseller/balance"

# 2. View available plans
curl -H "X-API-Key: YOUR_API_KEY" "https://vaultproxies.net/api/reseller/categories"

# 3. Order 5 GB residential
curl -X POST \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category_key": "resi_pergb", "units": 5}' \
  "https://vaultproxies.net/api/reseller/order"

# 4. List all your services with live credentials
curl -H "X-API-Key: YOUR_API_KEY" "https://vaultproxies.net/api/reseller/services"

# 5. Generate 5 US rotating proxy lines from the new service
curl -X POST \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service_id": 123, "plan_key": "resi_pergb", "country": "US", "extra": {"count": 5}}' \
  "https://vaultproxies.net/api/reseller/proxy/generations/create"