API Documentation
Complete API documentation for GetFreeProxy services. Learn how to authenticate, access endpoints, handle errors, and integrate with our platform.
Introduction
Welcome to the GetFreeProxy API documentation. Our REST API provides programmatic access to proxy data, testing services, and management tools. Get started by exploring the endpoints and examples below.
Base URL
https://api.getfreeproxy.com
Authentication
The API uses Bearer token authentication. Include your API key in the Authorization header to authenticate all requests.
Example Request
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.getfreeproxy.com/v1/proxiesAPI Endpoints
Retrieve a list of available proxies with optional filtering by country, protocol, and other parameters.
Response Fields
Example Response
[
{
"id": "lqc7x6",
"https": true,
"google": true,
"protocol": "vless",
"ip": "638953873686412975.lahijan-drc-tusaas.info",
"port": 8880,
"user": "df0680ca-e43c-498d-ed86-8e196eedd012",
"passwd": "",
"countryCode": "GB",
"region": "England",
"asnNumber": "44477",
"asnName": "44477",
"anonymity": "HIA",
"uptime": 97,
"responseTime": 0.670612261,
"lastAliveAt": "2025-10-30T01:45:55.902957828Z",
"proxyUrl": "vless://df0680ca-e43c-498d-ed86-8e196eedd012@638953873686412975.lahijan-drc-tusaas.info:8880?mode=gun&security=none&encryption=none&type=grpc#https:%2F%2Ft.me%2FForceRunVPN-%F0%9F%87%AC%F0%9F%87%A7-Belfast-980ms-PQ%20HOSTING%20PLUS%20S.R.L."
}
]Rate Limiting
All API requests are rate limited based on your subscription plan to ensure fair usage and system stability. Rate limits are enforced on a per-month basis.
Basic
Free forever
Plus
For growing projects
Preferred
PopularMost popular choice
Professional
For high-volume applications
Rate Limit Headers
Every API response includes headers that indicate your current rate limit status:
Error Handling
The API uses conventional HTTP response codes to indicate success or failure of an API request.
Error Response Format
{
"error": "INVALID_PARAMETER"
}Rate Limit Error Example (429)
{
"error": "RATE_LIMIT_EXCEEDED"
}Ready to get started?
Start integrating GetFreeProxy into your application with our comprehensive API and detailed documentation.