API Documentation

Integrate ProxyUDP directly into your own applications, bots, and automation scripts using our robust REST API.

Quick Start

  1. Get your API Key from your Dashboard (API Access tab).
  2. Include your key in the Authorization header of every request:
    Authorization: Token YOUR_API_KEY
  3. Explore our interactive documentation to test endpoints directly from your browser.
Interactive API Reference (Swagger)

Authentication

We use standard Token-based authentication. Your token acts as a permanent API key. Keep it secret!

Rate Limiting

To ensure stability, we limit requests to 1,000 per hour for authenticated users. Action endpoints (like IP rotation) have separate limits.

Ordering

Buy a new proxy with POST /api/v1/orders/. The price is paid from your account balance. Poll the returned subscription until it is active, and send an Idempotency-Key header so retries never charge twice.

If your account has a personal discount, it is applied to API orders automatically. Any other promo code is then refused with invalid_promo.

Base URL

All v1 API requests should be sent to:

https://proxyudp.com/api/v1/

OS Fingerprint

After your proxy is active, check os_change_available and os_fingerprint_choices in its subscription details. Send POST /api/v1/subscriptions/{id}/change-os/ with an accepted os_type value to apply it to your proxy.

{"os_type": "windows:4"}

Send an empty string to disable fingerprinting. A successful response confirms that the proxy server applied the settings. If the modem is busy, retry after the Retry-After interval.

Proxy Refresh

Check refresh_available before calling POST /api/v1/subscriptions/{id}/refresh/. To refresh all eligible proxies, use POST /api/v1/subscriptions/refresh-all/. Individual actions allow 10 requests per hour; bulk actions allow 6 requests per hour per account.

JSON Format

Our API returns data in JSON format and expects JSON for POST/PATCH request bodies.


Need help with integration? Contact our support team.