Proxy-seller

Proxies and orders

Updated:

Permissions: account:read, account:write, billing:write

In this group

Tool

What it does

list_proxies

🟢 read

Your active proxies of one type: IP, HTTP/SOCKS ports, credentials, country, expiry date, auto-renew state and comment.

export_proxies

🟢 read

Export proxies as a ready-to-use list, one proxy per line.

get_reference

🟢 read

Available countries, rental periods and packages for a product type.

calc_order_cost

🟢 read

Price and discount for a new order, without placing it.

make_order

💳 pays

Place a new proxy order.

list_orders

🟢 read

Your orders, newest first, and the usage targets already on the account.

check_order_status

🟢 read

Checks whether the proxies of a placed order have been issued.

calc_prolong_cost

🟢 read

Renewal price for specific proxies, without renewing.

make_prolong

💳 pays

Renew proxies for another period.

replace_proxy

🟡 write

Request replacement of non-working proxies.

set_proxy_comment

🟡 write

Set the same comment on one or more proxies.

list_proxies

🟢 read-only · account:read

Your active proxies of one type: IP, HTTP/SOCKS ports, credentials, country, expiry date, auto-renew state and comment. password comes back masked unless you ask for it. Proxies with status: "Ended" are ending soon, not expired — date_end is the actual expiry.

Parameter

Type

Description

type required

proxy type

Product type. mix is the IPv4 MIX package only and mix_isp the ISP MIX package — two separate listings, so “all my MIX proxies” means both. subresident is not served here: use list_resident_subuser_lists

orderId

string | integer

Only one order

country

string

Alpha-3 code, e.g. USA

latest

boolean

Only the most recently issued proxies

ends

boolean

Only proxies ending soon

page, per_page

integer

Page to return (default 1) and page size (default 50)

reveal

boolean

Return password in clear instead of ••••. The assistant confirms with you first — see Proxy passwords and the AI provider

Returns: {items: [...]} — one object per proxy with id, ip, protocol, port_http, port_socks, login, password, country, country_alpha3, date_start, date_end, status, status_type, can_prolong, auto_renew, comment, order_id, order_number, base_order_number. The response is paged (50 per page by default) and carries page, per_page, total, total_pages, plus a _note when more pages exist. For resident the items are the residential lists, not IPs. For mix / mix_isp one package is issued across several countries: order_number and base_order_number carry a per-country suffix (NS_…-dX_GBR, NS_…-dX_DEU) while order_id is shared — group by order_id; a _note on the result says so. password is "••••" unless reveal: true. ⚠️ Sensitive data — the result includes a warning that the assistant repeats to you.

export_proxies

🟢 read-only · account:read

Export proxies as a ready-to-use list, one proxy per line. Masked by default: ip:port. With reveal: true the lines are connectable login:password@host:port.

Parameter

Type

Description

type required

proxy type, incl. subresident

Product type

ext

string

txt (default), csv, or a template like %login%:%password%@%ip%:%port%. Without reveal, txt becomes %ip%:%port%; csv (whose fixed layout ip;port;login;password always contains the password) and a template naming %password% are refused until you confirm the reveal

proto

https | socks5

Only one port type (not for residential)

protocol

http | socks5

Residential only (resident, subresident): the scheme of each line. With txt a line becomes socks5://login:password@host:port; csv keeps its columns; a template gets the value in %protocol% (a template cannot contain /, so use txt for scheme:// lines). Without it lines have no scheme. Not the same as proto; there is no https. socks5 also carries UDP and HTTP/3 (QUIC)

host

res.proxy-seller.com | us.res.proxy-seller.com | asia.res.proxy-seller.com

Residential only: the gateway in each line — Europe (default), USA or Asia. Only the entry point; the exit IP location comes from the list settings

country

string

Alpha-3 code (not for residential)

ends

boolean

Only proxies ending soon (not for residential)

listId

string | integer

Residential list id (resident and subresident); omit to export all lists

package_key

string

Subpackage key, with type: "subresident"

maxLine

integer

Max lines, residential only

reveal

boolean

Return connectable login:password@host:port lines instead of ip:port. The assistant confirms with you first — see Proxy passwords and the AI provider

Returns: With a residential protocol the lines carry the scheme: socks5://host:port by default, socks5://login:password@host:port with reveal: true. Without reveal the lines are followed by a note saying that passwords were left out — the assistant relays it, so a password-free list is never presented as the credentials you asked for. Asking for csv is asking for the passwords: the assistant warns you that the file will put your proxy credentials into the conversation and asks you to confirm before exporting it.

get_reference

🟢 read-only · account:read

Available countries, rental periods and packages for a product type. Needed before pricing or ordering. Countries are alpha-3 codes (USA), periods are short codes (1m). For mobile it also returns operators and rotation options; for residential — traffic tariffs.

Parameter

Type

Description

type required

proxy type

Product type

calc_order_cost

🟢 read-only · account:read

Price and discount for a new order, without placing it. Takes the same parameters as make_order.

make_order

💳 spends money · billing:write

Place a new proxy order. Charges the balance. Calling it twice creates two orders.

Parameter

Type

Description

type required

proxy type

Product type (use make_resident_order for residential traffic)

countryId required

string

From get_reference, e.g. USA

periodId required

string

From get_reference, e.g. 1m

quantity required

integer

Number of proxies (ipv6 minimum is 10)

paymentId required

string

