API
API endpoint reference
Every endpoint an API key can call, with the permission it needs. Addresses are relative to https://proxya.co/api/v1.
Updated 22 November 2026
Where two permissions are listed, either of them is enough. Any other endpoint of the site refuses API keys.
| Method | Path | Permission | Purpose |
|---|---|---|---|
| GET | /users/me | read | Account: email, balance, total spent |
| GET | /transactions | read | Balance history |
| GET | /pricing/me | read | The account's price list |
| GET | /catalog/availability | read | Stock by location |
| GET | /catalog/spoofing-profiles | read | OS fingerprint profiles |
| GET | /catalog/residential/countries | read | Residential countries |
| GET | /catalog/residential/cities | read | Residential cities of a country |
| GET | /catalog/residential/providers | read | Residential providers of a country |
| GET | /catalog/residential/pro/countries | read | Residential Pro countries |
| GET | /catalog/residential/pro/cities | read | Residential Pro cities of a country |
| POST | /orders/quote | read, purchase | Price of a new order, nothing is bought |
| POST | /orders | purchase | Buy |
| GET | /orders | read | List of orders |
| GET | /orders/{id} | read, credentials, purchase | Order with proxies and renewal prices |
| POST | /orders/{id}/extend | purchase | Renew |
| POST | /orders/{id}/restore | purchase | Restore a terminated order |
| PATCH | /orders/{id}/note | manage | Order note |
| POST | /orders/{id}/change-password | manage | New proxy password |
| GET | /orders/{id}/whitelist | read | IP whitelist |
| POST | /orders/{id}/whitelist | credentials | Add an IP to the whitelist |
| DELETE | /orders/{id}/whitelist | manage, credentials | Remove an IP from the whitelist |
| GET | /orders/{id}/fingerprint | read | OS fingerprint state |
| POST | /orders/{id}/fingerprint | manage | Turn OS fingerprint on |
| DELETE | /orders/{id}/fingerprint | manage | Turn OS fingerprint off |
| GET | /residential/status | read | Residential traffic balance |
| POST | /residential/generate | credentials | Generate residential proxies |
| GET | /residential/ports | read | Residential ports |
| GET | /residential/entry-hosts | read | Residential entry points |
| GET | /residential/usage | read | Traffic by day and by site |
| GET | /mobile/orders/{id} | read | Mobile device state |
| GET | /mobile/orders/{id}/ip-history | read | Mobile IP history |
| POST | /mobile/orders/{id}/rotate-ip | manage | New mobile IP now |
| POST | /mobile/orders/{id}/rotation | manage | Automatic IP change timer |
| POST | /mobile/orders/{id}/os | manage | Mobile OS fingerprint |
| POST | /mobile/orders/{id}/ip-mode | manage | IPv4 or IPv6 |
| POST | /mobile/orders/{id}/auth | credentials | Password or IP authorisation |
| GET | /mobile/orders/{id}/openvpn | credentials | OpenVPN config |
| GET | /mobile/orders/{id}/wireguard | credentials | WireGuard config |
GET /mobile/locations needs no key. Keys are made, listed and revoked only in the dashboard.
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.