🔌 API Documentation
Integrate SP5Proxies into your applications
GET
Get Your Proxies
Retrieve a list of all your active proxies
/api/proxies
Response
{
"success": true,
"proxies": [
{
"id": "uuid",
"ip": "168.231.82.24",
"port": 20001,
"protocol": "SOCKS5",
"country": "United States",
"city": "Sacramento",
"username": "user123",
"password": "pass123",
"status": "ACTIVE",
"expiresAt": "2025-12-31T23:59:59Z"
}
]
}GET
Get Proxy Details
Get detailed information about a specific proxy
/api/proxies/:id
Parameters
| Name | Type | Description |
|---|---|---|
| id | string | Proxy UUID |
POST
Change Protocol
Switch between HTTP and SOCKS5 protocols
/api/proxies/:id/protocol
Request Body
{
"protocol": "HTTP"
}POST
Change Location
Change proxy location to a different country/city
/api/proxies/:id/location
Request Body
{
"country": "United States",
"city": "New York"
}⚡ Rate Limits
- • 100 requests per minute per API key
- • 10,000 requests per day per API key
- • Exceeding limits will result in HTTP 429 (Too Many Requests)
❌ Error Codes
| Code | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid API key |
| 404 | Not Found - Resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |