Skip to content
ProxyRequest
/ DOCS
Search
Ctrl
K
Cancel
Website
Blog
API
Book a Demo
Start Here
Platform overview
Platform quickstart
Gateway quickstart
Platform Integration
Choose your integration
Own billing quickstart
Reseller quickstart
API fundamentals
Install and use SDKs
Retries and concurrency
Accounts and security
Catalog and proxy generation
Analytics
Provider data balances
Webhooks
Webhook Events
Platform Errors
All API workflows
Purchases and Traffic
How the accounting model works
Users and shared quotas
Data buckets and expiration
Billing, coupons, and growth
Proxy Connectivity
Credentials and authentication
Targeting
Routing and failures
Sticky sessions
Protocols
Usage and data accounting
Proxy Errors
Admin Panel Guide
Admin overview and system map
Supply: locations
Supply: providers
Routing: pools and weights
Products: packages and pricing
Customers and accounting
Payment gateways
Automation and access
Analytics and operations
Proxy errors
Infrastructure and launch
Migration and rollout
White-label Dashboard
Dashboard overview
Branding and customization
Customer workflows
Reseller workflows
Account and security
Dashboard launch
SDK Reference
Overview
Client
API Keys
Affiliates
Analytics
Authorization
Coupons
Invoices
Locations
News
Orders
Packages
Profile
Providers
Proxies
Rewards
Settings
Telegram dashboard
Users
Webhooks
Models
Errors and helpers
API Reference
Overview
Authorization
Overview
Sign in with email or username
POST
Sign in with Google
POST
Complete two-factor sign-in
POST
Send a password recovery email
POST
Refresh an access token
POST
Create a customer account
POST
Users
Overview
List users in the current account
GET
Create a customer account
POST
Get a user
GET
Delete a user
DELETE
Update a user
PATCH
Add data to a sub-user order
POST
Reset a user's remaining data
POST
Subtract data from a sub-user order
POST
List a sub-user's orders
GET
Rotate a sub-user proxy password
POST
Profile
Overview
Get the current profile
GET
Delete the current account
DELETE
Update the current profile
PATCH
Confirm two-factor authentication
POST
Disable two-factor authentication
POST
Prepare two-factor authentication
POST
Get two-factor status
GET
Change the account password
POST
Orders
Overview
List active orders
GET
Get an order
GET
Delete a sub-user order
DELETE
Update order auto-renewal
PATCH
Reset an order's proxy password
POST
Proxies
Overview
Generate proxy credentials
POST
Analytics
Overview
List data transactions
GET
List active proxy connections
GET
List top destination domains
GET
List proxy request activity
GET
List proxy error logs
GET
Get traffic totals over time
GET
Invoices
Overview
List invoices
GET
Create an invoice
POST
Get an invoice
GET
Delete an invoice
DELETE
Download an invoice PDF
GET
Get an invoice payment link
GET
Coupons
Overview
List available coupons
GET
Create a coupon
POST
Get a coupon
GET
Replace a coupon
PUT
Delete a coupon
DELETE
Update a coupon
PATCH
List coupon redemptions
GET
Calculate a discounted price
POST
Rewards
Overview
List account rewards
GET
Claim available rewards
POST
Affiliates
Overview
List referred customers
GET
List affiliate reward entries
GET
Get affiliate earnings over time
GET
Packages
Overview
List available proxy packages
GET
List affiliate package commissions
GET
Providers
Overview
List provider data balances
GET
Locations
Overview
List available autonomous systems
GET
List available cities
GET
Get a city
GET
List available continents
GET
Get a continent
GET
List available countries
GET
Get a country
GET
List available internet service providers
GET
List available regions
GET
Get a region
GET
API Keys
Overview
List API keys
GET
Create an API key
POST
Revoke an API key
DELETE
Webhooks
Overview
List customer webhooks
GET
Create a customer webhook
POST
Get a customer webhook
GET
Delete a customer webhook
DELETE
Telegram dashboard
Overview
Get the Telegram dashboard connection
GET
Disconnect the Telegram dashboard
DELETE
Update Telegram dashboard preferences
PATCH
Create a Telegram account link
POST
Sessions
Overview
Session listing temporarily unavailable
GET
Session deletion temporarily unavailable
DELETE
Settings
Overview
Get account settings
GET
News
Overview
List product announcements
GET
Download OpenAPI YAML
Website
Blog
API
Book a Demo
Overview
Providers
Section titled “Providers”
Read provider data balances and observation history. Superuser credentials required.
Operations
Section titled “Operations”
GET
/providers/data-balances