ARNPROXY

Current replacement request states

GET/account/api/v1/replacements

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionread
Acceptapplication/json

Parameters

NameTypeDescription
after_id
queryOptional
integerUse next_after_id from the previous response; ascending-ID cursor, starting at 0.
Default: 0
limit
queryOptional
integer1–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/replacements'

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": 50001,
                "proxy_id": 12345,
                "state": "pending",
                "result": null,
                "fee": "0.00",
                "currency": "TRY",
                "fee_collected": false,
                "reason_code": "other",
                "requested_at": "2030-01-01 15:00:00",
                "processed_at": null,
                "timezone": "Europe/Istanbul"
            }
        ],
        "next_after_id": null
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Response fields and types
NameTypeDescription
okbooleanSuccess envelope flag; on false inspect error.code.
dataobjectOperation-specific result; examples are illustrative and synthetic.
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[].idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.items[].proxy_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.items[].statestringRecord/operation state. accepted is not delivery; completed is not a connection test.
data.items[].resultstring|nullOperation-specific result value; preserve its demonstrated type and consult the behavior notes.
data.items[].feestringMoney amount; preserve the returned string/integer representation for precision.
data.items[].currencystringAccount transaction currency: TRY or USD.
data.items[].fee_collectedbooleanOperation-specific fee collected value; preserve its demonstrated type and consult the behavior notes.
data.items[].reason_codestringFixed reason code or null, never raw provider error text.
data.items[].requested_atstringOperation-specific requested at value; preserve its demonstrated type and consult the behavior notes.
data.items[].processed_atstring|nullOperation-specific processed at value; preserve its demonstrated type and consult the behavior notes.
data.items[].timezonestringTimezone for related date fields; null means no verified timezone.
data.next_after_idinteger|nullCursor for the next page; null means no further page in this result.
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

  • This submits a request for administrator review, not a guaranteed immediate upstream IP swap. Check replacement_quote for any request fee.

Search the current language. Close with Esc