API Details (Mobile)

We have a full-featured API for our 5G Mobile Proxy Network.

Please note this is only for customers who have purchased multi-location proxies and have working access to portal.proxyguys.com. Single-Location customers do not have access to the API features.

Interested in our Python API developed by a 3rd party? View on PyPI

API Endpoints

Authenticate with the portal
Authentication relies on cookies/sessions


API URL	https://portal.proxyguys.com/login
Example	curl -c logincookie.txt --data 'username=MYUSERNAME&password=MYPASSWORD' https://portal.proxyguys.com/login curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/availability {"result": [{"id": "SAN", "location": "San Diego, CA", "available": 1}, {"id": "PHX", "location": "Phoenix, AZ", "available": 1}, {"id": "MKE", "location": "Milwaukee, WI", "available": 1}, {"id": "DFW", "location": "Dallas-Fort Worth, TX", "available": 1}, {"id": "NYC", "location": "New York, NY", "available": 1}, {"id": "CHI", "location": "Chicago, IL", "available": 0}, {"id": "SEA", "location": "Seattle, WA", "available": 0}, {"id": "MIA", "location": "Miami, FL", "available": 0}]}

List available proxies (Requires authentication)

Returns JSON object of available proxy licenses; if assigned/connected to a site will return username/password/IP/PORT to the proxy endpoint


API URL	https://portal.proxyguys.com/api/v2/proxies/list
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/list { "result": [ { "uuid": "ABCD", "name": "7E43-2018-06-03", "user": "ABCD", "location_id": null, "last_reset_timestamp": null, "ip": null, "port": null, "username": null, "password": null }, { "uuid": "ABCD", "name": "9CFB-2018-06-03", "user": "ABCD", "location_id": null, "last_reset_timestamp": null, "ip": null, "port": null, "username": null, "password": null }] }

List proxy site availability (Requires authentication)

Returns JSON of available sites; if available, the available element will have "1", otherwise set to "0"


API URL	https://portal.proxyguys.com/api/v2/proxies/availability
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/availability { "result": [ { "id": "SAN", "location": "San Diego, CA", "available": 1 }, { "id": "PHX", "location": "Phoenix, AZ", "available": 1 }, { "id": "MKE", "location": "Milwaukee, WI", "available": 1 }] }

Connect a proxy license. (Requires authentication)

Connects the corresponding proxy license using the assigned UUID to the respective geographic site


API URL	https://portal.proxyguys.com/api/v2/proxies/connect/proxy_license_uuid/location_from_list_available_sites
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/connect/proxy_license_uuid/location_from_list_available_sites {"result": {"uuid": "ABCD", "name": "7E43-2018-06-03", "user": "ABCD", "location_id": "SAN", "last_reset_timestamp": 1556114914.0, "ip": "199.188.89.205", "port": 8000, "username": "proxy", "password": "ABCD"}}

Hard reboot/reset a modem associated with a proxy. (Requires authentication)

Reboots the modem in cases of extreme failure; recovery takes approximately 40 seconds


API URL	https://portal.proxyguys.com/api/v2/proxies/hard_reset/proxy_license_uuid
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/hard_reset/proxy_license_uuid {"result": "CHANGED IP for [ABCD Customer - 7E43-2018-06-03] Sun Apr 28 20:10:07 2019, next IP change allowed at Sun Apr 28 20:10:37 2019 P10"}

Fast IP change. (Requires authentication)

Resets modem IP; recovery takes approximately 4 seconds


API URL	https://portal.proxyguys.com/api/v2/proxies/reset/proxy_license_uuid
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/reset/proxy_license_uuid {"result": "CHANGED IP for [ABCD Customer - 7E43-2018-06-03] Sun Apr 4 20:10:46 2019"}

Disconnect Proxy (Requires authentication)

Disconnects the proxy license from the current geographic location


API URL	https://portal.proxyguys.com/api/v2/proxies/disconnect/proxy_license_uuid
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/disconnect/proxy_license_uuid {"result": "Disconnected"}

Enable IP Whitelist. (Requires authentication)

Enables IP based authentication


API URL	https://portal.proxyguys.com/api/v2/proxies/enablewhitelist/proxy_license_uuid
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/enablewhitelist/proxy_license_uuid {"result": "Enabling whitelist, disconnecting any active proxy, please reconnect"}

Disable IP Whitelist (Requires authentication)

Disables IP based authentication


API URL	https://portal.proxyguys.com/api/v2/proxies/disablewhitelist/proxy_license_uuid
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/disablewhitelist/proxy_license_uuid {"result": "Disabling whitelist, disconnecting any active proxy, please reconnect"}

Set IP Whitelist. (Requires authentication)

Sets allowed IP prefix using CIDR notation


API URL	https://portal.proxyguys.com/api/v2/proxies/ipwhitelist/proxy_license_uuid/prefix_cidr
CIDR Example #1 1.2.3.4 (Single IP, AKA, /32)	1.2.3.4/32
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/ipwhitelist/proxy_license_uuid/1.2.3.4/32 {"result": "Whitelist OK"}
CIDR Example #2 1.2.3.0-1.2.3.255 (256 IPs, AKA, /24)	1.2.3.0/24
Example	curl -b logincookie.txt https://portal.proxyguys.com/api/v2/proxies/ipwhitelist/proxy_license_uuid/1.2.3.0/24 {"result": "Whitelist OK"}