Proxy-seller

Tools reference

Updated:

54 tools in 7 groups, one page per group. Each tool lists the permission it needs; parameters marked required must be provided, and the assistant fills them in from the conversation or from other tools.

Passwords are masked by default. The assistant is instructed to reveal only when you ask for the credentials (an explicit request counts as confirmation), because revealed credentials become part of the conversation — see Proxy passwords and the AI provider. Price quotes and orders (calc_*, make_*, auto-renewal) echo the affected proxies with password always masked — they have no reveal.

Browse by area

Legend

Badge

Meaning

🟢 read-only

Reads data, changes nothing

🟡 changes account state

Modifies your account

🔴 destructive

Deletes something

💳 spends money

Spends money or arms a charge

Common values

Value

Accepted

Proxy type

ipv4, ipv6, mobile, isp, mix, mix_isp, resident (and subresident where noted)

Rotation (residential)

-1 sticky, 0 new IP on every request, 1–3600 seconds to hold an IP

paymentId

"balance" for the account balance, or "paddle_subscription" for a connected card

Payment sources are explained on Payments & safety.

All tools

Every tool on one screen. Follow a name to its parameters.

Documentation

Permissions: docs:read

Tool

What it does

ps_docs_search

🟢 read

Search the API docs and return short snippets.

ps_docs_get

🟢 read

Read one documentation page or a single section of it.

ps_api_list_endpoints

🟢 read

List API operations with method, path and summary.

ps_api_get_endpoint

🟢 read

Full details for one operation: parameters, request body, response, errors, examples, available SDK languages.

ps_sdk_snippet

🟢 read

A ready-to-use code example for an operation.

ps_whats_new

🟢 read

Recent documentation versions and what each added, changed or removed.

Proxies and orders

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

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.

Auto-renewal

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

Tool

What it does

calc_autoprolong_cost

🟢 read

The next automatic charge and its date, without changing anything.

enable_autoprolong

💳 pays

Turn auto-renewal on.

disable_autoprolong

🟡 write

Turn auto-renewal off.

Authorizations

Permissions: account:read, account:write

Tool

What it does

list_auth

🟢 read

All authorizations: login/password pairs and whitelisted IPs, with ids and active state.

add_auth

🟡 write

Create an authorization.

change_auth

🟡 write

Change login, password or whitelisted IP, or enable/disable an authorization.

delete_auth

🔴 delete

Delete an authorization.

Residential proxies

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

Tool

What it does

get_resident_package

🟢 read

Traffic limit, used and remaining traffic, expiry, default rotation, auto-renew state, package_key.

get_resident_geo

🟢 read

Without country — available countries.

get_resident_geo_count

🟢 read

How many residential nodes a location has.

get_resident_isp_codes

🟢 read

Search the ISP catalogue with numeric codes.

list_resident_lists

🟢 read

All residential lists: id, title, credentials, whitelist, geo, rotation, export settings.

add_resident_list

🟡 write

Create a residential list.

set_resident_rotation

🟡 write

Change the rotation of one residential list.

rename_resident_list

🟡 write

Rename one residential list.

delete_resident_list

🔴 delete

Delete one residential list.

create_resident_tools_list

🟡 write

Create the special API Tools list and return its login and password.

get_resident_consumption

🟢 read

Traffic used and its cost, per list, plus package totals and price per GB.

get_resident_traffic_details

🟢 read

Raw usage timeline per list and timestamp.

calc_resident_order

🟢 read

Price of a residential traffic package.

make_resident_order

💳 pays

Buy the first residential package or add traffic to an existing one.

Residential subpackages (subusers)

Permissions: account:read, account:write

Tool

What it does

list_resident_subpackages

🟢 read

All subpackages with package_key, allocated/used/remaining traffic (bytes), rotation, expiry, state.

create_resident_subpackage

🟡 write

Create a subpackage out of traffic you already own.

update_resident_subpackage

🟡 write

Change traffic, expiry, rotation or pause/resume.

delete_resident_subpackage

🔴 delete

Delete a subpackage and its lists.

list_resident_subuser_lists

🟢 read

All lists inside one subpackage.

add_resident_subuser_list

🟡 write

Same as add_resident_list, plus package_key.

rename_resident_subuser_list

🟡 write

Rename one list inside a subpackage.

set_resident_subuser_rotation

🟡 write

Change the rotation of one list inside a subpackage.

delete_resident_subuser_list

🔴 delete

Delete one list inside a subpackage.

create_resident_subuser_tools_list

🟡 write

API Tools list inside a subpackage.

Balance and payments

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

Tool

What it does

get_balance

🟢 read

Current balance in USD.

list_payments

🟢 read

External payment methods (PayPal, card, crypto…) with their ids.

add_balance

💳 pays

Create a balance top-up and return a payment link.

get_autotopup

🟢 read

Automatic top-up settings: enabled, threshold, amount, bound card, last attempt.

set_autotopup

💳 pays

Turn on or change automatic top-up: when the balance drops to threshold, amount is charged to the bound card.

disable_autotopup

🟡 write

Turn automatic top-up off.

Note: a tool the assistant says it does not have is a tool outside the permissions you granted. See Permissions.

Next steps

On this page