XProxy Official
  1. Selling Platform
XProxy Official
  • API document for XProxy service
  • Proxy Management
    • Get the list of devices & proxies information
      GET
    • Get status of a specific proxy
      GET
    • Get status of a specific position
      GET
    • Reboot dongle with specific proxy
      GET
    • Reboot dongle with specific position
      GET
  • Device Management
    • Change IMEI for multiple dongles
      POST
    • Add or change device note
      POST
    • Change MAC address for dongles
      POST
    • Change APN for dongles
      POST
    • Change device label
      POST
    • Connect dongle to network
      POST
    • Enable/disable WiFi for multiple dongles
      POST
    • Disconnect dongle from network
      POST
    • Reboot a specific dongle
      POST
    • Reset bus dongle
      POST
    • Get dongle information including phone number
      POST
    • Set MTU value for a dongle
      POST
  • Rotation (Change IP)
    • Manual rotation :: Rotate IP for a specific proxy or SOCKS port
      GET
    • Manual rotation :: Rotate IP for a specific position of modem in list
      GET
    • Auto rotation :: Add a rotation schedule job
      POST
    • Auto rotation :: Retrieve scheduled rotation jobs
      POST
  • Selling Platform
    • Get list of selling proxies
      GET
    • Generate selling proxies
      POST
    • Editing for single selling proxy port
      POST
    • Delete selling proxy by ID
      POST
  • SMS & USSD Utitlies
    • SMS
      • Read SMS messages
      • Send SMS message
      • Delete SMS messages
    • USSD
      • Send USSD command
      • Read USSD response
  • System Management
    • Restart XProxy Panel
    • Reboot XProxy System
  1. Selling Platform

Get list of selling proxies

GET
{{BASE_URL}}/selling/shared_proxies

Request

Query Params
page
integer 
optional
Page number
Default:
1
limit
integer 
optional
Number of items per page
Default:
20
modemPosition
integer 
optional
Filter by modem position
id
integer 
optional
Filter by proxy ID
proxyPort
integer 
optional
Filter by proxy port
sharedStatus
enum<string> 
optional
Filter by shared status
Allowed values:
enableddisabled
rentStatus
enum<string> 
optional
Filter by rent status (expired time or in-used)
Allowed values:
expiredin_used
nextDayExpired
number 
optional
Filter by days until expiration
memo
string 
optional
Filter by memo text

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http://localhost/selling/shared_proxies?page=&limit=&modemPosition=&id=&proxyPort=&sharedStatus=&rentStatus=&nextDayExpired=&memo'

Responses

