When to use
Use the Residential Proxy when you need to:- Access geo-restricted content: View content as it appears in different countries
- Avoid IP blocking: Rotate through residential IPs for reliable access
- Monitor pricing: Check prices and availability across different regions
- Collect SERP data: Gather search results from various locations
- Test localization: Verify how content appears to users in different regions
- Protect brand: Monitor web presence and detect unauthorized use
Connection format
What are Pipelines?
A pipeline groups and directs requests through Nimble Proxy to a relevant proxy peer. Every request to Nimble Proxy flows through a pipeline, and every account comes with a default pipeline. Users can create multiple pipelines, depending on the size of their account. Pipelines serve two main functions:- Marking a business use case - reports and statistics can be filtered to a particular pipeline, making it easy to view how the total data transfer, requests, spending, and success rate for a particular use case. Some examples include:
- A business that collects E-commerce data may choose to make a dedicated pipeline for each data source, such as Amazon, Walmart, Home Depot, etc.
- An organization that gathers SERP data may choose to create a pipeline for different goals, such as competitor monitoring, search term tracking, paid and SEM monitoring, etc.
- A team that performs brand protection can create a pipeline for each client/brand they manage.
- Setting defaults - Pipelines contain default settings that are inherited by the requests they oversee, and become especially useful when using Authenticated IPs, where parameters cannot be set manually in the request body and must be configured within the pipeline. Some of the parameters that can be set on the pipeline level include:
- IP rotation (rotating/fixed interval)
- Country, State, and City geotargeting
- Optimization engine profile
How do I configure a pipeline?
In the Dashboard, click on the “Pipelines” page in the left navigation menu.- To create a new pipeline, click “+Add Pipeline” on the right-hand button.
- Pipelines can be disabled and/or archived by clicking the three-dot menu handle in the relevant pipeline’s row, and then “Disable Pipeline” or “Archive Pipeline”.
- To modify a pipeline, click anywhere on the pipeline row to enter the pipeline details page. Then click on the “Settings” tab to view and edit the pipeline settings.
Core parameters
Required parameters
| Parameter | Description | Example |
|---|---|---|
accountName | Your company gateway name | mycompany |
pipelineName | Pipeline to use (default: “residential”) | residential |
pipelinePassword | Your pipeline authentication credential | your-password |
Optional parameters
Add these to your connection string using hyphens:| Parameter | Description | Format |
|---|---|---|
country | Target specific country | country-{countryCode} |
state | Target US or CA states | state-{stateCode} |
city | Target specific city | city-{cityName} |
session | Maintain sticky session | session-{sessionId} |
geosession | Geo-consistent session (advanced) | geosession-{sessionId} |
Usage
Basic proxy request
Basic proxy request
Send requests through residential proxy:
Country targeting
Country targeting
Route requests through specific countries:
- use ISO Alpha-2 Country Codes i.e. US, DE, GB
State targeting (US & CA only)
State targeting (US & CA only)
Target specific US states:
- use ISO Alpha-2 Country Codes i.e. NY, AZ, CA
City targeting
City targeting
Target specific cities for precise location control:
Sticky sessions
Sticky sessions
Maintain the same IP across multiple requests:Session behavior:
- Sessions remain active for 10 minutes after last request
- Session IDs can be up to 32 alphanumeric characters
- If IP goes offline, a new IP is automatically assigned
Combined targeting and sessions
Combined targeting and sessions
Combine geotargeting with sticky sessions:
Geo-sessions (advanced)
Geo-sessions (advanced)
Maintain geographic proximity and ISP consistency across rotations:Geo-session features:
- Max IP proximity stays 15km from of original location
- Same ISP/ASN across rotations when possible
- Session persists up to 10 days
- World-wide, optimized performance in US
- Requires session ID of 16-32 characters
Authentication methods
Username & password
Include credentials in every request (default method):IP allowlist
Authenticate by trusted IP addresses without credentials:- Add your IP to pipeline allowlist in Nimble dashboard
- Configure custom port (9000-10000)
- Send requests without username/password:
Learn More About Authentication
Detailed guide to authentication methods and configuration
Response format
Successful response
When requestinghttps://ipinfo.io/json:
Error responses
| Code | Meaning | Solution |
|---|---|---|
| 407 | Authentication failed | Verify account name, pipeline, and password |
| 525 | No IP available for location | Try different location or remove filtering |
| 401 | IP not in allowlist | Add your IP to pipeline allowlist |
| 403 | Pipeline disabled or quota reached | Check dashboard for pipeline status |
Complete Response Codes
View all response codes and troubleshooting steps
Best practices
Choose appropriate rotation
Use rotating IPs (default) for:- Web scraping at scale
- Rate limit distribution
- Maximum IP diversity
- Multi-step workflows
- Login flows
- Shopping cart sessions
Configure timeouts
Set appropriate timeouts for proxy requests:Handle IP rotation
Plan for IP changes in sticky sessions:Monitor quota usage
Track your proxy usage to avoid hitting limits:- Check dashboard for real-time usage
- Set up alerts for quota thresholds
- Plan request volume within limits
Common use cases
E-commerce price monitoring
Monitor prices across different regions:SERP data collection
Collect search results from multiple locations:Multi-step automation
Maintain session through login and workflow:Limitations
Geographic coverage
- Global: Residential IPs available in 195+ countries
- State targeting: US and CA only
- City targeting: Major cities worldwide
- Geo-sessions: World-wide, optimized performance in US
Session limits
- Session duration: 10 minutes of inactivity
- Geo-session duration: Up to 10 days
- Session ID length: Maximum 32 characters
- Geo-session ID length: 16-32 characters (minimum 16)
Request limits
- Timeout: Recommended 40-45 seconds
- Concurrent connections: Varies by plan
- Quota: Based on your subscription plan

