Public API

Manage your account programmatically over a REST API. You can whitelist your servers, export proxy lists, pull usage stats, and manage subscriptions. All requests authenticate with an API key and return JSON.

API key vs. proxy credentials. The API key authenticates the REST API described on this page. It is not how you connect to the proxies. Proxy connections use a username and password or an IP whitelist. See Authentication for the difference.

Base URL

All Public API endpoints live under a single base URL:

https://proxyomega.com/api

Responses are returned as application/json.

Authentication

Every request must include your API key in the X-API-Key header. You can generate and view your key in the dashboard. Treat the key like a password, because anyone who has it can manage your account.

curl -H "X-API-Key: YOUR_KEY" \
  https://proxyomega.com/api/whitelist

Illustrative path. The /api/whitelist path above is shown only to demonstrate the base URL and the auth header. Check your dashboard for the exact endpoints available on your account.

Keep your key secret. Send the key over HTTPS only, and never commit it to source control or expose it in client-side code. If a key is compromised, rotate it in the dashboard.

Capabilities

The Public API covers four main areas. Each returns JSON and uses the same base URL and X-API-Key header shown above.

Whitelist management

Add, remove, and list the IP addresses allowed to connect credential-free. This keeps your allowlist in sync as your servers change.

Proxy-list export

Generate and export ready-to-use proxy lists, including the targeting-aware username strings for your active plans.

Usage & bandwidth stats

Pull your usage and bandwidth figures so you can monitor consumption and build your own reporting.

Subscription management

Inspect and manage your subscriptions programmatically alongside the dashboard.

Capability summary

Area	What you can do
Whitelist management	Add IPs, remove IPs, list current whitelist entries
Proxy-list export	Generate and export proxy lists for your active plans
Usage & bandwidth stats	Retrieve usage and bandwidth consumption data
Subscription management	View and manage your subscriptions

Responses

All endpoints return JSON. A successful response typically looks like this:

{
  "success": true,
  "data": { }
}

Parse the response as JSON and check the top-level status before reading the payload. If your request is missing or has an invalid X-API-Key, the API responds with an authentication error rather than the data you requested.

Looking for sub-accounts?

If you resell proxies and need to provision sub-accounts, provision subscriptions on behalf of others, and pull per-account analytics, use the separate Reseller API. It has its own base URL and uses a bearer token instead of the X-API-Key header, and it requires an approved reseller account.

Next steps. Read Authentication to understand all three ways to authenticate, then explore Targeting to build the exact username strings the proxy-list export produces.

Last updated 6 July 2026