Settings
Returns the authenticated account’s gateway addresses, usage totals, referral thresholds, and supported crypto currencies. Use it as runtime deployment data rather than hard-coding those values in a client.
API resource map
The public API is organized around the resources below. Use this page to find the business capability you need, then open the generated API Reference for the exact request fields, permissions, and response schema.
Identity and access
Section titled “Identity and access”| Resource | What it covers | Typical integration use |
|---|---|---|
| Authorization | Sign-up, password login and recovery, Google login, and JWT refresh | Create an interactive customer session or renew an expiring access token |
| Profile | Current-account details, password changes, and two-factor authentication | Build account settings and security controls |
| API Keys | List, create, and revoke static keys | Authenticate a trusted backend without storing a user’s password |
| Sessions | List and revoke authenticated sessions | Let a customer review active access and sign out another device |
Use JWT bearer authentication for an interactive session. Use a static key for a trusted server-to-server integration. The complete header formats and security guidance are in API fundamentals.
Customers and service delivery
Section titled “Customers and service delivery”| Resource | What it covers | Typical integration use |
|---|---|---|
| Users | Reseller-managed sub-users, passwords, orders, and byte additions or subtractions | Provision a customer and enforce its allocated data limit |
| Orders | Purchased or assigned package access and credential reset | Display active access and rotate proxy credentials |
| Packages | Available products and commission information | Build a sellable catalog from the deployment’s current configuration |
| Locations | Continents, countries, regions, cities, ASNs, and ISPs | Populate targeting controls without hard-coding inventory |
| Proxies | Generate proxy access for a package and requested quantity | Return connection data after validating product and targeting choices |
Package, order, and location identifiers belong to the same deployment context. Keep explicit mappings in a headless integration and refresh dependent location choices when the package changes. See catalog, locations, and proxy generation and users and data lifecycle.
Usage and synchronization
Section titled “Usage and synchronization”| Resource | What it covers | Typical integration use |
|---|---|---|
| Analytics | Overall traffic, active connections, top domains, request feed, proxy logs, and data transactions | Build usage views, investigate incidents, and reconcile a closed reporting window |
| Webhooks | Register, inspect, and remove event destinations | Update a local projection when platform events are delivered |
Webhooks are a notification channel, not the sole source for billing totals. Deduplicate deliveries and reconcile with durable resource state and analytics. Start with analytics and reconciliation and webhooks.
Billing and growth
Section titled “Billing and growth”| Resource | What it covers | Typical integration use |
|---|---|---|
| Invoices | Create and list invoices, inspect status, obtain a payment link, and download a PDF | Run the built-in purchase and payment flow |
| Coupons | Validate discounts; administrative accounts can manage coupons and inspect redemptions | Preview a discounted price before creating an invoice |
| Rewards | List and claim eligible account rewards | Apply earned balance or data after eligibility checks |
| Affiliates | Referred customers, reward entries, and earnings over time | Build an affiliate dashboard for an eligible account |
These resources have account- and role-dependent visibility. Read billing, coupons, and growth before connecting them to checkout or a customer balance.
Deployment information
Section titled “Deployment information”The Settings and News resources keep a customer application aligned with deployment-specific values and announcements.
News
Returns customer-facing announcements and product updates ordered from newest to oldest. Treat it as optional presentation content, not a control signal for automated provisioning.
Integration ownership
Section titled “Integration ownership”Your application should remain authoritative for its own customer IDs, product SKUs, checkout state, and retry history. Store ProxyRequest IDs as mappings, preserve request context in your logs, and expose only the capabilities returned to the authenticated account.
Download the exact machine-readable contract from OpenAPI YAML or browse all operations in the API Reference.