Skip to content
Login Sign up

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.

ProductBase URL
Residential Proxieshttps://shifter.io/api/v1/residential
ISP Proxieshttps://shifter.io/api/v1/static-residential
Legacy planshttps://shifter.io/api/v1/backconnect

Pass your api_key as a query parameter. Create keys in the panel under Account → API Keys.

Terminal window
curl "https://shifter.io/api/v1/residential/geo/countries?api_key=YOUR_API_KEY"

Use your account’s API token as the api_token query parameter. Generate it in the panel under Account → API Tokens.

Terminal window
curl "https://shifter.io/api/v1/static-residential/YOUR_MEMBERSHIP_ID/proxies?api_token=YOUR_API_TOKEN"

The {membership} path parameter on ISP and legacy endpoints is your plan ID, shown in the panel on the plan page.

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"
}
StatusMeaning
200Success
400Bad request (malformed or missing required parameter)
401Invalid or missing credentials
403Plan does not allow this feature or endpoint
404Membership or resource not found
429Too many requests, retry with backoff
500Internal error, retry with backoff

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.