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 | Legacy management operations, currently unavailable (403) | Do not use for device logout or proxy-session revocation; sticky generation remains supported |
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.
Telegram dashboard integration
Section titled “Telegram dashboard integration”| Resource | What it covers | Typical integration use |
|---|---|---|
| Telegram dashboard | Inspect, update, and disconnect the current account’s Telegram connection, or create a short-lived account link | Let an authenticated customer connect Telegram and control dashboard notification preferences |
The public contract covers authenticated account-side management. The official Telegram bot completes account links through trusted runtime endpoints that are intentionally outside the customer OpenAPI contract.
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 |
| Providers | Superuser-only provider balances, calculation status, and recent observation history | Monitor upstream data availability from a trusted backend |
| 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.
For upstream capacity monitoring, see provider data balances. This endpoint requires a superuser JWT or an API key owned by an active superuser.
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.
Every operation, with a workflow
Section titled “Every operation, with a workflow”This inventory is checked against OpenAPI during documentation validation. A new public operation must be assigned a guide; unavailable operations remain visible with their limitation.
83 operations mapped to practical guides. Expand a task to see permissions, prerequisites, outcomes and the exact reference.
Provider data balances (1)
Who: Superuser
Before you call: Superuser JWT or an API key owned by an active superuser.
Result: One row per observed provider with exact byte strings, cached calculation status, and recent checkpoint history.
- GET /providers/data-balances — List provider data balances
Sign in and recover access (6)
Who: Account owner
Before you call: Registration/provider enabled where applicable; valid credentials and MFA proof.
Result: Account creation, token pair, MFA challenge, refresh or recovery result; never proxy credentials.
- POST /signup — Create a customer account
- POST /login — Sign in with email or username
- POST /login/google — Sign in with Google
- POST /login/otp — Complete two-factor sign-in
- POST /refresh — Refresh an access token
- POST /recover-password — Send a password recovery email
Profile and MFA (8)
Who: Authenticated account owner
Before you call: Current account scope; password or other documented proof for security changes.
Result: Read/edit profile, manage MFA or change the login password. Account deletion is destructive, not logout.
- GET /profile — Get the current profile
- PATCH /profile — Update the current profile
- DELETE /profile — Delete the current account
- POST /profile/change-password — Change the account password
- POST /profile/2fa/setup — Prepare two-factor authentication
- POST /profile/2fa/confirm — Confirm two-factor authentication
- POST /profile/2fa/disable — Disable two-factor authentication
- GET /profile/2fa/status — Get two-factor status
API-key inventory and rotation (3)
Who: Authenticated account owner
Before you call: Secure backend storage and permitted source IPs.
Result: Create and save a secret, inspect key metadata, or revoke an old key.
- GET /api-keys — List API keys
- POST /api-keys — Create an API key
- DELETE /api-keys/{id} — Revoke an API key
Telegram and deployment information (6)
Who: Authenticated account owner
Before you call: Configured Telegram integration for linking; authenticated deployment context.
Result: Manage connection/preferences, obtain a short-lived bot link, or display settings and announcements.
- GET /integrations/telegram/connection — Get the Telegram dashboard connection
- PATCH /integrations/telegram/connection — Update Telegram dashboard preferences
- DELETE /integrations/telegram/connection — Disconnect the Telegram dashboard
- POST /integrations/telegram/link — Create a Telegram account link
- GET /settings — Get account settings
- GET /news — List product announcements
Managed customer lifecycle (7)
Who: Parent reseller; superuser for independent accounts and privileged fields
Before you call: Owned customer IDs; top-level creation requires a superuser. Read each customer’s orders for package-specific data and credentials.
Result: Create identity, read/edit customer state, rotate package credentials, inspect orders or delete deliberately.
- GET /users — List users in the current account
- POST /users — Create a customer account
- GET /users/{id} — Get a user
- PATCH /users/{id} — Update a user
- DELETE /users/{id} — Delete a user
- GET /users/{id}/orders — List a sub-user's orders
- POST /users/{id}/password — Rotate a sub-user proxy password
Shared-pool quotas (2)
Who: Owning parent reseller
Before you call: Existing parent root order, managed child and package_id plus positive byte delta.
Result: Increase or reduce a virtual quota; no reservation, purchase or refund of the parent pool.
- POST /users/{id}/data/add — Add data to a sub-user order
- POST /users/{id}/data/subtract — Subtract data from a sub-user order
Reset remaining traffic (1)
Who: System administrator or direct parent
Before you call: Existing finite-package order and package_id; no byte amount.
Result: Atomically clear remaining purchased data or a child quota while preserving usage history.
- POST /users/{id}/data/reset — Reset a user's remaining data
Read purchased and assigned access (2)
Who: Order owner; superuser for broader inspection
Before you call: Matching user/package order in the permitted scope.
Result: Current package access and usable balances; root and virtual-child fields have different meanings.
- GET /orders — List active orders
- GET /orders/{id} — Get an order
Order settings and lifecycle (3)
Who: Permitted order owner or managing account, depending on operation
Before you call: Visible order; deletion scope and password-reset cooldown apply. PATCH accepts renewal settings only.
Result: Save renewal settings, rotate a proxy password, or delete an order; deletion is not a guaranteed refund.
- PATCH /orders/{id} — Update order auto-renewal
- DELETE /orders/{id} — Delete a sub-user order
- POST /reset-password — Reset an order's proxy password
Catalog and generated proxies (3)
Who: Authenticated account; permitted customer context for user_id
Before you call: Configured package; generation also needs eligible access and compatible targeting.
Result: Product/commission information and proxy credentials to verify with a real gateway request.
- GET /packages — List available proxy packages
- GET /packages/commissions — List affiliate package commissions
- POST /proxies/generate — Generate proxy credentials
Location and network choices (10)
Who: Authenticated account
Before you call: Package context and parent geography required by each filter.
Result: Canonical targeting choices/details, not a guarantee of live inventory for every intersection.
- GET /locations/asn — List available autonomous systems
- GET /locations/cities — List available cities
- GET /locations/cities/{id} — Get a city
- GET /locations/continents — List available continents
- GET /locations/continents/{id} — Get a continent
- GET /locations/countries — List available countries
- GET /locations/countries/{id} — Get a country
- GET /locations/isps — List available internet service providers
- GET /locations/regions — List available regions
- GET /locations/regions/{id} — Get a region
Purchase, checkout and invoice history (6)
Who: Account buyer or permitted reseller; only superusers may create status=paid
Before you call: Configured product/gateway, valid pricing and recipient. Invoice user_id additionally requires is_reseller.
Result: Purchase or wallet top-up, payment link, invoice/PDF. Confirm paid state and resulting access separately.
- GET /invoices — List invoices
- POST /invoices — Create an invoice
- GET /invoices/{id} — Get an invoice
- DELETE /invoices/{id} — Delete an invoice
- GET /invoices/{id}/download/pdf — Download an invoice PDF
- GET /invoices/{id}/pay — Get an invoice payment link
Coupon selection and price previews (4)
Who: Authenticated account within coupon visibility
Before you call: Eligible coupon/package/amount and permitted redemption scope.
Result: Visible offers, redemption records or a calculated preview; calculation does not create a purchase.
- GET /coupons — List available coupons
- GET /coupons/{id} — Get a coupon
- GET /coupons/{id}/redeems — List coupon redemptions
- POST /coupons/calculate-price — Calculate a discounted price
Coupon administration (4)
Who: Staff
Before you call: Valid campaign rules and conditional validator where used.
Result: Create, replace, partially update or remove a coupon. Ordinary reseller status is insufficient.
- POST /coupons — Create a coupon
- PUT /coupons/{id} — Replace a coupon
- PATCH /coupons/{id} — Update a coupon
- DELETE /coupons/{id} — Delete a coupon
Rewards and affiliates (5)
Who: Eligible authenticated account
Before you call: Claim thresholds/type or affiliate visibility; explicit reporting window where supported.
Result: Inspect/claim reward state and report attribution or earnings. Keep a separate commercial payout journal.
- GET /rewards — List account rewards
- POST /rewards/claim — Claim available rewards
- GET /affiliates — List referred customers
- GET /affiliates/rewards — List affiliate reward entries
- GET /affiliates/rewards/overall — Get affiliate earnings over time
Analytics and reconciliation (6)
Who: Account or permitted customer scope; not a global public report
Before you call: Supported per-endpoint filters, closed dates/timezone for reconciliation; transactions must be enabled.
Result: Usage totals, domains, requests, logs, connections or recorded transactions; not a complete purchase/expiry journal.
- GET /analytics/{id}/transactions — List data transactions
- GET /analytics/connections — List active proxy connections
- GET /analytics/domains — List top destination domains
- GET /analytics/feed — List proxy request activity
- GET /analytics/logs — List proxy error logs
- GET /analytics/overall — Get traffic totals over time
Accounting webhook destinations (4)
Who: Account with permission for the requested user/reseller/system scope
Before you call: Owned HTTPS receiver and secure signing-secret storage.
Result: Create/read/delete destination configuration; consume signed accounting snapshots, not invoice-paid events.
- GET /webhooks — List customer webhooks
- POST /webhooks — Create a customer webhook
- GET /webhooks/{id} — Get a customer webhook
- DELETE /webhooks/{id} — Delete a customer webhook
Unavailable session management (2)
Who: Unavailable, including for authenticated callers
Before you call: No supported integration path at present.
Result: 403: ownership cannot be verified. Sticky proxy generation is a separate supported feature.
- GET /sessions — Session listing temporarily unavailable
- DELETE /sessions/{id} — Session deletion temporarily unavailable