Proxy API Documentation
Manage proxies, rotate IPs, monitor usage, and automate your entire proxy workflow through our RESTful API. Full documentation with code examples.
API Endpoints
/v1/proxiesList Proxies
Retrieve all active proxies in your account with filtering by type, country, and status.
/v1/proxies/rotateRotate IP
Force an immediate IP rotation on a specific proxy or proxy group. Returns the new IP address.
/v1/usageCheck Usage
Get current bandwidth usage, request counts, and remaining quota for your subscription.
/v1/proxies/createCreate Proxy
Provision a new proxy with specified type, country, and authentication method.
/v1/locationsList Locations
Get all available proxy locations with country, city, and ASN information.
/v1/proxies/{id}Delete Proxy
Remove a proxy from your account. Static IPs are released back to the pool immediately.
Authentication
Bearer Token Authentication
All API requests require a Bearer token in the Authorization header. Generate API keys from your dashboard under Settings > API Keys. Each key can be scoped to specific permissions and revoked independently.
API keys are sensitive credentials. Never expose them in client-side code or public repositories. Use environment variables or secret managers.
Code Examples
curl -X GET "https://api.resproxy.io/v1/proxies" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
# Response
{
"data": [
{
"id": "px_abc123",
"type": "rotating_residential",
"country": "US",
"host": "us.proxy.resproxy.io",
"port": 8080,
"status": "active"
}
],
"total": 12,
"page": 1
}import requests
API_KEY = "YOUR_API_KEY"
BASE_URL = "https://api.resproxy.io/v1"
# List all proxies
response = requests.get(
f"{BASE_URL}/proxies",
headers={"Authorization": f"Bearer {API_KEY}"}
)
proxies = response.json()["data"]
# Rotate IP
rotate = requests.post(
f"{BASE_URL}/proxies/rotate",
headers={"Authorization": f"Bearer {API_KEY}"},
json={"proxy_id": "px_abc123"}
)
new_ip = rotate.json()["new_ip"]
print(f"New IP: {new_ip}")const axios = require('axios');
const API_KEY = 'YOUR_API_KEY';
const BASE_URL = 'https://api.resproxy.io/v1';
// List all proxies
const { data } = await axios.get(`${BASE_URL}/proxies`, {
headers: { Authorization: `Bearer ${API_KEY}` }
});
console.log(data.data);
// Rotate IP
const rotation = await axios.post(
`${BASE_URL}/proxies/rotate`,
{ proxy_id: 'px_abc123' },
{ headers: { Authorization: `Bearer ${API_KEY}` } }
);
console.log('New IP:', rotation.data.new_ip);Rate Limits
| Plan | Rate Limit | Burst | Note |
|---|---|---|---|
| Starter | 100 req/min | 20 req/sec | Suitable for small-scale automation |
| Professional | 500 req/min | 50 req/sec | Recommended for production workloads |
| Enterprise | Custom | Custom | Tailored limits based on your needs |
Rate limit headers (X-RateLimit-Remaining, X-RateLimit-Reset) are included in every API response.
Frequently Asked Questions
Where do I find my API key?
Your API key is available in the ResProxy dashboard under Settings > API Keys. You can generate multiple keys for different applications and revoke them individually.
Is the API backward compatible?
Yes. We version our API and maintain backward compatibility within each major version. Breaking changes are only introduced in new major versions with at least 6 months notice.
What response format does the API use?
All API responses are in JSON format. Successful responses include a 'data' field with the payload. Error responses include 'error' and 'message' fields with descriptive error details.
Can I use the API with rotating proxies?
Yes. The API supports all proxy types including rotating residential, static IPv4, ISP, and IPv6 proxies. You can manage rotation settings, check current IPs, and force rotations programmatically.
How do I authenticate against the ResProxy REST API?
The ResProxy REST API uses Bearer Token authentication via the Authorization header. You can generate multiple API keys from your dashboard, each scoped to specific permissions. IP whitelisting is also available as an additional security layer for Enterprise plans.
Is there a rate limit?
Yes. Rate limits vary by plan: Starter (100 req/min), Professional (500 req/min), and Enterprise (custom). Rate limit headers (X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response so you can monitor usage in real time.
Can I manage proxies via API?
Absolutely. The API provides full proxy lifecycle management — create, list, rotate, and delete proxies programmatically. You can also update proxy settings, switch locations, and configure rotation intervals without visiting the dashboard.
Do you have SDKs for different languages?
We provide official SDKs for Python, Node.js, and Go, available on our documentation site. Community-maintained libraries exist for PHP, Ruby, and Java. All SDKs wrap our REST API and include TypeScript definitions where applicable.
Start Building with the Proxy API
Get your API key and start automating proxy management in minutes. Full documentation, SDKs, and code examples available.