ARNPROXY

Replacement request quote

POST/account/api/v1/replacements/quote

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionread
Acceptapplication/json
Content-Typeapplication/json

Parameters

NameTypeDescription
proxy_ids
bodyRequired
integer[]1–100 unique owned active proxy IDs.

Request body

Replace YOUR_/FROM_ placeholders with values from the relevant catalog, quote or scope. Examples leave consent false; only approve a real operation intentionally.

request.json
{
    "proxy_ids": [
        "YOUR_PROXY_ID"
    ]
}

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 \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/replacements/quote'

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": {
        "currency": "TRY",
        "total": "0.00",
        "total_minor": 0,
        "selection_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "items": [
            {
                "proxy_id": 12345,
                "order_id": 10001,
                "location_id": 10,
                "fee": "0.00",
                "fee_minor": 0,
                "free_request": true
            }
        ],
        "mode": "admin_review",
        "immediate_replacement": false,
        "fee_charged_on_request": true,
        "request_available": true,
        "reason_codes": [
            "not_working",
            "blocked",
            "incorrect_country",
            "different_subnet",
            "low_speed",
            "other"
        ]
    },
    "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.currencystringAccount transaction currency: TRY or USD.
data.totalstringMoney amount; preserve the returned string/integer representation for precision.
data.total_minorintegerInteger minor units: 1000 means 10.00 TRY/USD.
data.selection_hashstringFreshness fingerprint to copy unchanged to the corresponding write/price confirmation.
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[].proxy_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.items[].order_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.items[].location_idintegerLocal catalog location or product-type ID.
data.items[].feestringMoney amount; preserve the returned string/integer representation for precision.
data.items[].fee_minorintegerInteger minor units: 1000 means 10.00 TRY/USD.
data.items[].free_requestbooleanOperation-specific free request value; preserve its demonstrated type and consult the behavior notes.
data.modestringOperation-specific mode value; preserve its demonstrated type and consult the behavior notes.
data.immediate_replacementbooleanOperation-specific immediate replacement value; preserve its demonstrated type and consult the behavior notes.
data.fee_charged_on_requestbooleanOperation-specific fee charged on request value; preserve its demonstrated type and consult the behavior notes.
data.request_availablebooleanAvailability under the result’s conditions/permissions, not a stock or provider guarantee.
data.reason_codesarrayOperation-specific reason codes value; preserve its demonstrated type and consult the behavior notes.
data.reason_codes[]stringOperation-specific reason codes 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

  • 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