> ## Documentation Index
> Fetch the complete documentation index at: https://help.b2proxy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Use Unlimited Residential Proxies via APl Extraction?

B2Proxy supports the extraction of unlimited residential proxies via the **API method (authenticated by IP whitelisting)**, eliminating the need for usernames and passwords and offering a more secure and stable configuration. This article explains how to add whitelisted IPs and successfully extract unlimited residential proxies through the API, helping you quickly complete the setup and start using the service.

## I. Basic Setup Steps

### 1. Add IP Whitelist

<img src="https://mintcdn.com/cloudguidenetworktechnology/CVb6MTkacPrDi0OQ/images/resi-api.png?fit=max&auto=format&n=CVb6MTkacPrDi0OQ&q=85&s=aa413e5613d23378e5c99855d72eed40" alt="Resi Api" width="1275" height="307" data-path="images/resi-api.png" />

Go to "IP Whitelist", click "Add Whitelist", and enter the IP address of the network environment where you need to use residential proxies.

<Warning>
  Note: API calls will be blocked for non-whitelisted IPs.
</Warning>

### 2. Set the Number of Proxies

Enter required number of IPs (e.g., 100).

### 3. Protocol & Format Configuration

Protocol: Default HTTP(S), optional SOCKS5.

Format: Default TXT (one IP:port per line), optional JSON.

Separator: Default line break.

### 4. Set Session Type

Rotating IP: Auto-rotates IP per request (ideal for scraping/data collection).

Sticky IP: The IP remains fixed for a period of time (5 minutes by default), suits account management).

<Tip>
  When selecting a sticky IP, choose “Yes” in the \[Change IP in Advance] option to allow the system to automatically switch the IP earlier based on its actual available time.\
  If you choose “No,” the IP will remain unchanged during the sticky session and can only be switched after the session ends.
</Tip>

### 5. Select Hostname

Based on your network IP, select the nearest server. You can also manually choose other nodes.

### 4. Generate API URL

Click 「Generate URL」 to get a unique API link.

<img src="https://mintcdn.com/cloudguidenetworktechnology/FZFMYloLqLaZufUK/images/%E4%B8%8D%E9%99%90%E9%87%8C-%E8%8B%B1%E6%96%87.png?fit=max&auto=format&n=FZFMYloLqLaZufUK&q=85&s=bf1ffb098c2e4079836b9f5d39a2fea5" alt="Resi Api1" lightAlt="Resi Api1" darkAlt="Resi Api1" className="dark:hidden" width="1283" height="322" data-path="images/不限里-英文.png" />

<img src="https://mintcdn.com/cloudguidenetworktechnology/FZFMYloLqLaZufUK/images/%E4%B8%8D%E9%99%90%E9%87%8C-%E8%8B%B1%E6%96%87-1.png?fit=max&auto=format&n=FZFMYloLqLaZufUK&q=85&s=5c59bb5ee615f8e6b19f2c477e15a097" alt="Resi Api1" lightAlt="Resi Api1" darkAlt="Resi Api1" className="hidden dark:block" width="1283" height="322" data-path="images/不限里-英文-1.png" />

## II. Call the API to Get Proxies

Open the API link in your browser or configure it in your tool. A correct response example would be:

1.1.1.1:8888

2.2.2.2:8888

…

If the following message appears, it means the whitelist was not added correctly. Please go back to step one and check.

```text theme={null}
IP Whitelist Check Failed
```

<Warning>
  Rate Limit: 1 request/second.
</Warning>

<Warning>
  Proxy Validity: 24 hours (default). Regenerate after expiry.
</Warning>