# One connection list `GET /account/api/v1/residential/lists/{id}` ## Authorization `Authorization: Bearer YOUR_ARNPROXY_API_KEY` `Accept: application/json` Required permission: `read + optional credentials` ## Parameters | Name | Type | Required / Conditional | Default | Description | |---|---|---|---|---| | `id` (path) | integer | Required | — | An owned record ID for this operation; 1–2147483647. Not a display order number or supplier ID. | | `include_credentials` (query) | string | Optional | `"0"` | "0" or "1"; default "0". "1" needs credentials permission and valid service. | ## Request example ### curl ```curl 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/lists/YOUR_LIST_ID' ``` ### python ```python import os, requests headers = {"Authorization": "Bearer " + os.environ["ARNPROXY_API_KEY"]} response = requests.get( "https://www.arnproxy.com/account/api/v1/residential/lists/YOUR_LIST_ID", headers=headers, timeout=(10, 30), allow_redirects=False ) print(response.status_code, response.text) # No automatic write retry. ``` ### javascript ```javascript const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` }; const response = await fetch("https://www.arnproxy.com/account/api/v1/residential/lists/YOUR_LIST_ID", { method: 'GET', headers, redirect: 'error', signal: AbortSignal.timeout(30000) }); console.log(response.status, await response.text()); // A write timeout is ambiguous; query its saved operation. ``` ### php ```php true, CURLOPT_HTTPHEADER => $headers, CURLOPT_FOLLOWLOCATION => false, CURLOPT_SSL_VERIFYPEER => true, CURLOPT_SSL_VERIFYHOST => 2, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 30, ]); $result = curl_exec($ch); if ($result === false) { // Do not repeat a write; use the original operation key. throw new RuntimeException('Transport result unknown'); } echo curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result; curl_close($ch); ``` ### go ```go package main import ( "fmt" "io" "net/http" "os" "time" ) func main() { client := &http.Client{Timeout: 30*time.Second, CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }} var body io.Reader req, err := http.NewRequest("GET", "https://www.arnproxy.com/account/api/v1/residential/lists/YOUR_LIST_ID", body) if err != nil { panic(err) } req.Header.Set("Authorization", "Bearer "+os.Getenv("ARNPROXY_API_KEY")) res, err := client.Do(req); if err != nil { panic(err) } defer res.Body.Close() data, err := io.ReadAll(res.Body); if err != nil { panic(err) } fmt.Println(res.StatusCode, string(data)) } ``` ### csharp ```csharp using System; using System.IO; using System.Net.Http; using System.Net.Http.Headers; using System.Text; using var handler = new HttpClientHandler { AllowAutoRedirect = false }; using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) }; using var request = new HttpRequestMessage(HttpMethod.Get, "https://www.arnproxy.com/account/api/v1/residential/lists/YOUR_LIST_ID"); request.Headers.Authorization = new AuthenticationHeaderValue( "Bearer", Environment.GetEnvironmentVariable("ARNPROXY_API_KEY")); using var response = await client.SendAsync(request); Console.WriteLine((int)response.StatusCode); Console.WriteLine(await response.Content.ReadAsStringAsync()); // Never automatically retry an ambiguous write. ``` ### java ```java import java.net.URI; import java.net.http.*; import java.nio.charset.StandardCharsets; import java.nio.file.*; // Inside your application method: var client = HttpClient.newHttpClient(); var request = HttpRequest.newBuilder(URI.create("https://www.arnproxy.com/account/api/v1/residential/lists/YOUR_LIST_ID")) .header("Authorization", "Bearer " + System.getenv("ARNPROXY_API_KEY")) .header("Accept", "application/json") .GET() .build(); var response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode()); ``` ## Responses · HTTP 200 ```json { "ok": true, "data": { "id": 30001, "package_id": 20001, "order_id": 20001, "title": "Example connection list", "package_state": "active", "snapshot": { "source": "arnproxy_records", "observed_at": "2030-01-01T12:00:00+00:00", "fresh": true, "max_age_seconds": 3600, "reason": null }, "connection": { "host": "res.arnproxy.com", "first_port": 10000, "port_count": 10 }, "authentication": "login_password", "target": { "country": "US", "region": "", "city": "", "isp": "" }, "rotation": { "type": "interval", "seconds": 0 }, "credential_read_available": true, "management_available": true, "management_actions": [ "rename", "rotation", "delete" ] }, "meta": { "request_id": "000000000000000000000001", "phase": "public_v1", "source": "arnproxy_records" } } ``` | Name | Type | Conditional | Description | |---|---|---|---| | `ok` | boolean | — | Success envelope flag; on false inspect error.code. | | `data` | object | — | Operation-specific result; examples are illustrative and synthetic. | | `data.id` | integer | — | Relevant ARNPROXY record ID; use it instead of the upstream internal ID. | | `data.package_id` | integer | — | Relevant ARNPROXY record ID; use it instead of the upstream internal ID. | | `data.order_id` | integer | — | Relevant ARNPROXY record ID; use it instead of the upstream internal ID. | | `data.title` | string | — | Operation-specific title value; preserve its demonstrated type and consult the behavior notes. | | `data.package_state` | string | — | Operation-specific package state value; preserve its demonstrated type and consult the behavior notes. | | `data.snapshot` | object | — | Package snapshot origin/time/freshness; stale snapshots do not grant management access. | | `data.snapshot.source` | string | — | Data source; local records and a live provider lookup are different evidence. | | `data.snapshot.observed_at` | string | — | Timestamp in the API’s returned representation; example dates are synthetic. | | `data.snapshot.fresh` | boolean | — | Whether the observation satisfies its freshness window. | | `data.snapshot.max_age_seconds` | integer | — | Maximum snapshot age allowed for freshness, in seconds. | | `data.snapshot.reason` | string|null | — | Fixed reason code or null, never raw provider error text. | | `data.connection` | object | — | List host, first port and port count; can be null for invalid observations. | | `data.connection.host` | string | — | Operation-specific host value; preserve its demonstrated type and consult the behavior notes. | | `data.connection.first_port` | integer | — | Start or size of the connection port range. | | `data.connection.port_count` | integer | — | Start or size of the connection port range. | | `data.authentication` | string | — | Connection list authentication mode: login_password or ip_auth. | | `data.target` | object | — | Operation-specific target value; preserve its demonstrated type and consult the behavior notes. | | `data.target.country` | string | — | Operation-specific country value; preserve its demonstrated type and consult the behavior notes. | | `data.target.region` | string | — | Operation-specific region value; preserve its demonstrated type and consult the behavior notes. | | `data.target.city` | string | — | Operation-specific city value; preserve its demonstrated type and consult the behavior notes. | | `data.target.isp` | string | — | Operation-specific isp value; preserve its demonstrated type and consult the behavior notes. | | `data.rotation` | object | — | Operation-specific rotation value; preserve its demonstrated type and consult the behavior notes. | | `data.rotation.type` | string | — | Operation-specific type value; preserve its demonstrated type and consult the behavior notes. | | `data.rotation.seconds` | integer | — | Recorded/requested rotation in seconds; Rotating packages and Residential lists have different rules. | | `data.credential_read_available` | boolean | — | Operation-specific credential read available value; preserve its demonstrated type and consult the behavior notes. | | `data.management_available` | boolean | — | Availability under the result’s conditions/permissions, not a stock or provider guarantee. | | `data.management_actions` | array | — | Operation-specific management actions value; preserve its demonstrated type and consult the behavior notes. | | `data.management_actions[]` | string | — | Operation-specific management actions 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. | | `data.credentials` | object | Conditional | Only with include_credentials=1, credentials permission, an active package and a login_password list. | | `data.credentials.username` | string | Conditional | Connection-list username. | | `data.credentials.password` | string | Conditional | Connection-list password. | | `data.authorized_ips` | string[]|null | Conditional | May be returned for an IP-auth list with residential_management permission. | ## 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. - Credential-bearing output requires credentials permission. Never log or send returned connection strings, passwords or Authorization headers to support. 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](https://docs.arnproxy.com/api-v1/errors)