// api reference
API Reference
A clean, predictable REST interface for provisioning endpoints, targeting locations and reading usage across the VitesseProxies network. JSON in, JSON out.
// authentication
Bearer your key.
Every request is authenticated with a secret API key issued from your dashboard. Pass it in the Authorization header as a bearer token. Keep it server-side — never ship it to a browser or commit it to source control.
Authentication
curl https://api.vitesseproxies.com/v1/proxies \
-H "Authorization: Bearer YOUR_API_KEY"// base url
One stable host.
All endpoints are versioned and served from a single base URL. Append the path of any resource below. The example provisions a rotating residential endpoint pinned to the US.
BASE https://api.vitesseproxies.com/v1
Provision an endpoint
curl -X POST https://api.vitesseproxies.com/v1/proxies \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"pool": "residential",
"country": "US",
"rotation": "per-request",
"protocol": "socks5"
}'// endpoints
The surface area.
A small, focused set of resources. Everything you need to route traffic and observe it.
MethodPathDescription
GET/v1/proxiesList active proxy endpoints and pool assignments
POST/v1/proxiesProvision a new endpoint with rotation + geo rules
GET/v1/usageBandwidth, success rate and request counts by period
GET/v1/locationsAvailable countries, regions, cities and ASNs
// response
Predictable JSON.
Successful calls return 200 with a consistent envelope. Here is the body returned by GET /v1/proxies.
200 OK · application/json
{
"object": "list",
"data": [
{
"id": "px_8f12c0a7",
"pool": "residential",
"country": "US",
"city": "new-york",
"rotation": "per-request",
"protocol": "socks5",
"endpoint": "residential.vitesse.com:80",
"status": "online",
"latency_ms": 28
}
],
"has_more": false,
"request_id": "req_3a9d1e4b"
}