Packages

List and inspect your active proxy packages via the RaxyProxy REST API.

GET /packages

Returns all your active and suspended proxy packages.

GET/api/v1/packages

packages-list.json

{
  "data": [
    {
      "id":           12,
      "name":         "Residential 10 GB",
      "type":         "residential",
      "status":       "active",
      "pool_type":    "residential",
      "quota_gb":     10.0,
      "used_gb":      3.2140,
      "available_gb": 6.7860,
      "usage_pct":    32.14,
      "blocked":      false,
      "synced_at":    "2026-05-29T11:00:00+00:00",
      "created_at":   "2026-04-01T11:59:00+00:00",
      "activated_at": "2026-04-01T12:00:00+00:00",
      "proxy": {
        "host":              "proxy.raxyproxy.com",
        "http_port":         823,
        "socks5_port":       824,
        "login":             "abc123def456",
        "threads":           100,
        "sticky_port_start": 10000,
        "sticky_port_end":   20000,
        "sticky_range":      { "start": 10000, "end": 20000 }
      }
    }
  ],
  "meta": { "version": "v1" }
}

GET /packages/:id

Returns a single package. When provisioned, the response includes an additional settings block with IP allowlists, supported protocols, and default geo params.

GET/api/v1/packages/{id}

package-show.json

{
  "data": {
    "id":           12,
    "name":         "Residential 10 GB",
    "type":         "residential",
    "status":       "active",
    "pool_type":    "residential",
    "quota_gb":     10.0,
    "used_gb":      3.2140,
    "available_gb": 6.7860,
    "usage_pct":    32.14,
    "blocked":      false,
    "synced_at":    "2026-05-29T11:00:00+00:00",
    "created_at":   "2026-04-01T11:59:00+00:00",
    "activated_at": "2026-04-01T12:00:00+00:00",
    "proxy": {
      "host":              "proxy.raxyproxy.com",
      "http_port":         823,
      "socks5_port":       824,
      "login":             "abc123def456",
      "password":          "6f487b213b4cb4ae",
      "threads":           100,
      "sticky_port_start": 10000,
      "sticky_port_end":   20000,
      "sticky_range":      { "start": 10000, "end": 20000 }
    },
    "settings": {
      "allowed_ips":         [],
      "supported_protocols": ["http", "socks5"],
      "blocked_hosts":       [],
      "default_geo": {
        "countries":         [],
        "states":            [],
        "cities":            [],
        "zipcodes":          [],
        "asns":              [],
        "exclude_countries": [],
        "exclude_asn":       [],
        "anonymous_filter":  false,
        "rotation_interval": null
      }
    }
  },
  "meta": { "version": "v1" }
}

Response fields

Field	Type	Description
`id`	integer	Package ID — used in other API calls
`name`	string	Human-readable product name
`type`	string	`residential` \| `residential_premium` \| `mobile` \| `datacenter`
`status`	string	`active` \| `suspended`
`pool_type`	string	Internal pool identifier (residential, residential_premium, mobile, datacenter)
`quota_gb`	float	Total purchased traffic in GB
`used_gb`	float	Traffic consumed so far
`available_gb`	float	Remaining traffic
`usage_pct`	float	Percentage used (0–100)
`blocked`	boolean	true when the package is administratively blocked
`synced_at`	ISO 8601 \| null	Last time usage counters were synced from the provider (≤30 min staleness)
`created_at`	ISO 8601	When the package row was created
`activated_at`	ISO 8601 string	When the package was first activated
`proxy.host`	string	Proxy hostname
`proxy.http_port`	integer	HTTP/HTTPS proxy port (823)
`proxy.socks5_port`	integer	SOCKS5 port (824)
`proxy.login`	string	Proxy username (base, without geo modifiers)
`proxy.password`	string (show only)	Plain proxy password — returned ONLY by GET /packages/{id} (the detailed show endpoint). Keep secret.
`proxy.threads`	integer	Max concurrent connections
`proxy.sticky_port_start`	integer	First sticky session port
`proxy.sticky_port_end`	integer	Last sticky session port
`proxy.sticky_range`	object	Sticky session port range, mirrored for SDKs that prefer an object
`settings.allowed_ips`	array	IP allowlist (empty = any IP allowed)
`settings.supported_protocols`	array	Enabled protocols for this package
`settings.blocked_hosts`	array	Domains the package is forbidden from reaching (full list)
`settings.default_geo`	object	Default geo filter (object with countries/states/cities/zipcodes/asns + exclude_countries/exclude_asn + anonymous_filter + rotation_interval).

Code examples

packages.sh

# List all packages
curl https://raxyproxy.com/api/v1/packages \
     -H "Authorization: Bearer raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# Get a single package
curl https://raxyproxy.com/api/v1/packages/12 \
     -H "Authorization: Bearer raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

packages.py

import requests

API_KEY = 'raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
HEADERS = {'Authorization': f'Bearer {API_KEY}'}

# List packages
pkgs = requests.get('https://raxyproxy.com/api/v1/packages', headers=HEADERS).json()

for p in pkgs['data']:
    pct = p['usage_pct']
    print(f"[{p['id']}] {p['name']}  {p['used_gb']}/{p['quota_gb']} GB ({pct}%)")

packages.mjs

const API_KEY = 'raxy_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
const headers = { Authorization: `Bearer ${API_KEY}` };

const res  = await fetch('https://raxyproxy.com/api/v1/packages', { headers });
const json = await res.json();

for (const p of json.data) {
    const { id, name, used_gb, quota_gb, usage_pct } = p;
    console.log(`[${id}] ${name}  ${used_gb}/${quota_gb} GB (${usage_pct}%)`);
}

← Previous

Account

Package Stats