> For the complete documentation index, see [llms.txt](https://jollyproxy.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jollyproxy.gitbook.io/docs/residential-proxy/whitelist-extraction.md).

# Whitelist Extraction

{% hint style="danger" icon="exclamation" %}
**Usage Notice**: All JollyProxy proxy products must be used in an overseas network environment. Please ensure that you have configured the corresponding overseas network environment yourself.
{% endhint %}

**Configure Proxy Parameters**

**Parameter Description**

<table data-search="false"><thead><tr><th width="127.4000244140625">Parameter</th><th width="77.9998779296875">Type</th><th width="68" align="center">Required</th><th>Description</th></tr></thead><tbody><tr><td><code>mode</code></td><td>string</td><td align="center">Yes</td><td>Session type: <code>rotating</code> (rotating IP), <code>sticky</code> (sticky IP)</td></tr><tr><td><code>host</code></td><td>string</td><td align="center">Yes</td><td>Proxy gateway address</td></tr><tr><td><code>protocol</code></td><td>string</td><td align="center">Yes</td><td>Proxy protocol: <code>http</code> or <code>socks5</code></td></tr><tr><td><code>country</code></td><td>string</td><td align="center">No</td><td>Country code, e.g., <code>US</code> (random if not filled)</td></tr><tr><td><code>state</code></td><td>string</td><td align="center">No</td><td>State/region code, e.g., <code>AK</code> (must be used together with country)</td></tr><tr><td><code>city</code></td><td>string</td><td align="center">No</td><td>City name, e.g., <code>Bethel</code> (must be used together with country and state)</td></tr><tr><td><code>count</code></td><td>int</td><td align="center">Yes</td><td>Number of proxies to generate, supports <strong>1 to 100</strong></td></tr><tr><td><code>format</code></td><td>string</td><td align="center">Yes</td><td>Output format: <code>txt</code> (text format), <code>json</code> (JSON format)</td></tr><tr><td><code>sessionTime</code></td><td>int</td><td align="center">No</td><td>Sticky IP duration (minutes), <strong>1 to 60</strong>, only effective when <code>mode=sticky</code></td></tr></tbody></table>

**Configuration Steps**

**Select Geographic Location**

* Select a specific **country/region**
* Or select **random location** to be automatically assigned by the system

**Select Proxy Format**

* **TXT**: Text format
* **JSON**: JSON format

**Select Proxy Protocol**

Supports both **HTTP** and **SOCKS5** proxy protocols. Please choose according to your actual use case.

**Select Proxy Address**

The system will automatically assign an available proxy gateway address based on your configuration.

**Configure Session Type**

* **Rotating IP**: Automatically changes IP on each new request
* **Sticky IP**: Maintains the same IP for a duration of **1 to 60 minutes**

**Set Generation Quantity**

Select the number of proxies to generate, supporting any integer between **1 and 100**.

**Generate and Obtain Proxy Information**

1. Click the **Generate Proxy** button
2. In the **Proxy Information** area on the right, the system will display the generated proxy information based on the above configuration
3. After successful generation, you can:
   * Directly click **Open URL** to view the generated proxy list in your browser
   * Or click **Copy URL** to obtain the API link for program calls

<figure><img src="https://1126830726-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FureEI2hB2llelhLWxJFY%2Fuploads%2Fp4tPOWBSDfkf3B7qXmUM%2Fimage.png?alt=media&amp;token=5a7f156b-4f42-4f6d-84c6-b19993bf415a" alt=""><figcaption></figcaption></figure>

> **You have now successfully configured the Residential Proxy API whitelist and can obtain proxy information through the API link.**


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://jollyproxy.gitbook.io/docs/residential-proxy/whitelist-extraction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
