> For the complete documentation index, see [llms.txt](https://docs.rapidproxy.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rapidproxy.io/proxies/dynamic-residential-proxy/get-proxy/api/get-proxy-via-api-method.md).

# Get Proxy via API Method

Learn how to configure and use the Rapidproxy API method to retrieve dynamic residential proxies using IP whitelist authentication.

This guide explains how to obtain Dynamic (Rotating) Residential Proxies using the **API Acquisition** method in Rapidproxy.\
With API Acquisition, you can generate proxy API links based on your selected parameters and integrate them directly into your applications.

***

### Overview

The **API Acquisition** method allows you to generate proxy access links dynamically by configuring proxy parameters in the dashboard.

Using this method, you can:

* Define IP quantity and target location
* Select proxy protocol and output format
* Generate ready-to-use API links
* Copy and integrate the API link into scripts or tools

***

### Accessing API Acquisition

To open the API Acquisition settings:

1. [Log in to your Rapidproxy account](https://www.rapidproxy.io/user/login).
2. Go to **UCenter**.
3. Navigate to:\
   **Rotating Residential Proxies → Use Proxy → API Method**

<figure><img src="https://3714437495-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYesC7FUvYuYg4WiqU6o7%2Fuploads%2FVGgO2xPz6FUsReZjVZGw%2Fapimethod.png?alt=media&amp;token=125c6c89-0e09-498f-8921-2456274e51b7" alt=""><figcaption></figcaption></figure>

This page contains all available settings required to generate proxy API links.

***

### API Acquisition Setup

Follow the steps below to configure and generate your proxy API link.

***

#### Step 1: Set IP Quantity and Region

On the **API Method** page:

1. Set the **IP Quantity** (number of proxy IPs to retrieve).
2. Select the desired **Region / Country** according to your needs.

These settings determine how many IPs you receive and from which location.

<figure><img src="https://3714437495-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYesC7FUvYuYg4WiqU6o7%2Fuploads%2FoJ18h8MPFiH3CVomBnkf%2Fapiacquisition.png?alt=media&amp;token=43122e58-45ab-4411-ba6c-54d9e1d87d88" alt=""><figcaption></figcaption></figure>

***

#### Step 2: Configure API Parameters

Next, configure the output and protocol options:

* **Proxy Protocol**\
  Choose the protocol you want to use (e.g. HTTP(S) or SOCKS5).
* **Data Format**\
  Select the format in which proxy data will be returned (for example, plain text or structured format).
* **Delimiter**\
  Choose the delimiter used to separate proxy fields in the output.

These options control how proxy information is returned by the API.

***

#### Step 3: Generate the API Link

After completing all settings:

1. Click **Generate results**.
2. The system will generate a **proxy API link** based on your configuration.
3. Click the generated link to **copy** it.

<figure><img src="https://3714437495-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYesC7FUvYuYg4WiqU6o7%2Fuploads%2FDzuOaer3PcIkpLQ8ztDd%2Fgenerrate.png?alt=media&amp;token=c9fb5bdb-e664-4d96-9727-9d157abffb8f" alt=""><figcaption></figcaption></figure>

You can now use this API link directly in your application, script, or proxy management tool.

***

### Using the Generated API Link

Once copied, the API link can be:

* Embedded into automation scripts
* Used in proxy-enabled tools
* Integrated into scraping frameworks or applications

As long as your **IP is** [**whitelisted**](https://docs.rapidproxy.io/proxies/dynamic-residential-proxy/get-proxy/api/ip-whitelisting), the API link will return valid proxy data according to your configuration.

***

### Notes & Best Practices

* Make sure your **outbound IP address** is added to the whitelist before using the API.
* If your server IP changes, update the whitelist accordingly.
* You can regenerate API links at any time by adjusting parameters and clicking **Generate results** again.

***

### Need Help?

If you have questions about API Acquisition or proxy setup:

* Use the **online live chat** on the Rapidproxy website
* Email **<support@rapidproxy.io>**

Support can assist with configuration, authentication, and API usage issues.