List Servers
Retrieve a paginated list of all available VPN servers with filtering by country, continent, type, and capabilities.
List All VPN Servers
Retrieve a paginated list of all available VPN servers. This is a public endpoint that does not require authentication. Use query parameters to filter servers by location, type, and capabilities.
GET
/api/v1/serversList all available VPN servers with optional filtering
Authentication:No Auth Required
| Parameter | Type | Required | Description |
|---|---|---|---|
country | string | Optional | Filter by two-letter ISO country code (e.g., US, DE, JP) |
continent | string | Optional | Filter by continent: NA, SA, EU, AF, AS, OC |
type | string | Optional | Filter by server type (e.g., standard, premium, streaming) |
crypto_friendly | boolean | Optional | Filter for servers in crypto-friendly jurisdictions |
bridge_capable | boolean | Optional | Filter for servers that support bridge/obfuscation protocols |
latitude | number | Optional | Latitude for distance-based sorting (use with longitude) |
longitude | number | Optional | Longitude for distance-based sorting (use with latitude) |
page | integer | Optional | Page number for pagination (default: 1) |
per_page | integer | Optional | Results per page (default: 100, max: 100) |
Geo-Based Sorting
When you provide latitude and longitude parameters, the server list will be sorted by proximity to the given coordinates. This is useful for recommending the nearest server to a user.
# List all servers
curl -X GET "https://api.orbai.world/api/v1/servers"
# Filter by country and type
curl -X GET "https://api.orbai.world/api/v1/servers?country=US&type=premium&page=1&per_page=25"
# Find nearest servers by coordinates
curl -X GET "https://api.orbai.world/api/v1/servers?latitude=37.7749&longitude=-122.4194"200Server list retrieved successfully
{
"success": true,
"data": {
"servers": [
{
"id": 101,
"host_name": "us-nyc-01.orbvpn.com",
"public_ip": "203.0.113.10",
"type": "premium",
"city": "New York",
"country": "US",
"continent": "NA",
"crypto_friendly": true,
"bridge_capable": false,
"bridge_country": null,
"bridge_priority": 0,
"description": "Premium US East Coast server",
"hidden": false
},
{
"id": 102,
"host_name": "us-sfo-01.orbvpn.com",
"public_ip": "203.0.113.20",
"type": "premium",
"city": "San Francisco",
"country": "US",
"continent": "NA",
"crypto_friendly": true,
"bridge_capable": true,
"bridge_country": null,
"bridge_priority": 0,
"description": "Premium US West Coast server",
"hidden": false
}
],
"total": 150,
"page": 1,
"per_page": 25,
"total_pages": 6
}
}400Invalid query parameters
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid country code. Must be a valid ISO 3166-1 alpha-2 code."
}
}Public Endpoint
This endpoint does not require authentication. You can use it to display server locations to unauthenticated users, such as on a marketing page or server map.