Account and usage

These endpoints read your account. They cost nothing and do not count towards your request limits.

GET /v1/account

Your plan, credits and limits.

curl https://api.virginproxy.com/v1/account -H "Authorization: Bearer $VP_KEY"
{
  "id": "acc_nihdkFou8xPAE6EW",
  "plan": "free",
  "status": "active",
  "credits": { "included": 1000, "used": 10, "extra": 0, "remaining": 990 },
  "period_start": "2026-11-16T19:41:34.000Z",
  "period_end": null,
  "limits": {
    "concurrency": 1,
    "requests_per_second": 1,
    "max_response_bytes": 2097152,
    "timeout_ms": 30000,
    "priority": 4
  }
}

credits.extra are extra requests bought for the running period. period_end is the end of the paid 30 days, or null on the free plan.

priority runs from 1 (served first when the pool is busy) to 4.

GET /v1/usage

Totals per day (UTC) for the last days days: 30 by default, 90 at most. Days without requests are left out.

curl "https://api.virginproxy.com/v1/usage?days=7" -H "Authorization: Bearer $VP_KEY"
{
  "days": 7,
  "data": [
    {
      "day": "2026-11-16",
      "requests": 18,
      "successful": 16,
      "credits": 16,
      "bytes_down": 81133,
      "bytes_up": 34055
    }
  ]
}

GET /v1/requests/{id}

The record of one request, by the id from its response. Records contain what you need to check a bill; the URL's path, the headers and the body are never stored.

{
  "id": "req_CnyVUyRsqMNJtOOqdhE9",
  "created_at": "2026-11-16T19:42:06.075Z",
  "method": "GET",
  "target_host": "httpbin.org",
  "ok": true,
  "status": 404,
  "error": null,
  "exit": { "ip": "80.187.115.71", "carrier": "Telekom", "country": "DE" },
  "bytes": { "up": 1992, "down": 4192 },
  "duration_ms": 463,
  "cost": { "credits": 1 },
  "fresh_ip": false
}

For a failed request ok is false, status is null and error holds the error code.

GET /healthz

No key needed. Answers 200 while modems are available and 503 otherwise.

{ "ok": true, "modems_usable": 8 }