ARNPROXY

Hourly traffic history of owned registered logins only

GET/account/api/v1/residential/traffic

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionread
Acceptapplication/json

Parameters

NameTypeDescription
package_id
queryRequired
integerARNPROXY package ID from residential_packages, never a supplier package_key.
list_id
queryOptional
integerOwned ARNPROXY connection-list record ID, not the supplier list ID.
date_start
queryOptional
stringYYYY-MM-DD within the last 366 days, with at most 31 inclusive calendar days through date_end.
Default: "UTC today minus 6 days"
date_end
queryOptional
stringYYYY-MM-DD; not before date_start or after the current UTC date.
Default: "UTC today"

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/traffic?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": {
        "package_id": 20001,
        "list_id": null,
        "date_start": "2030-01-01",
        "date_end": "2030-01-01",
        "items": [
            {
                "time_label": "2030-01-01 12:00:00",
                "used_bytes": "1024"
            }
        ],
        "total_used_bytes": "1024",
        "matched_series": 1,
        "scope": "owned_registered_logins",
        "complete_package_history": false,
        "timezone": null,
        "timezone_verified": false,
        "observed_at": "2030-01-01T12:00:00+00:00",
        "source": "provider_read",
        "automatic_retry": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "provider_read"
    }
}
Response fields and types
NameTypeDescription
okbooleanSuccess envelope flag; on false inspect error.code.
dataobjectOperation-specific result; examples are illustrative and synthetic.
data.package_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.list_idinteger|nullRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.date_startstringOperation-specific date start value; preserve its demonstrated type and consult the behavior notes.
data.date_endstringOperation-specific date end value; preserve its demonstrated type and consult the behavior notes.
data.itemsarrayRecords on this page or formatted connection strings; an empty list can be valid.
data.items[]objectRecords on this page or formatted connection strings; an empty list can be valid.
data.items[].time_labelstringProvider hour label; do not assume UTC when timezone_verified=false.
data.items[].used_bytesstringByte count as a decimal string; avoid precision loss when converting to JavaScript Number.
data.total_used_bytesstringByte count as a decimal string; avoid precision loss when converting to JavaScript Number.
data.matched_seriesintegerOperation-specific matched series value; preserve its demonstrated type and consult the behavior notes.
data.scopestringOperation-specific scope value; preserve its demonstrated type and consult the behavior notes.
data.complete_package_historybooleanOperation-specific complete package history value; preserve its demonstrated type and consult the behavior notes.
data.timezonestring|nullTimezone for related date fields; null means no verified timezone.
data.timezone_verifiedbooleanOperation-specific timezone verified value; preserve its demonstrated type and consult the behavior notes.
data.observed_atstringTimestamp in the API’s returned representation; example dates are synthetic.
data.sourcestringData source; local records and a live provider lookup are different evidence.
data.automatic_retrybooleanOperation-specific automatic retry value; preserve its demonstrated type and consult the behavior notes.
metaobjectRequest correlation and data-source metadata.
meta.request_idstringThis HTTP request’s correlation ID, not an operation key or order ID.
meta.phasestringOperation-specific phase value; preserve its demonstrated type and consult the behavior notes.
meta.sourcestringData source; local records and a live provider lookup are different evidence.

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.
  • Only owned registered-login series are summed, not a complete accounting of all historical traffic. Dates use YYYY-MM-DD, at most 31 days. time_label has an unverified timezone and must not be assumed UTC.
  • The 31-day limit is inclusive. The default covers the last 7 UTC calendar days, but provider hour labels still have no verified timezone.

Search the current language. Close with Esc