EN|中文
mobileproxies.org
the organization
HomeAPI Documentation

Client API

RESTful API for managing your mobile proxies. Two endpoints: list proxies and rotate IPs.

v1.0.0OpenAPI 3.1|JSON|Base URL: /
MethodEndpointDescription
GET/api/v1/proxiesGet all proxies
POST/api/v1/proxies/{slotId}/switchIP Rotation

Authentication

All requests require a Bearer token in the Authorization header.

HeaderAuthorization: Bearer YOUR_API_KEY
GET/api/v1/proxies

Get all proxies

Returns a list of all available proxies.

Parameters

No parameters

Responses

200List of proxiesapplication/json
json
1[
2  {
3    "color: #22863a;">"type": "mobile_4g",
4    "color: #22863a;">"slot_id": "string",
5    "color: #22863a;">"hostname": "string",
6    "color: #22863a;">"http_port": 0,
7    "color: #22863a;">"socks5_port": 0,
8    "color: #22863a;">"username": "string",
9    "color: #22863a;">"password": "string",
10    "color: #22863a;">"country": "string",
11    "color: #22863a;">"region": "string",
12    "color: #22863a;">"carrier": "string",
13    "color: #22863a;">"ip": "string"
14  }
15]
Schema
typestringProxy type, e.g. "mobile_4g"
slot_idstringUnique modem slot identifier
hostnamestringProxy server hostname
http_portintegerHTTP/HTTPS proxy port
socks5_portintegerSOCKS5 proxy port
usernamestringProxy auth username
passwordstringProxy auth password
countrystringCountry code
regionstringRegion / city
carrierstringMobile carrier
ipstringCurrent public IP
204ProxiesController resourceapplication/ld+json
"string"
404Resource not found

Example

bash
1curl -X 500;">GET /api/v1/proxies \
2  -H "Authorization: 500;">Bearer YOUR_API_KEY" \
3  -H "Accept: application/json"
POST/api/v1/proxies/{slotId}/switch

IP Rotation

Triggers a hardware-level IP change for a specific modem slot.

Parameters

NameInTypeRequiredDescription
slotIdpathstringYesExample: 1990be3ebc4162a768c707b6ed730e27

Responses

204ProxiesController resource createdapplication/ld+json
"string"
400Invalid input
422Unprocessable entity

Example

bash
1curl -X 500;">POST /api/v1/proxies/1990be3ebc4162a768c707b6ed730e27/switch \
2  -H "Authorization: 500;">Bearer YOUR_API_KEY"

Quick Start

List your proxies, connect, and rotate IPs.

Python

python
1500;">import requests, time
2 
3API_KEY = "YOUR_API_KEY"
4BASE = "https:">//your-server"
5HEADERS = {"color: #22863a;">"Authorization": f"500;">Bearer {API_KEY}"}
6 
7"color: #6a737d;"># List all proxies
8proxies = requests.get(f"{BASE}/api/v1/proxies", headers=HEADERS).json()
9proxy = proxies[0]
10 
11"color: #6a737d;"># Connect through proxy
12proxy_url = f"http:">//{proxy['username']}:{proxy['password']}@{proxy['hostname']}:{proxy['http_port']}"
13r = requests.get("https:">//httpbin.org/ip", proxies={"color: #22863a;">"http": proxy_url, "color: #22863a;">"https": proxy_url})
14print(f"Current IP: {r.json()['origin']}")
15 
16"color: #6a737d;"># Rotate IP
17requests.post(f"{BASE}/api/v1/proxies/{proxy['slot_id']}/switch", headers=HEADERS)
18time.sleep(10)  "color: #6a737d;"># Wait 500;">for modem to reconnect
19print("IP rotated.")

Node.js

javascript
1500;">const axios = require('axios');
2 
3500;">const API_KEY = 'YOUR_API_KEY';
4500;">const BASE = 'https://your-server';
5500;">const headers = { Authorization: `500;">Bearer ${API_KEY}` };
6 
7"color: #6a737d;">// List all proxies
8500;">const { data: proxies } = 500;">await axios.get(`${BASE}/api/v1/proxies`, { headers });
9500;">const proxy = proxies[0];
10 
11"color: #6a737d;">// Connect through proxy
12500;">const { data } = 500;">await axios.get('https://httpbin.org/ip', {
13  proxy: { host: proxy.hostname, port: proxy.http_port,
14           auth: { username: proxy.username, password: proxy.password } }
15});
16console.log('Current IP:', data.origin);
17 
18"color: #6a737d;">// Rotate IP
19500;">await axios.post(`${BASE}/api/v1/proxies/${proxy.slot_id}/switch`, 500;">null, { headers });
20"color: #6a737d;">// Wait ~10s 500;">for modem reconnection

cURL

bash
1"color: #6a737d;"># List proxies
2curl -X 500;">GET /api/v1/proxies -H "Authorization: 500;">Bearer YOUR_API_KEY"
3 
4"color: #6a737d;"># Use proxy
5curl -x http:"color: #6a737d;">//user:pass@hostname:port https://httpbin.org/ip
6 
7"color: #6a737d;"># Rotate IP
8curl -X 500;">POST /api/v1/proxies/1990be3ebc4162a768c707b6ed730e27/switch \
9  -H "Authorization: 500;">Bearer YOUR_API_KEY"