> For the complete documentation index, see [llms.txt](https://loyalproxy.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://loyalproxy.gitbook.io/docs/dynamic-residential-ip/whitelist-extraction.md).

# Whitelist Extraction

{% hint style="warning" %}
**Usage Notice**: All LoyalProxy proxy products must be operated in an overseas network environment. Please ensure that you have already configured the corresponding overseas network environment yourself.
{% endhint %}

**Configure Proxy Parameters**

**Parameter Description**

<table data-search="false"><thead><tr><th width="121.800048828125">Parameter</th><th width="68.39990234375">Type</th><th width="84" 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, such as <code>US</code> (random if left blank)</td></tr><tr><td><code>state</code></td><td>string</td><td align="center">No</td><td>State/region code, such as <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, such as <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 Geolocation**

* Select a specified **country/region**
* Or select **Random Location** and let the system assign it automatically

**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 for each new request
* **Sticky IP**: Keeps 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**.

<figure><img src="https://2848578098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdfOrBpHOwvTBkZnuE9M3%2Fuploads%2F7uCdDVh0IAGquTL7394L%2Fimage.png?alt=media&amp;token=b0ece496-41bf-441f-9b88-fafa5aaebb74" alt=""><figcaption></figcaption></figure>

**Generate and Retrieve 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 get the API link for programmatic use

<figure><img src="https://2848578098-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdfOrBpHOwvTBkZnuE9M3%2Fuploads%2FY5qrBhgiphedODnTyzVz%2Fimage.png?alt=media&amp;token=4eeb0f17-ef52-4640-8776-c0586d74e425" alt=""><figcaption></figcaption></figure>

> **At this point, you have successfully configured the Dynamic Residential IP API whitelist and can retrieve proxy information through the API link.**