Proxy API integration for an antidetect browser
Proxy API integration lets a browser profile request proxy connection details from a provider's extraction URL. In WGBrowser, a proxy source stores the request, parameters, and response parsing rules so your team can use the same definition across proxies and profiles. Choose URL template for a single request, or Integration script when the provider requires signing, token exchange, or several requests.
Connect a provider's extraction URL
Open Proxies → Sources and click New source. Select URL template, enter a name and Extraction URL, and set Default protocol. The extraction URL is an HTTP or HTTPS API endpoint. The proxy it returns can use HTTP, HTTPS, or SOCKS5. Confirm both protocols in the provider's documentation; they describe different connections.
Set Request method to match the API. For POST requests, fill in Request body; add authentication headers under Request headers when required. Store credentials under Parameters and mark sensitive values as Secret. A key written directly into the URL remains part of that URL when exported or shared, even if you exclude secret parameter values.
An extraction URL is not a proxy host. It returns the host, port, and optional credentials that the browser will use. If your provider gives you connection details directly, follow the proxy setup guide instead.
Match regional parameters to the provider
A URL template can substitute regional values, a requested count, timestamps, random values, and your own parameters. Values inserted into the URL are URL-encoded. Parameter names and placement must still match the provider's API. Do not assume a location name and a location code are interchangeable.
The built-in Province and City selectors use Chinese administrative regions and codes. They are not a worldwide location selector. For other destinations, configure the provider's documented location values in the URL or custom parameters. If a provider uses its own codes, map them explicitly. Check the final request, returned data, and measured exit location together.
Opening a profile does not automatically switch to another region when the selected region has no resources. Workflow plugins can explicitly request a broader fallback; that behavior belongs to the plugin configuration.
Parse text and JSON responses
Response format offers Auto, Text, JSON, and Regex. Auto tries common text and JSON formats. Text can contain multiple proxy entries, including host and port, credentials after the port, or credentials before the host. When an entry omits its protocol, Default protocol applies. These examples use documentation addresses; replace them with actual provider results.
Common JSON host fields include ip, host, and sever, with port and common username and password fields recognized automatically. For other structures, select JSON and set List path, Host path, and Port path. Use dotted paths or array indexes for nested data. The complete response object is not necessarily the proxy list.
Auto recognizes expiry fields on the outer response. Use JSON parsing and check Expiry path when individual entries have their own expiration times. Regex requires named host and port groups.
203.0.113.10:8080
203.0.113.11:1080:user:pass
socks5://user:pass@203.0.113.12:1080Test extraction and the exit IP
The Test panel runs the current editor configuration without requiring a save. Choose the region and count, then inspect the returned addresses, expiration times, Requests, and Response body. Enable Check exit IP to test the resulting connection. Receiving connection details and successfully reaching a proxy exit are separate checks.
An HTTP success response can still contain a provider error. Configure Success value path, Accepted values (comma-separated), and Error message path from a real response. If records are present but no host and port are recognized, correct the field paths. If the list is empty, check whether the requested location has available resources.
Failures distinguish No resources, Too many requests, Temporary failure, and Configuration issue. Read the provider's message before retrying. Check credentials, balance, or allowlisting for configuration errors; adjust request timing for rate limits; investigate connectivity for network failures.
Choose when a profile requests a proxy
After testing, save the source. Create an entry in the proxy library or edit a profile's Custom proxy. Set Proxy kind to Extraction and Extraction method to Proxy source, then choose the source, region, and When to extract. Record which account uses each source and location.
Every time it opens makes a new extraction request on each profile launch. Only when the last IP stops working reuses a cached proxy while it remains usable; this cache is held during the client session. A new request does not guarantee a different IP, and extraction cannot guarantee a fixed exit. Check residential proxy behavior before choosing a mode for a persistent login.
Extraction requests originate directly from the local computer. Provider allowlisting must cover that computer's actual request exit, including after a network or device change. The extraction API key and the returned proxy's username and password are separate credentials.
Use an integration script
Select Integration script when the API needs a signature, token exchange, multiple requests, or additional response conversion. Insert example and Import from file provide starting points. The fixed acquire(query, ctx) entry receives the region and count and returns a host and port, with optional authentication and expiry details.
Scripts run on the member's computer. A script written or changed by someone else, imported, or claimed from a share requires local approval. Use Approve script and review it before choosing Allow on this device. Changed code may need approval again. Workflow plugins can call configured sources and handle the failure categories; see automation.
Share source configurations with a team
Sources are shared team configurations. Creating, editing, and deleting them requires Manage proxies permission. One source can serve several proxies and profiles, so check its references before editing. Remove references before deleting a source. Team permissions determine who can maintain these definitions.
Select sources and use Export to save JSON, or Import to read a file in another team. Exports omit secret parameter values by default; including them enables encryption by default. Review duplicate and name-conflict results before choosing to add a copy, overwrite, or skip. Fill in missing credentials and test the imported configuration.
Share creates a code that a recipient enters under Proxies → Sources → Claim share. Both creating and claiming require Manage proxies. Claiming copies the definition current at that time; each team maintains its copy afterward. Revoking the code stops future claims and does not remove existing copies.
FAQ
Why does my proxy API return JSON but no usable proxy?
Check the provider's success field first, then the list, host, and port paths. HTTP success alone does not mean extraction succeeded. If the response contains records with unfamiliar field names, select JSON and enter explicit paths. Use the Test panel's response body to distinguish an empty resource list from a parsing problem.
Does a proxy source automatically change regions when no IP is available?
A normal profile launch keeps the selected region and reports a failure if no resource is available. Workflow plugins can explicitly configure a province or unrestricted fallback, but that does not change ordinary profile behavior. The built-in regional picker covers Chinese administrative regions; other location values must follow your provider's API format.
Why can I extract a proxy but fail the exit IP check?
Extraction confirms that the API returned connection details. The exit check tests whether those details work. Verify the proxy protocol, username and password, expiration time, and allowlist requirements. Also check which computer sends the extraction request. A working API key does not prove that the returned proxy's separate authentication is correct.
Can I move a proxy API configuration to another team?
Yes. Export the source as JSON or create a share code, then import or claim it in the receiving team's Sources tab. Review whether secret parameter values are included and supply missing credentials before testing. Integration scripts still need approval on the receiving computer. Claimed copies are maintained independently, and revocation only stops future claims.