Capabilities & scope
These features use the same ARNPROXY account and existing website workflows. Required permissions, eligible products and verification rules are documented on each operation page.
Account and balance
Read account details, currency, balance and effective permissions. A key is provisioned on the first eligible account-page visit; administrator restrictions and verification rules remain in force.
/capabilitiesAccount and currencyGET /accountAccount balanceGET /balancePurchases and multi-country orders
Use up to 20 distinct location_id values under one product_id. Each country creates a separate order record; the linked checkout is handled as one invoice. Quantity discounts are calculated independently per country.
/productsLocations, periods and purposesGET /catalogOrder quote; no debitPOST /quoteMore related operations · 2
Accepted does not mean delivered
HTTP 201/202 or state=accepted may confirm acceptance only. Follow the same operation with purchase_status / residential_purchase_status and fulfillment with order_delivery. Honor poll_after_seconds and Retry-After when present. Do not repurchase under a new Idempotency-Key after a timeout.
/ordersOrder summaryGET /orders/{id}Current delivery and queue statusGET /orders/{id}/deliveryMore related operations · 1
Active proxies, notes and export
Read only your own active proxies and order connections. Manage notes and export connection details or CSV/custom content with the required permission. Other customers’ data is not exposed.
/proxies/{id}/noteSet an owned proxy note; clear using an empty stringPOST /proxies/noteActive proxiesGET /proxiesMore related operations · 3
Renewals and automatic renewal
Check renewable proxies and quotes, then renew from the balance. The automatic-renewal API manages the existing balance method; enabling it does not charge immediately or alter card-renewal settings.
/auto-renewalBalance renewal settings and eligible periods of selected proxiesGET /auto-renewal/optionsCurrent price estimate for automatic balance renewalPOST /auto-renewal/quoteMore related operations · 7
IP replacement requests
Get a quote, submit a request and track it. Requests follow existing administrator review; they do not instantly assign a new IP for every call.
/replacements/quoteSubmit replacement for admin reviewPOST /replacements/createSaved replacement submissionGET /replacements/statusMore related operations · 1
Extra logins separate from the primary
Create, list, replace and delete extra logins while preserving primary delivery credentials. Get random/custom modes and length rules from options. Some actions affect a package/order group. The account Logins page provides viewing and deletion; creation/replacement uses the API.
/extra-logins/replace/optionsCreate and verify a new extra login, then revoke the old extra loginPOST /extra-logins/replaceReconcile the same replacement; no provider writesGET /extra-logins/replace/statusMore related operations · 9
- Explicitly resume only an unsent replacement step
- Extra login scope and options
- Create extra credentials without changing the primary
- Extra login and its owned proxies
- Revoke only the selected extra login
- Reconcile the same extra-login operation
- Explicitly approve an unsent step
- Customer API supplemental registry
- Supplemental login assessment and cleanup planning history
Proxy authorized-IP management
Use IP add/remove only as allowed by the scope/options response. Actions may be package-wide; do not omit scope acknowledgments. API removal is limited to your account’s recorded API-added IP grants.
/proxies/{id}/accessAdd an authorized IP within verified scopePOST /proxies/authorized-ips/addRemove only an authorized IP created through this APIPOST /proxies/authorized-ips/removeMore related operations · 3
Residential: new package versus GB top-up
Customers do not select a purpose for Residential orders. For a new package, the server automatically assigns the same fixed purpose as the website checkout; do not send purpose_id, subpurpose_id or other_purpose. A top-up preserves the existing package purpose.
/residential/catalogNew package / top-up price; no debitPOST /residential/quoteBalance Residential order via website delivery queuePOST /residential/orders/createMore related operations · 1
Locations, IP pool and connection lists
Read country/region/city/ISP choices and IP-pool observations. Create lists, change their title/rotation or delete them. Select supported login/password or IP authentication when creating a list. Pool counts may be cached observations, not an IP guarantee for every connection.
/residential/locationsHourly traffic history of owned registered logins onlyGET /residential/trafficExport an existing connection list; does not create a listPOST /residential/exportMore related operations · 13
- Owned packages; stored snapshot
- One package; stored snapshot
- Connection lists for a package
- One connection list
- List create/delete scope and revision
- Create a connection list in an existing package; no GB purchase
- Delete only an owned connection list; never the package
- Verify the list operation with GETs; never resend create/delete
- Check list settings with provider
- Refresh package snapshot; no GB purchase
- Rename a connection list
- Change connection list rotation
- Check the same operation; does not repeat the write
Sessions & targeting
Create and verify an eligible special Residential list first, then prepare session/TTL connection strings. Formatting a connection does not consume traffic; actual use does.
/residential/sessions/optionsCreate a separate session list; no GB purchasePOST /residential/sessions/createFormat targeted connections from a special session listPOST /residential/sessions/exportMore related operations · 1
Rotating proxies
Set the IP-change interval in seconds for an eligible Rotating package. This is not an instant IP-swap action; the setting applies at package scope.
/rotating/{id}/optionsChange a Rotating package rotation intervalPOST /rotating/rotationVerify a Rotating operation using reads only; never resendGET /rotating/statusTwo separate IP allowlists
The allowlist in My account → API controls which addresses may use the API key and is managed on the account page. Proxy authorized-IP operations control which addresses may connect to the proxy. These settings do not modify one another.
Webhooks and ready-made clients
Webhooks are optional. Use your own HTTPS receiver and verify signatures, or follow results with status requests. PHP, Python, Node.js, Java and Go SDKs and Postman collections are available.
Unavailable operations and important limits
There is no card/bank balance-deposit API; fund the account on the website. Primary delivery credentials cannot be changed or deleted through the customer API. IP replacement follows the existing administrator-review process. Deleting a Residential connection list does not delete the GB package.
Permissions come from administrator account settings; customers do not select additional scopes. Existing administrator restrictions apply.