Country, region, city and ISP options
GET
/account/api/v1/residential/locationsAuthorization
| Authorization | Bearer YOUR_ARNPROXY_API_KEY |
|---|---|
| Required permission | read |
| Accept | application/json |
Parameters
| Name | Type | Description |
|---|---|---|
level | string | countries, regions, cities or isps; parent selections are required at deeper levels. Default: "countries" |
country | string | countries: no descendants; regions: country; cities: country+region; isps: country+region+city. Region/city at most 160 bytes. |
region | string | countries: no descendants; regions: country; cities: country+region; isps: country+region+city. Region/city at most 160 bytes. |
city | string | countries: no descendants; regions: country; cities: country+region; isps: country+region+city. Region/city at most 160 bytes. |
Request example
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
curl --silent --show-error --header @- \
--header 'Accept: application/json' \
--connect-timeout 10 --max-time 30 \
'https://www.arnproxy.com/account/api/v1/residential/locations?level=countries'Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.
{"curl":"printf \u0027Authorization: Bearer %s\\n\u0027 \u0022$ARNPROXY_API_KEY\u0022 |\n curl --silent --show-error --header @- \\\n --header \u0027Accept: application\/json\u0027 \\\n --connect-timeout 10 --max-time 30 \\\n \u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/locations?level=countries\u0027","python":"import os, requests\n\nheaders = {\u0022Authorization\u0022: \u0022Bearer \u0022 + os.environ[\u0022ARNPROXY_API_KEY\u0022]}\nresponse = requests.get(\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/locations?level=countries\u0022,\n headers=headers,\n timeout=(10, 30), allow_redirects=False\n)\nprint(response.status_code, response.text)\n# No automatic write retry.","javascript":"const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` };\nconst response = await fetch(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/locations?level=countries\u0022, {\n method: \u0027GET\u0027, headers, redirect: \u0027error\u0027,\n signal: AbortSignal.timeout(30000)\n});\nconsole.log(response.status, await response.text());\n\/\/ A write timeout is ambiguous; query its saved operation.","php":"\u003C?php\n$headers = [\u0027Accept: application\/json\u0027,\n \u0027Authorization: Bearer \u0027.getenv(\u0027ARNPROXY_API_KEY\u0027)];\n$ch = curl_init(\u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/locations?level=countries\u0027);\ncurl_setopt_array($ch, [\n CURLOPT_RETURNTRANSFER =\u003E true,\n CURLOPT_HTTPHEADER =\u003E $headers,\n CURLOPT_FOLLOWLOCATION =\u003E false,\n CURLOPT_SSL_VERIFYPEER =\u003E true, CURLOPT_SSL_VERIFYHOST =\u003E 2,\n CURLOPT_CONNECTTIMEOUT =\u003E 10, CURLOPT_TIMEOUT =\u003E 30,\n]);\n$result = curl_exec($ch);\nif ($result === false) {\n \/\/ Do not repeat a write; use the original operation key.\n throw new RuntimeException(\u0027Transport result unknown\u0027);\n}\necho curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result;\ncurl_close($ch);","go":"package main\n\nimport (\n \u0022fmt\u0022\n \u0022io\u0022\n \u0022net\/http\u0022\n \u0022os\u0022\n \u0022time\u0022\n)\n\nfunc main() {\n client := \u0026http.Client{Timeout: 30*time.Second,\n CheckRedirect: func(req *http.Request, via []*http.Request) error {\n return http.ErrUseLastResponse\n }}\n var body io.Reader\n req, err := http.NewRequest(\u0022GET\u0022, \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/locations?level=countries\u0022, body)\n if err != nil { panic(err) }\n req.Header.Set(\u0022Authorization\u0022, \u0022Bearer \u0022+os.Getenv(\u0022ARNPROXY_API_KEY\u0022))\n res, err := client.Do(req); if err != nil { panic(err) }\n defer res.Body.Close()\n data, err := io.ReadAll(res.Body); if err != nil { panic(err) }\n fmt.Println(res.StatusCode, string(data))\n}","csharp":"using System;\nusing System.IO;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Text;\n\nusing var handler = new HttpClientHandler { AllowAutoRedirect = false };\nusing var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };\nusing var request = new HttpRequestMessage(HttpMethod.Get,\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/locations?level=countries\u0022);\nrequest.Headers.Authorization = new AuthenticationHeaderValue(\n \u0022Bearer\u0022, Environment.GetEnvironmentVariable(\u0022ARNPROXY_API_KEY\u0022));\nusing var response = await client.SendAsync(request);\nConsole.WriteLine((int)response.StatusCode);\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n\/\/ Never automatically retry an ambiguous write.","java":"import java.net.URI;\nimport java.net.http.*;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.*;\n\n\/\/ Inside your application method:\nvar client = HttpClient.newHttpClient();\nvar request = HttpRequest.newBuilder(URI.create(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/locations?level=countries\u0022))\n .header(\u0022Authorization\u0022, \u0022Bearer \u0022 + System.getenv(\u0022ARNPROXY_API_KEY\u0022))\n .header(\u0022Accept\u0022, \u0022application\/json\u0022)\n .GET()\n .build();\nvar response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode());"}Responses
200Success response
{
"ok": true,
"data": {
"level": "countries",
"country": null,
"region": null,
"city": null,
"items": [
{
"value": "TR",
"label": "TR",
"online_nodes": 125
}
],
"observed_at": "2026-10-24T12:00:00+00:00",
"source": "private_cache",
"availability_guaranteed": false,
"age_seconds": 15,
"stale": false,
"refresh_failed": false,
"count_meaning": "provider_reported_nodes_not_reserved_unique_ips"
},
"meta": {
"request_id": "000000000000000000000001",
"phase": "public_v1",
"source": "provider_read"
}
}Response fields and types
| Name | Type | Description |
|---|---|---|
ok | boolean | Success envelope flag; on false inspect error.code. |
data | object | Operation-specific result; examples are illustrative and synthetic. |
data.level | string | Operation-specific level value; preserve its demonstrated type and consult the behavior notes. |
data.country | null | Operation-specific country value; preserve its demonstrated type and consult the behavior notes. |
data.region | null | Operation-specific region value; preserve its demonstrated type and consult the behavior notes. |
data.city | null | Operation-specific city value; preserve its demonstrated type and consult the behavior notes. |
data.items | array | Records on this page or formatted connection strings; an empty list can be valid. |
data.items[] | object | Records on this page or formatted connection strings; an empty list can be valid. |
data.items[].value | string | Operation-specific value value; preserve its demonstrated type and consult the behavior notes. |
data.items[].label | string | Operation-specific label value; preserve its demonstrated type and consult the behavior notes. |
data.items[].online_nodes | integer | Operation-specific online nodes value; preserve its demonstrated type and consult the behavior notes. |
data.observed_at | string | Timestamp in the API’s returned representation; example dates are synthetic. |
data.source | string | Data source; local records and a live provider lookup are different evidence. |
data.availability_guaranteed | boolean | Operation-specific availability guaranteed value; preserve its demonstrated type and consult the behavior notes. |
data.age_seconds | integer | Operation-specific age seconds value; preserve its demonstrated type and consult the behavior notes. |
data.stale | boolean | Operation-specific stale value; preserve its demonstrated type and consult the behavior notes. |
data.refresh_failed | boolean | Operation-specific refresh failed value; preserve its demonstrated type and consult the behavior notes. |
data.count_meaning | string | Operation-specific count meaning value; preserve its demonstrated type and consult the behavior notes. |
meta | object | Request correlation and data-source metadata. |
meta.request_id | string | This HTTP request’s correlation ID, not an operation key or order ID. |
meta.phase | string | Operation-specific phase value; preserve its demonstrated type and consult the behavior notes. |
meta.source | string | Data source; local records and a live provider lookup are different evidence. |
Error response
{
"ok": false,
"error": { "code": "INVALID_API_KEY" },
"meta": { "request_id": "000000000000000000000001" }
}Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →
Behavior & important notes
- Package and list IDs are ARNPROXY record IDs, not upstream package keys or list IDs. A stale package snapshot cannot grant access; refresh it with residential_package_refresh when needed.