API
Managing proxies through the API
Proxy password, IP whitelist, OS fingerprint, residential proxy generation and mobile devices through the API, with the permission each action needs.
Updated 22 November 2026
New proxy password#
POST /orders/{id}/change-password issues a new password for every proxy of the order. The old one stops working. Needs the manage permission. The answer is the order: the new password is in it only for a key that also has credentials.
curl -X POST https://proxya.co/api/v1/orders/$ORDER_ID/change-password \
-H "Authorization: Bearer $PROXYA_API_KEY"IP whitelist#
Addresses on the whitelist connect to ISP and datacenter proxies with no password. Adding an address needs the credentials permission, removing one needs manage or credentials. How the whitelist behaves is on IP whitelist.
# Add an address (credentials permission)
curl -X POST https://proxya.co/api/v1/orders/$ORDER_ID/whitelist \
-H "Authorization: Bearer $PROXYA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ip": "203.0.113.10"}'
# Remove one address. Without ?ip= every address is removed.
curl -X DELETE "https://proxya.co/api/v1/orders/$ORDER_ID/whitelist?ip=203.0.113.10" \
-H "Authorization: Bearer $PROXYA_API_KEY"OS fingerprint#
GET, POST and DELETE /orders/{id}/fingerprint read, set and turn off OS fingerprint spoofing on ISP and datacenter orders. Setting it needs manage. Spoofing does not work while the whitelist has addresses, see OS fingerprint.
# Profiles that can be set
curl https://proxya.co/api/v1/catalog/spoofing-profiles -H "Authorization: Bearer $PROXYA_API_KEY"
# Turn spoofing on with one of them
curl -X POST https://proxya.co/api/v1/orders/$ORDER_ID/fingerprint \
-H "Authorization: Bearer $PROXYA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"profile": "windows"}'
# Turn it off
curl -X DELETE https://proxya.co/api/v1/orders/$ORDER_ID/fingerprint -H "Authorization: Bearer $PROXYA_API_KEY"Residential#
| Request | Permission | Returns |
|---|---|---|
| GET /residential/status | read | Traffic left and used, in GB. ?tier=pro for Residential Pro. |
| POST /residential/generate | credentials | Proxy lines from the traffic balance. Generating spends no money, traffic is counted when the proxies are used. |
| GET /residential/ports | read | HTTP, SOCKS5 and shared ports of the tier. |
| GET /residential/entry-hosts | read | Entry points of the tier. |
| GET /residential/usage | read | Traffic by day and by site. days from 1 to 90. |
curl -X POST https://proxya.co/api/v1/residential/generate \
-H "Authorization: Bearer $PROXYA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"count": 10, "country": "us", "session": "sticky", "ttl": 30, "protocol": "http"}'| Field of generate | Value |
|---|---|
| count | 1 to 500 lines |
| country | any or a country code, such as us |
| city | Optional city |
| session | rotating or sticky |
| ttl | Sticky session lifetime, 1 to 10080 minutes |
| protocol | http or socks5 |
| tier | pro for Residential Pro, omitted for the standard tier |
The lines use the same format as the generator in the dashboard, described on Generator.
Mobile devices#
# New IP now
curl -X POST https://proxya.co/api/v1/mobile/orders/$ORDER_ID/rotate-ip \
-H "Authorization: Bearer $PROXYA_API_KEY"
# New IP every 10 minutes (0 turns the timer off)
curl -X POST https://proxya.co/api/v1/mobile/orders/$ORDER_ID/rotation \
-H "Authorization: Bearer $PROXYA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"minutes": 10}'| Request | Permission | Body |
|---|---|---|
| GET /mobile/orders/{id} | read | Device state: IP, ports, traffic, settings |
| GET /mobile/orders/{id}/ip-history | read | offset, count up to 100 |
| POST /mobile/orders/{id}/rotate-ip | manage | No body. The device's own minimum interval applies |
| POST /mobile/orders/{id}/rotation | manage | minutes from 0 to 1440. 0 changes the IP only on request |
| POST /mobile/orders/{id}/os | manage | family: windows, android, ios, macos or empty to turn off |
| POST /mobile/orders/{id}/ip-mode | manage | mode: v4 or v6 |
| POST /mobile/orders/{id}/auth | credentials | mode: credentials or ip, and ips, up to 10 addresses |
| GET /mobile/orders/{id}/openvpn | credentials | OpenVPN config file |
| GET /mobile/orders/{id}/wireguard | credentials | WireGuard config file |
Without the credentials permission the device state comes back without the username and the VLESS link.
Didn't find the answer?
Support answers in the chat on this site around the clock. On Telegram the reply usually comes fastest, and a ticket gets an answer by email.