API Reference

REST API Reference

Manage proxy zones, view usage stats, and control IP rotation programmatically. Base URL: https://api.Iphtml.io/v2

Authentication

All API requests are authenticated using your API key passed as a Bearer token in the Authorization header.

HTTP Header

Authorization: Bearer YOUR_API_KEY

Find your API key in the Dashboard under the API section.

Rate Limits

The Management API is limited to 60 requests per minute. Exceeding the limit returns HTTP 429.

Endpoint Type	Limit	Window
Standard	60 req	1 min
Traffic Logs	10 req	1 min
Balance Check	30 req	1 min

Error Codes

Status	Description
200	OK — Success
400	Bad Request — invalid parameters
401	Unauthorized — invalid or missing API key
404	Not Found — resource does not exist
429	Too Many Requests — rate limit exceeded
500	Internal Server Error — contact support

Get Proxy Credentials

GET /v2/proxy/credentials

Returns your proxy username, password, and all available endpoints for your account.

Response Example

200 OK — application/json

{
  "username":  "user_a1b2c3",
  "password":  "s3cr3tpass",
  "endpoints": {
    "residential_http":  "server.iphtml.biz:15000",
    "residential_socks5": "server.iphtml.biz:15001",
    "datacenter_http":   "stc.iphtml.biz:15000",
    "mobile_http":       "stc.iphtml.biz:15001",
    "static_http":       "stc.iphtml.io:15000"
  }
}

List Available Countries

GET /v2/proxy/countries

Returns all countries available for geo-targeting, including ISO codes and available IP counts.

Response Example

200 OK

{
  "countries": [
    { "code": "US", "name": "United States", "ip_count": 15200000 },
    { "code": "GB", "name": "United Kingdom", "ip_count": 3100000  },
    { "code": "DE", "name": "Germany",        "ip_count": 2500000  }
    // ... 220+ total
  ],
  "total": 224
}

Usage Statistics

GET /v2/account/usage

Returns account traffic usage, balance, and request statistics.

Query Parameters

Parameter	Type	Required	Description
from	string	optional	Start date YYYY-MM-DD
to	string	optional	End date YYYY-MM-DD
proxy_type	string	optional	residential \| datacenter \| mobile \| static

200 OK

{
  "balance_gb":    42.5,
  "used_gb":       7.5,
  "total_requests": 148320,
  "success_rate":  97.3,
  "period": {
    "from": "2025-01-01",
    "to":   "2025-01-31"
  }
}