Login
Sign Up
HighProxies Developer API

HighProxies API Documentation

Integrate HighProxies proxy management into your applications and internal tools. Use the REST API to retrieve account data and proxy assignments, manage authorized IP addresses, switch authentication modes and review update history.

Start with the API Open Swagger UI
REST and JSON API version 1.2.2 X-API-KEY authentication
Quick start

Authenticate a HighProxies API request

Client API routes require your HighProxies API key. Add the key to the X-API-KEY request header. The public root and health routes do not require authentication.

Request header

X-API-KEY: YOUR_API_KEY
Accept: application/json

Replace YOUR_API_KEY with the key shown in your HighProxies client account.

First authenticated request

curl --request GET \
  --url "https://api.highproxies.com/client/v1/account/get-info" \
  --header "Accept: application/json" \
  --header "X-API-KEY: YOUR_API_KEY"

A valid request returns JSON with HTTP status 200.

API key location: Sign in to the HighProxies Client Area and copy the API key from your proxy management area. Treat the key like a password.

Reference

HighProxies API endpoint summary

Use the versioned /client/v1 routes for new integrations. Legacy routes remain available for existing scripts.

Method Endpoint Purpose API key
GET /health Check API, database and Redis availability. No
GET /client/v1/account/get-info Retrieve account information. Yes
GET /client/v1/white-list/get-list List authorized IP addresses by service. Yes
GET /client/v1/proxies/list List assigned proxies and authentication data. Yes
POST /client/v1/proxies/update-ips Replace the authorized IP list for one service. Yes
POST /client/v1/proxies/switch-auth Switch between username/password and IP authentication. Yes
GET /client/v1/proxies/history Review previous authorized-IP updates. Yes
Public endpoint

Check HighProxies API health

GET https://api.highproxies.com/health

cURL request

curl --request GET \
  --url "https://api.highproxies.com/health" \
  --header "Accept: application/json"

HTTP 200 response

{
  "status": "ok",
  "checks": {
    "database": "up",
    "redis": "up"
  }
}
Client V1

Retrieve account information

Use this endpoint to retrieve the account record associated with the supplied API key.

GET https://api.highproxies.com/client/v1/account/get-info

cURL request

curl --request GET \
  --url "https://api.highproxies.com/client/v1/account/get-info" \
  --header "Accept: application/json" \
  --header "X-API-KEY: YOUR_API_KEY"

Example response

{
  "account": {
    "id": 12345,
    "firstname": "Jane",
    "lastname": "Doe",
    "email": "jane.doe@example.com",
    "status": "Active",
    "credit": 25.50,
    "currency": 1
  }
}

The values above are illustrative. Your response contains the information associated with your account.

IP authentication

List and update authorized IP addresses

Retrieve the IP authorization list for your proxy services or replace the list for a specified service. An update request accepts between 1 and 10 IP address strings.

List authorized IPs

/client/v1/white-list/get-list

curl --request GET \
  --url "https://api.highproxies.com/client/v1/white-list/get-list" \
  --header "Accept: application/json" \
  --header "X-API-KEY: YOUR_API_KEY"

Example response

{
  "total_services": 1,
  "whitelists": [
    {
      "service_id": 12345,
      "authorized_ips": [
        "192.0.2.10",
        "198.51.100.20"
      ]
    }
  ]
}

Replace authorized IPs

/client/v1/proxies/update-ips

curl --request POST \
  --url "https://api.highproxies.com/client/v1/proxies/update-ips" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --header "X-API-KEY: YOUR_API_KEY" \
  --data '{
    "service_id": 12345,
    "ips": [
      "192.0.2.10",
      "198.51.100.20"
    ]
  }'

Required request body

  • service_id: integer service identifier.
  • ips: array containing 1 to 10 IP address strings.

This operation replaces the submitted service’s authorized IP list. Include every IP address that should remain authorized, not only newly added addresses.

Proxy inventory

Retrieve assigned proxies

