REST API Reference
This section covers the proxy management APIs — programmatic control over geo lookups, authorized source IPs, geo defaults, and the proxy list for Residential Proxies, ISP Proxies, and legacy port-based plans.
Base URLs
Section titled “Base URLs”| Product | Base URL |
|---|---|
| Residential Proxies | https://shifter.io/api/v1/residential |
| ISP Proxies | https://shifter.io/api/v1/static-residential |
| Legacy plans | https://shifter.io/api/v1/backconnect |
Authentication
Section titled “Authentication”Residential Proxies
Section titled “Residential Proxies”Pass your api_key as a query parameter. Create keys in the panel under Account → API Keys.
curl "https://shifter.io/api/v1/residential/geo/countries?api_key=YOUR_API_KEY"ISP Proxies and legacy plans
Section titled “ISP Proxies and legacy plans”Use your account’s API token as the api_token query parameter. Generate it in the panel under Account → API Tokens.
curl "https://shifter.io/api/v1/static-residential/YOUR_PLAN_ID/proxies?api_token=YOUR_API_TOKEN"The {membership} path parameter accepts either the Membership ID shown on the plan page in the panel (for example 68057) or the short code from the plan’s URL (for example Rxqk).
Errors
Section titled “Errors”Every endpoint returns a standard HTTP status. Response bodies for failures include a JSON object with error and message.
{ "error": "invalid_api_key", "message": "The provided api_key is missing or invalid"}| Status | Meaning |
|---|---|
200 | Success |
400 | Bad request (malformed or missing required parameter) |
401 | Invalid or missing credentials |
403 | Plan does not allow this feature or endpoint |
404 | Membership or resource not found |
429 | Too many requests, retry with backoff |
500 | Internal error, retry with backoff |
Method overrides
Section titled “Method overrides”Some legacy management endpoints accept POST with a _method=PUT form field as equivalent to PUT — useful when your HTTP client strips non-standard methods.