🟢200OK
application/json
List of shared proxies
Body
status
boolean 
optional
data
array [object {36}] 
optional
id
integer 
optional
Unique identifier of the shared proxy
shared_port
integer 
optional
Port number of the shared proxy
enabled
boolean 
optional
Whether the proxy is enabled
ip_type
enum<string> 
optional
IP type of the proxy. (1=IPv4, 2=IPv6, 3=IPv64, 4=IPv46)
Allowed values:
IPv4IPv6IPv64IPv46
gen_method
enum<number> 
optional
Identify selling proxy made by method: 1-Single Destination, 2-Proxy Group
Allowed values:
12
position
integer 
optional
For single destination proxy using, the current modem position number. This is 0 if gen_method=2
group_positions
array[integer]
optional
For proxy groups using, array of modem positions. This is empty if gen_method=1
port_type
enum<string> 
optional
Port type of the proxy. (0=PROXY, 1=HTTP, 2=SocksV5)
Allowed values:
PROXYHTTPSocksV5
auth_ip_list
string 
optional
Comma-separated list of authorized IPs
auth_user_list
string 
optional
Comma-separated list of authorized users in format user:password
web_whitelist
string 
optional
Comma-separated whitelist domains
web_blacklist
string 
optional
Comma-separated blacklist domains
expired_at_unix
integer 
optional
Expiration epoch timestamp in milliseconds (ref at: https://currentmillis.com)
custom_dns
string 
optional
Custom DNS server for the proxy
bw_limit_enabled
boolean 
optional
Whether bandwidth limiting is enabled
bw_limit_rate
integer 
optional
Bandwidth limit rate in Mbps
counter_dl_limit
enum<string> 
optional
Download limit mode (0=unlimited, 1=limited)
Allowed values:
unlimitedlimited
counter_dl_limit_by
enum<string> 
optional
Download limit period (1=DAILY, 2=WEEKLY, 3=MONTHLY, 4=END_QUOTA)
Allowed values:
DAILYWEEKLYMONTHLYEND_QUOTA
counter_dl_quota
integer 
optional
Download quota in MB
counter_ul_limit
enum<string> 
optional
Upload limit mode (0=unlimited, 1=limited)
Allowed values:
unlimitedlimited
counter_ul_limit_by
enum<string> 
optional
Upload limit period (1=DAILY, 2=WEEKLY, 3=MONTHLY, 4=END_QUOTA)
Allowed values:
DAILYWEEKLYMONTHLYEND_QUOTA
counter_ul_quota
integer 
optional
Upload quota in MB
counter_all_limit
enum<string> 
optional
Combined traffic limit mode (0=unlimited, 1=limited)
Allowed values:
unlimitedlimited
counter_all_limit_by
enum<string> 
optional
Combined traffic limit period (1=DAILY, 2=WEEKLY, 3=MONTHLY, 4=END_QUOTA)
Allowed values:
DAILYWEEKLYMONTHLYEND_QUOTA
counter_all_quota
integer 
optional
Total bandwidth quota in MB
max_connection
integer 
optional
Maximum number of connections allowed
max_connection_period
integer 
optional
Period in seconds for maximum connection count
Default:
60
tcp_os
string 
optional
TCP/IP OS fingerprint to emulate. (valid of profiles can check at API get list of TCP/IP OS fingerprint supported)
force_server_resolve_dns
boolean 
optional
Force server-side DNS resolution applied for socks5 proxy (customer need use socks5h to work, this option useful to prevent them bypass whitelist/blacklist entries
allow_api_change_rotation
boolean 
optional
Allow changing IP scheduling rotation interval via API
min_interval_rotation
integer 
optional
Minimum allowed for customer change scheduling rotation interval via API in seconds
interval_rotation
integer 
optional
Default IP scheduling rotation interval in seconds (0 for no rotation)
allow_api_rotate
boolean 
optional
Allow customer manual rotation via API
min_second_rotate
integer 
optional
Minimum seconds between API call to manual rotation executed by customers
last_rotation
integer 
optional
Unix timestamp of last rotation
memo
string 
optional
Memo text for the proxy
total
integer 
optional
Total number of proxies matching filters
Example
{
  "data": [
    {
      "id": 203,
      "position": 1,
      "shared_port": 53275,
      "port_type": "PROXY",
      "ip_type": "IPv4",
      "auth_ip_list": "125.12.30.67,125.12.30.68",
      "auth_user_list": "NTD89KDC:NTD89KDC",
      "web_blacklist": "*google.com*,*.google.com*",
      "web_whitelist": "*facebook.com*,*.facebook.com*",
      "expired_at": "11/04/2025 11:14 GMT+7",
      "counter_dl_limit": "limited",
      "counter_dl_limit_by": "END_QUOTA",
      "counter_dl_quota": 70000,
      "counter_dl_bytes": 0,
      "counter_dl_updated_time": 0,
      "counter_dl_reset_time": 0,
      "counter_ul_limit": "limited",
      "counter_ul_limit_by": "END_QUOTA",
      "counter_ul_quota": 70000,
      "counter_ul_bytes": 0,
      "counter_ul_updated_time": 0,
      "counter_ul_reset_time": 0,
      "bw_limit_enabled": true,
      "bw_limit_rate": 60,
      "memo": "Tom - 1 month",
      "created_at": "12/03/2025 11:15 GMT+7",
      "custom_dns": "1.1.1.1 8.8.8.8",
      "counter_all_limit": "limited",
      "counter_all_limit_by": "MONTHLY",
      "counter_all_quota": 6000,
      "counter_all_bytes": 0,
      "counter_all_updated_time": 0,
      "counter_all_reset_time": 1741752958,
      "connection_limit": 200,
      "connection_limit_period": 60,
      "api_token": "8ad06debc32b42a9a95956379845ba76",
      "force_server_resolve_dns": false,
      "interval_rotation": 0,
      "last_rotation": null,
      "last_rotation_status": false,
      "allow_api_change_rotation": true,
      "allow_api_rotate": true,
      "min_interval_rotation": 120,
      "min_second_rotate": 60,
      "enabled": true,
      "tcp_os": "win1",
      "gen_method": 1,
      "group_positions": [],
      "auth_ip_enabled": true,
      "auth_user_enabled": true,
      "web_blacklist_enabled": true,
      "web_whitelist_enabled": true,
      "expired_at_unix": 1744344853000,
      "remaining": 29.9,
      "remaining_str": "29d, 20hr, 42min",
      "counter_dl_limit_quota": 70000,
      "counter_dl_used_bytes": 0,
      "counter_dl_used_mb": 0,
      "counter_dl_updated": null,
      "counter_dl_reset": null,
      "counter_ul_limit_quota": 70000,
      "counter_ul_used_bytes": 0,
      "counter_ul_used_mb": 0,
      "counter_ul_updated": null,
      "counter_ul_reset": null,
      "counter_all_limit_quota": 6000,
      "counter_all_used_bytes": 0,
      "counter_all_used_mb": 0,
      "counter_all_updated": null,
      "counter_all_reset": "12/03 04:15:58",
      "physical_port_status": "active"
    },
    {
      "id": 204,
      "position": 0,
      "shared_port": 23182,
      "port_type": "PROXY",
      "ip_type": "IPv4",
      "auth_ip_list": "",
      "auth_user_list": "9CAA2JHS:9CAA2JHS",
      "web_blacklist": "",
      "web_whitelist": "",
      "expired_at": "25/04/2025 14:18 GMT+7",
      "counter_dl_limit": "unlimited",
      "counter_dl_limit_by": "DAILY",
      "counter_dl_quota": 100,
      "counter_dl_bytes": 0,
      "counter_dl_updated_time": 0,
      "counter_dl_reset_time": 0,
      "counter_ul_limit": "unlimited",
      "counter_ul_limit_by": "DAILY",
      "counter_ul_quota": 100,
      "counter_ul_bytes": 0,
      "counter_ul_updated_time": 0,
      "counter_ul_reset_time": 0,
      "bw_limit_enabled": false,
      "bw_limit_rate": 0,
      "memo": "",
      "created_at": "12/03/2025 13:02 GMT+7",
      "custom_dns": "",
      "counter_all_limit": "unlimited",
      "counter_all_limit_by": "DAILY",
      "counter_all_quota": 100,
      "counter_all_bytes": 0,
      "counter_all_updated_time": 0,
      "counter_all_reset_time": 0,
      "connection_limit": 200,
      "connection_limit_period": 60,
      "api_token": "d478ecbfaf87482e9106f29aa9486c3c",
      "force_server_resolve_dns": false,
      "interval_rotation": 0,
      "last_rotation": null,
      "last_rotation_status": false,
      "allow_api_change_rotation": false,
      "allow_api_rotate": false,
      "min_interval_rotation": 30,
      "min_second_rotate": 30,
      "enabled": true,
      "tcp_os": "linux",
      "gen_method": 2,
      "group_positions": [
        1,
        2
      ],
      "auth_ip_enabled": false,
      "auth_user_enabled": true,
      "web_blacklist_enabled": false,
      "web_whitelist_enabled": false,
      "expired_at_unix": 1745565495000,
      "remaining": 44,
      "remaining_str": "1mo, 13d, 23hr, 46min",
      "counter_dl_limit_quota": 100,
      "counter_dl_used_bytes": 0,
      "counter_dl_used_mb": 0,
      "counter_dl_updated": null,
      "counter_dl_reset": null,
      "counter_ul_limit_quota": 100,
      "counter_ul_used_bytes": 0,
      "counter_ul_used_mb": 0,
      "counter_ul_updated": null,
      "counter_ul_reset": null,
      "counter_all_limit_quota": 100,
      "counter_all_used_bytes": 0,
      "counter_all_used_mb": 0,
      "counter_all_updated": null,
      "counter_all_reset": null,
      "physical_port_status": "active"
    }
  ],
  "total": 2,
  "status": true
}
Modified at 2025-03-12 07:43:11
Previous
Auto rotation :: Retrieve scheduled rotation jobs
Next
Generate selling proxies
Built with