Connection lists for a package

GET/account/api/v1/residential/lists

Authorization

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
Required permission	`read`
Accept	`application/json`

Parameters

Name	Type	Description
`package_id` queryOptional	`integer`	ARNPROXY package ID from residential_packages, never a supplier package_key.
`after_id` queryOptional	`integer`	Use next_after_id from the previous response; ascending-ID cursor, starting at 0. Default: `0`
`limit` queryOptional	`integer`	1–100; default 25. Default: `25`

Request example

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?package_id=YOUR_PACKAGE_ID'

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.

Responses

200Success response

application/json

{
    "ok": true,
    "data": {
        "items": [
            {
                "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"
                ]
            }
        ],
        "next_after_id": null,
        "source": "arnproxy_records"
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

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.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[].id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.items[].package_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.items[].order_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.items[].title`	`string`	Operation-specific title value; preserve its demonstrated type and consult the behavior notes.
`data.items[].package_state`	`string`	Operation-specific package state value; preserve its demonstrated type and consult the behavior notes.
`data.items[].snapshot`	`object`	Package snapshot origin/time/freshness; stale snapshots do not grant management access.
`data.items[].snapshot.source`	`string`	Data source; local records and a live provider lookup are different evidence.
`data.items[].snapshot.observed_at`	`string`	Timestamp in the API’s returned representation; example dates are synthetic.
`data.items[].snapshot.fresh`	`boolean`	Whether the observation satisfies its freshness window.
`data.items[].snapshot.max_age_seconds`	`integer`	Maximum snapshot age allowed for freshness, in seconds.
`data.items[].snapshot.reason`	`string\|null`	Fixed reason code or null, never raw provider error text.
`data.items[].connection`	`object`	List host, first port and port count; can be null for invalid observations.
`data.items[].connection.host`	`string`	Operation-specific host value; preserve its demonstrated type and consult the behavior notes.
`data.items[].connection.first_port`	`integer`	Start or size of the connection port range.
`data.items[].connection.port_count`	`integer`	Start or size of the connection port range.
`data.items[].authentication`	`string`	Connection list authentication mode: login_password or ip_auth.
`data.items[].target`	`object`	Operation-specific target value; preserve its demonstrated type and consult the behavior notes.
`data.items[].target.country`	`string`	Operation-specific country value; preserve its demonstrated type and consult the behavior notes.
`data.items[].target.region`	`string`	Operation-specific region value; preserve its demonstrated type and consult the behavior notes.
`data.items[].target.city`	`string`	Operation-specific city value; preserve its demonstrated type and consult the behavior notes.
`data.items[].target.isp`	`string`	Operation-specific isp value; preserve its demonstrated type and consult the behavior notes.
`data.items[].rotation`	`object`	Operation-specific rotation value; preserve its demonstrated type and consult the behavior notes.
`data.items[].rotation.type`	`string`	Operation-specific type value; preserve its demonstrated type and consult the behavior notes.
`data.items[].rotation.seconds`	`integer`	Recorded/requested rotation in seconds; Rotating packages and Residential lists have different rules.
`data.items[].credential_read_available`	`boolean`	Operation-specific credential read available value; preserve its demonstrated type and consult the behavior notes.
`data.items[].management_available`	`boolean`	Availability under the result’s conditions/permissions, not a stock or provider guarantee.
`data.items[].management_actions`	`array`	Operation-specific management actions value; preserve its demonstrated type and consult the behavior notes.
`data.items[].management_actions[]`	`string`	Operation-specific management actions value; preserve its demonstrated type and consult the behavior notes.
`data.next_after_id`	`integer\|null`	Cursor for the next page; null means no further page in this result.
`data.source`	`string`	Data source; local records and a live provider lookup are different evidence.
`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.items[].authorized_ips`Conditional	`string[]\|null`	May be returned for IP-auth lists with residential_management permission.

Error response

HTTP 401 · INVALID_API_KEY

{
  "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.