Skip to content
P
ProxyRequest
/ DOCS
Search
Ctrl
K
Cancel
Website
API
Book a Demo
Start here
Platform overview
Quick start
Proxy connectivity
Credentials and authentication
Targeting
Sticky sessions
Protocols
Usage and data accounting
Platform integration
Integration overview
API fundamentals
Reseller workflow
Users and data lifecycle
Catalog and proxy generation
Analytics
Webhooks
Reference and help
Webhook events
Common errors
API Reference
Overview
Authorization
Overview
Sign in with email or username
POST
Sign in with Google
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 sub-user
POST
Get a user
GET
Delete a user
DELETE
Update a user
PATCH
Add data to a sub-user order
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 setup
POST
Disable two-factor authentication
POST
Start two-factor setup
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
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
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
Sessions
Overview
List active proxy sessions
GET
Revoke a proxy session
DELETE
Settings
Overview
Get account settings
GET
News
Overview
List product announcements
GET
Download OpenAPI YAML
Website
API
Book a Demo
Overview
Settings
Section titled “Settings”
Read gateway addresses, usage totals, and account-wide configuration.
Operations
Section titled “Operations”
GET
/settings