balance or paddle_subscription

customTargetName

string

What the proxies are for, as a short site or service name (Google, Instagram). Required for ipv4, ipv6, isp. A target the account has never used is a new target: a manager approves it by hand and the order stays pending until then, so the assistant prefers one of the account's existing targets (list_orders → targets)

coupon

string

Promo code

generateAuth

boolean

Generate login/password for the new proxies

protocol

HTTPS | SOCKS5

Protocol override

mobileServiceType

shared | dedicated

Mobile only, required

operatorId

string

Mobile only, required — carrier from get_reference

rotationId

string

Mobile only, required — rotation in minutes from get_reference

mixId

string

MIX only — package code from get_reference

uptime

boolean

IPv4/ISP only — High Availability mode where offered

Typical failure: the order is paid but stays pending for more than a minute. When its customTargetName is new to the account, provisioning.targetNote says so: the CRM created a new usage target that a manager approves by hand, and the proxies are issued after that — nothing is wrong with the payment or the stock. Re-check later with check_order_status, or reuse an existing target next time.

list_orders

🟢 read-only · account:read

Your orders, newest first — purchases and prolongations — with their ids, status, amount, dates, proxy type and usage target, plus the account's distinct usage targets. Use it to pick a customTargetName the account already has before ordering, to find the order_id values an ipv6 / mix / mix_isp renewal takes as orderIds, and for order history.

Parameter

Type

Description

order_id

string | integer

One order (order_id returns it with its prolongations; a row's numeric id returns that row)

start_date / end_date

string

Creation date bounds, yyyy-MM-dd or dd.MM.yyyy

status

PAYED | NOT_PAYED | RETURN

Machine status filter

is_extend

boolean

true prolongations only, false purchases only

auto_order

boolean

true placed through the API or renewed automatically, false placed by hand

page / limit

integer

Paging, 50 rows per page by default; a _note says when more pages exist. targets always covers every matching order

Returns: {metadata: {total_orders, total_pages, current_page, current_limit}, items: [{id, order_id, order_number, base_order_number, status, status_type, summ, date_insert, date_payed, payment_name, is_extend, auto_order, auth_way, auth_ip, protocol, items: [{order_part_id, type, quantity, target, target_section, time, price, name, ...}], ...}], targets: string[], _note?}. summ is a currency string ($12.50), dates are ISO 8601; the usage target sits on each order part (items[].items[].target); branch on status_type, not status.

check_order_status

🟢 read-only · account:read

Checks whether the proxies of a placed order have been issued, by counting the proxies list_proxies holds for the order — for every type, MIX packages included. While a MIX order lists no IPs yet, the per-country logins in list_auth are the fallback evidence (started). Safe to call repeatedly; returns a status and next steps. The cabinet labels a MIX package by its order_part_id, which differs from orderId; that is the same order.

Parameter

Type

Description

type required

proxy type

Product type

orderId required

string | integer

orderId from make_order

expectedQuantity

integer

Ordered quantity, to detect partial delivery

baseOrderNumbers

string[]

MIX only — listBaseOrderNumbers from the make_order response, used for the login fallback

Returns: status is provisioned, partial, started (MIX: logins exist, IPs not listed yet) or pending. proxies[] are the issued records with password masked — use list_proxies / export_proxies with reveal: true for credentials.

calc_prolong_cost

🟢 read-only · account:read

Renewal price for specific proxies, without renewing. Same parameters as make_prolong.

Returns: items are the proxies that would be renewed, password masked.

make_prolong

💳 spends money · billing:write

Renew proxies for another period. Charges the selected payment source. Calling it twice charges twice.

Parameter

Type

Description

type required

ipv4 | ipv6 | mobile | isp | mix | mix_isp

Product type. A residential package is not renewed by period — buy traffic with make_resident_order

periodId required

string

From get_reference

paymentId required

string

balance or a method from list_payments

ips

string[]

ipv4 / isp / mobile: proxy addresses as list_proxies shows them

ids

(string | integer)[]

ipv4 / isp / mobile: proxy ids

orderIds

(string | integer)[]

ipv6 / mix / mix_isp: the order_id values from list_proxies. These products are sold and renewed as whole orders — every active proxy of the order is renewed and charged

coupon

string

Promo code

Which selector applies depends on type: ipv4, isp and mobile take ids or ips; ipv6, mix and mix_isp take orderIds. For a whole-order type you may still pass ids or ips — the assistant's tool resolves them to their orders — but the API itself accepts only orderIds there.

Typical failure: a second renewal of an order that is still being renewed is refused before payment (code 57, “already in progress”) — nothing is charged; wait and check list_proxies rather than retrying blindly. “Prolong was not applied, payment returned to balance” means the renewal was rolled back and the money is back on the balance.

replace_proxy

🟡 changes account state · account:write

Request replacement of non-working proxies. Each proxy can be replaced once per day.

Parameter

Type

Description

ids required

(string | integer)[]

Proxy ids

reason required

NOT_WORK | INCORRECT_LOCATION | CANT_CHANGE_NETWORK | LOW_SPEED | CUSTOM

Reason

comment

string

Required when reason is CUSTOM

set_proxy_comment

🟡 changes account state · account:write

Set the same comment on one or more proxies. Replaces the previous comment; an empty string clears it.

Parameter

Type

Description

ids required

(string | integer)[]

Proxy ids

comment required

string

Comment text

Next steps

On this page