# SOAX

- [What is SOAX](https://developers.soax.com/getting-started/what-is-soax.md): SOAX is web access infrastructure for products that depend on fresh public-web data. Start here for the category, the platform, and where to go next.
- [Quickstart](https://developers.soax.com/getting-started/quickstart.md): Go from signup to your first successful proxy request in under 5 minutes. Covers both the dashboard and terminal.
- [Core Concepts](https://developers.soax.com/getting-started/core-concepts.md): How SOAX's proxy system is built. Understand packages, sessions, rules, and bindings so you can get the most out of the platform.
- [Choosing the Right Proxy Type](https://developers.soax.com/getting-started/choosing-proxy-type.md): Understand the difference between residential and mobile proxies, when to use each, and how to configure them on your package.
- [Authentication](https://developers.soax.com/getting-started/authentication.md): How to authenticate with SOAX proxies using username/password or IP Auth. Includes connection string format, where to find credentials, and working examples.
- [Residential Proxies](https://developers.soax.com/proxies/residential.md): Full reference for SOAX residential proxies. Covers how routing works, session types, geo-targeting, connection parameters, and limits.
- [Mobile Proxies](https://developers.soax.com/proxies/mobile.md): Full reference for SOAX mobile proxies. Covers how mobile routing works, session types, geo-targeting, connection parameters, and limits.
- [Quick Connect](https://developers.soax.com/dashboard/quick-connect.md): Build SOAX connection strings without memorising the rules format. Quick Connect is the dashboard's connection-string builder for residential and mobile proxies.
- [Package Management](https://developers.soax.com/dashboard/package-management.md): Create, configure, and manage proxy packages from the dashboard. Packages are the unit of access and billing — credentials, limits, and entitlements all live on a package.
- [Usage Analytics](https://developers.soax.com/dashboard/usage-analytics.md): Monitor your proxy usage and traffic patterns and spot issues before they become problems.
- [Account & Billing](https://developers.soax.com/dashboard/account-billing.md): Manage your subscription, payment methods, and invoices — and understand how traffic and overages are calculated.
- [API overview](https://developers.soax.com/api/overview.md): Programmatic access to your SOAX account: packages, connection strings, locations, usage analytics, and API key management over a JSON REST API.
- [API quickstart](https://developers.soax.com/api/quickstart.md): Create an API key, verify it, list your packages, and generate a proxy connection string — with curl, Python, and Node.js examples.
- [API authentication](https://developers.soax.com/api/authentication.md): How to authenticate with the SOAX API using API keys: the Authorization header, scopes, package restrictions, and key lifecycle.
- [Error handling](https://developers.soax.com/api/errors.md): Every status code the SOAX API returns, the error response shapes, common error messages, and how to handle each one.
- [Rate limits](https://developers.soax.com/api/rate-limits.md): SOAX API rate limits: 5 requests/second per API key and 500 requests/minute per IP, how the 429 response looks, how to check remaining quota, and other usage constraints.
- [Get current API key](https://developers.soax.com/api/keys/me.md): Retrieve details about the API key used to authenticate the request: its scopes, package restriction, organization ID, and current rate-limit quota. Useful as a first call to verify a key works, and to check remaining rate-limit quota. This endpoint requires no scope — any active key can call it. Th…
- [List API keys](https://developers.soax.com/api/keys/list.md): Retrieve all API keys belonging to your organization, including revoked ones. Key secrets are never returned — only metadata. Requires the `api-keys:read` scope.
- [Create an API key](https://developers.soax.com/api/keys/create.md): Create a new API key. To prevent privilege escalation, the new key's `scopes` must be a subset of the calling key's scopes, and `package_ids` (if provided) must be a subset of the calling key's package restriction. If `package_ids` is omitted, the new key inherits the calling key's restriction.
- [Revoke an API key](https://developers.soax.com/api/keys/revoke.md): Revoke an API key belonging to your organization. Revocation is a soft delete: the key keeps appearing in `GET /v1/api-keys/` with status `revoked`, but any request using it is rejected with 401 from that point on. A key can revoke itself. Revocation cannot be undone — create a new key instead.
- [List packages](https://developers.soax.com/api/packages/list.md): Retrieve a paginated list of proxy packages accessible to the API key. If the key is restricted to specific packages, only those are returned. Use cursor-based pagination: pass the `next_cursor` value from one response as the `cursor` parameter of the next request until `has_more` is `false`. Traffi…
- [Get a package](https://developers.soax.com/api/packages/get.md): Retrieve full configuration for one proxy package: status, network types, tiers, traffic usage (in bytes), the package password used for proxy authentication, connection limits, allowed IPs, port and target rules, and enabled protocols.
- [Get connection strings](https://developers.soax.com/api/packages/connection-string.md): Build ready-to-use proxy connection strings for a package, with targeting and session rules encoded for you. The returned credentials are used against the proxy gateway (`proxy.soax.com:1337`) — not against this API.
- [Rotate package password](https://developers.soax.com/api/packages/rotate-password.md): Generate a new package password (the 10-character key used to authenticate proxy requests — not the API key). The old password stops working immediately, so update every client that connects through this package. The new plaintext password is returned only in this response.
- [List proxy tiers](https://developers.soax.com/api/locations/tiers.md): List the proxy tiers SOAX offers. Tiers group countries by pool quality and pricing; each country belongs to one tier.
- [List proxy countries](https://developers.soax.com/api/locations/countries.md): List every country available on the SOAX network with its tier, regardless of package. To see what a specific package can target, use the package countries endpoint instead.
- [List package countries](https://developers.soax.com/api/locations/package-countries.md): List the countries this package can route traffic through, with the tier of each country. Use the returned `code` values as the `country` parameter of the connection-string endpoint.
- [List package regions](https://developers.soax.com/api/locations/package-regions.md): List regions available in a country for this package. `rank` orders locations by available pool size (1 = largest) and `volume_level` is a coarse 1–3 indicator of relative IP volume (3 = highest, 1 = lowest). Use `code` values as the `region` parameter of the connection-string endpoint.
- [List package cities](https://developers.soax.com/api/locations/package-cities.md): List cities available in a country (optionally narrowed to a region) for this package. Use `code` values as the `city` parameter of the connection-string endpoint.
- [List package ISPs](https://developers.soax.com/api/locations/package-isps.md): List ISPs available in a country (optionally narrowed by region and city) for this package. Use `code` values as the `isp` parameter of the connection-string endpoint.
- [List package ASNs](https://developers.soax.com/api/locations/package-asns.md): List ASNs available in a country for this package. Use `code` values as the `asn` parameter of the connection-string endpoint.
- [List package ZIP codes](https://developers.soax.com/api/locations/package-zip-codes.md): List ZIP codes available in a country (optionally narrowed by region and city) for this package. Use `code` values as the `zip` parameter of the connection-string endpoint.
- [Get account](https://developers.soax.com/api/account/get.md): Retrieve your organization's account information: name, status (`active` or `suspended`), current plan identifier, and account creation date.
- [List credit blocks](https://developers.soax.com/api/account/credits.md): List your active credit blocks with their initial and remaining balances and expiry dates. Credits are consumed by proxy traffic according to the tier of the country the traffic routes through.
- [Get subscription](https://developers.soax.com/api/account/subscription.md): Retrieve your active subscription: plan, status, and current billing period. Returns 404 if the account has no active subscription.
- [Usage summary](https://developers.soax.com/api/analytics/summary.md): Retrieve aggregate credits burned and traffic (GB) for the selected date range, compared against the previous period of the same length (`previous_period.to_date` is the day before `from_date`). If the API key is restricted to specific packages, only those packages are included. The date range may s…
- [Traffic breakdown](https://developers.soax.com/api/analytics/traffic.md): Retrieve traffic (in GB) grouped by a dimension (`package`, `proxy_type`, `tier`, `country`, `domain`, or `ingress_ip`), as a series of interval buckets. When `group_by=package`, keys are package names. The date range may span at most 365 days. If `interval` is omitted it is chosen automatically fro…
- [Credits burned](https://developers.soax.com/api/analytics/credits-burned.md): Retrieve credits burned per day, broken down by tier. Each item holds one date and a `data` array whose `key` is the tier number (`"1"`, `"2"`, `"3"`) and whose `value` is the credits burned on that tier. The date range may span at most 365 days.
- [Python](https://developers.soax.com/examples/python.md): Working Python code for SOAX residential and mobile proxies. Copy-paste examples using the requests library.
- [Node.js](https://developers.soax.com/examples/nodejs.md): Working Node.js code for SOAX residential and mobile proxies. Copy-paste examples using axios and node-fetch.
- [Go](https://developers.soax.com/examples/go.md): Working Go code for SOAX residential and mobile proxies. Copy-paste examples using net/http.
- [curl](https://developers.soax.com/examples/curl.md): Working curl commands for SOAX residential and mobile proxies. Covers rotating and sessions with copy-paste examples.
- [Advanced: Multi-Geo Monitoring in Go](https://developers.soax.com/examples/advanced/multi-geo-go.md): Production-grade Go example that monitors a URL across multiple countries in parallel using SOAX residential proxies with a worker pool.
- [Error Codes & Fixes](https://developers.soax.com/troubleshooting/error-codes.md): Every error code SOAX returns, what causes it, and how to fix it. Diagnose and resolve issues without opening a support ticket.
- [Connection Debugging](https://developers.soax.com/troubleshooting/connection-debugging.md): Step-by-step checklist for diagnosing SOAX proxy connection issues. Covers timeouts, auth failures, geo mismatches, and common mistakes.
- [CAPTCHA & Ban Rates](https://developers.soax.com/troubleshooting/captcha-ban-rates.md): What to expect from CAPTCHA and ban rates when using SOAX proxies. Learn the difference between proxy issues and target-site detection, and how to improve success rates.
- [Proxy Speed & Latency](https://developers.soax.com/troubleshooting/proxy-speed-latency.md): What affects proxy latency, what to expect from each proxy type, and how to measure and improve performance in your setup.
- [IP Quality & Fraud Score](https://developers.soax.com/troubleshooting/ip-quality-fraud-score.md): What fraud score is, why it matters for proxy use, how different proxy types compare, and how SOAX maintains pool quality.
- [Account Bans & Protection](https://developers.soax.com/troubleshooting/account-bans-protection.md): How account bans differ from IP blocks, what triggers them, and how to structure your proxy usage to reduce that risk.
- [FAQ](https://developers.soax.com/troubleshooting/faq.md): Answers to the most common questions about SOAX. Find what you need here before reaching out to support.

## OpenAPI Specs

- [openapi](/api/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.