Retrieve the proxy endpoints associated with your account. Depending on the active authentication mode, the response can include a proxy IP address, port and username/password credentials.

GET https://api.highproxies.com/client/v1/proxies/list

cURL request

curl --request GET \
  --url "https://api.highproxies.com/client/v1/proxies/list" \
  --header "Accept: application/json" \
  --header "X-API-KEY: YOUR_API_KEY"

Example response

{
  "total": 1,
  "proxies": [
    {
      "proxy_id": 67890,
      "proxy_ip": "192.0.2.100",
      "proxy_port": 21234,
      "auth_mode": "user_pass",
      "user": "example_user",
      "pass": "example_password"
    }
  ]
}

Example IP addresses and credentials are placeholders and will not connect to a proxy.

Authentication

Switch the proxy authentication mode

Switch supported proxy services between username/password authentication and IP authentication. The request accepts only user_pass or ip_auth.

POST https://api.highproxies.com/client/v1/proxies/switch-auth

Switch to IP authentication

curl --request POST \
  --url "https://api.highproxies.com/client/v1/proxies/switch-auth" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --header "X-API-KEY: YOUR_API_KEY" \
  --data '{"mode":"ip_auth"}'

Switch to username/password authentication

{
  "mode": "user_pass"
}

When using ip_auth, configure the required public IP addresses through the authorized-IP endpoint before attempting to connect.

Change history

Review authorized-IP update history

Use the history endpoint to review recorded changes to proxy service IP authorization settings.

GET https://api.highproxies.com/client/v1/proxies/history

cURL request

curl --request GET \
  --url "https://api.highproxies.com/client/v1/proxies/history" \
  --header "Accept: application/json" \
  --header "X-API-KEY: YOUR_API_KEY"

Example response

{
  "history": [
    {
      "service_id": 12345,
      "old_ips": "192.0.2.10",
      "new_ips": "198.51.100.20",
      "timestamp": "2026-07-19T14:30:12"
    }
  ]
}
HTTP responses

Success, authentication and validation responses

Status Meaning Recommended action
200 The request completed successfully. Parse the returned JSON.
401 The API key is missing or was not accepted. Check the X-API-KEY header and key value.
422 The POST request body failed validation. Check required fields, allowed values and the IP array size.

Missing API key

{
  "detail": "Not authenticated"
}

Validation error format

{
  "detail": [
    {
      "loc": ["body", "mode"],
      "msg": "String should match pattern",
      "type": "string_pattern_mismatch"
    }
  ]
}
Backward compatibility

Legacy HighProxies API endpoints

Existing integrations can continue using the legacy routes below. Build new integrations with the versioned /client/v1 routes.

Method Legacy route Versioned replacement
GET /proxies /client/v1/proxies/list
POST /switch-auth /client/v1/proxies/switch-auth
POST /update-ips /client/v1/proxies/update-ips
GET /history /client/v1/proxies/history
Interactive API reference

Explore the live HighProxies API schema

Use Swagger UI to inspect routes and submit test requests, or open ReDoc for a clean, searchable view of the OpenAPI reference.

Open Swagger UI Open ReDoc
API FAQ

HighProxies API questions

Practical answers for developers integrating proxy management into applications and automation workflows.

What can I manage with the HighProxies API?

You can retrieve account information and assigned proxies, list or replace authorized IP addresses, switch supported proxy authentication modes and review IP update history.

How do I authenticate API requests?

Pass your API key in the X-API-KEY HTTP header. Do not send it as a URL query parameter or expose it in public browser code.

How many authorized IPs can I submit?

The update endpoint accepts an array containing at least 1 and no more than 10 IP address strings for the specified service.

Which authentication modes are supported?

The authentication switch endpoint accepts user_pass for username/password authentication or ip_auth for source-IP authentication.

Should new integrations use legacy routes?

No. Legacy routes are retained for existing automation. New integrations should use the versioned /client/v1 endpoints.

Where can I get integration support?

Open a ticket through the HighProxies contact page. Never include your full API key in a support ticket.