buildConnectionString

Build a ready-to-use username and connection string for a proxy resource. The tool retrieves the proxy credential and account prefix automatically, validates geo, network, and session parameters, and encodes them in the correct order. Returns the host, port, username, password, and a username:password@host:port connection string. Response fields: docs://proxies/buildConnectionString.

read-only

Argument	Type	Description
id*	string	Proxy resource ID from listProxyResources.
asn	integer	Residential ASN. Excludes location and isp.
isp	integer	Mobile ISP code. Excludes location and asn.
zip	string	ZIP value. Requires country_code; excludes state/city.
city	string	City extract_parameter. Requires country_code and state.
state	string	Region extract_parameter. Requires country_code.
strict	boolean	Strict sticky session. Requires session.
session	string	Optional alphanumeric sticky-session ID.
country_code	string	Optional two-letter ISO country code, e.g. US.
session_ttl_minutes	integer	TTL in minutes. Requires session.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID from listProxyResources."
    },
    "asn": {
      "type": "integer",
      "minimum": 0,
      "description": "Residential ASN. Excludes location and isp."
    },
    "isp": {
      "type": "integer",
      "minimum": 0,
      "description": "Mobile ISP code. Excludes location and asn."
    },
    "zip": {
      "type": "string",
      "description": "ZIP value. Requires country_code; excludes state/city."
    },
    "city": {
      "type": "string",
      "description": "City extract_parameter. Requires country_code and state."
    },
    "state": {
      "type": "string",
      "description": "Region extract_parameter. Requires country_code."
    },
    "strict": {
      "type": "boolean",
      "description": "Strict sticky session. Requires session."
    },
    "session": {
      "type": "string",
      "description": "Optional alphanumeric sticky-session ID."
    },
    "country_code": {
      "type": "string",
      "description": "Optional two-letter ISO country code, e.g. US."
    },
    "session_ttl_minutes": {
      "type": "integer",
      "description": "TTL in minutes. Requires session."
    }
  },
  "additionalProperties": false
}

createProxyResource

Create a new residential or mobile proxy resource on the account. Check getAccountBalance and require can_create_proxy to be true; usage is billed according to the selected plan (tariff_id from listProxyPlans). The name must be unique on the account and cannot be changed later. Limits can be set here or later with setProxyLimits. Returns the complete new proxy, including its password. Use buildConnectionString to get a connection string. Response fields: docs://proxies/createProxyResource.

Argument	Type	Description
name*	string	Proxy name: lowercase letters, digits, underscores only, max 50 characters. Immutable after creation.
limits	null \| object	Optional spend or traffic limit. Can also be set later via setProxyLimits.
countries	null \| array	Country IDs; empty allows any country.
tariff_id*	integer	Tariff plan ID from listProxyPlans
proxy_type*	string	Proxy type, one of: residential, mobile
description	string	Free-text note, shown alongside this proxy in listProxyResources. Write enough detail to identify this proxy's purpose at a glance later — e.g. the project or task it's for, why it was created, its default country, or other distinguishing settings.
ip_whitelist

deactivateProxyResource

Deactivate a proxy resource, stopping its traffic without deleting it. Reactivate later with updateProxyResource (status active). Use deleteProxyResource to permanently remove instead. Returns the updated proxy with status inactive. Response fields: docs://proxies/updateProxyResource (shared with updateProxyResource).

Argument	Type	Description
id*	string	Proxy resource ID. Get from listProxyResources.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID. Get from listProxyResources."
    }
  },
  "additionalProperties": false
}

deleteProxyResource

Permanently delete a proxy resource. This action is irreversible — the proxy and all its settings will be removed. User confirmation is required before proceeding. To stop traffic but keep the proxy for later, use deactivateProxyResource instead. Returns a snapshot of the deleted proxy with status deleted. Response fields: docs://proxies/deleteProxyResource.

destructive

Argument	Type	Description
id*	string	Proxy resource ID. Get from listProxyResources.
confirm	boolean	Set to true only after the user has explicitly confirmed the deletion. Skips the confirmation step.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID. Get from listProxyResources."
    },
    "confirm": {
      "type": "boolean",
      "description": "Set to true only after the user has explicitly confirmed the deletion. Skips the confirmation step."
    }
  },
  "additionalProperties": false
}

getAccountBalance

Get the current account balance, overdraft limit, and proxy username prefix. Returns funds_available in USD, can_create_proxy (whether proxy creation is allowed), and the prefix that starts every proxy username. Overdraft-enabled accounts also return credit_limit in USD and may return credit_limit_unlimited. Use can_create_proxy to check creation eligibility. For past deposits and charges, use listAccountBalanceHistory. Response fields: docs://account/getAccountBalance.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "additionalProperties": false
}

getAccountTrafficUsage

Get daily traffic and spend for the account over a date range, broken down by proxy. Returns, for each date with traffic, the bytes downloaded and uploaded and the USD spent per proxy resource ID; dates with no traffic are omitted. Pass user_proxy_list_id to report on one proxy. For per-proxy totals over a period, listProxyResources with statistic_from/statistic_to is simpler. Results are paginated: keep requesting pages while meta.pagination.hasMorePages is true. Response fields: docs://account/getAccountTrafficUsage.

read-only

Argument	Type	Description
page	integer	One-based page number; omitted or 0 uses page 1
limit	integer	Items per page, default 100, max 200
date_to*	string	End date in YYYY-MM-DD format, e.g. 2024-01-31
date_from*	string	Start date in YYYY-MM-DD format, e.g. 2024-01-01
user_proxy_list_id	string	Filter to a single proxy resource ID, from listProxyResources. Omit to get all proxies.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "date_from",
    "date_to"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "description": "One-based page number; omitted or 0 uses page 1"
    },
    "limit": {
      "type": "integer",
      "description": "Items per page, default 100, max 200"
    },
    "date_to": {
      "type": "string",
      "description": "End date in YYYY-MM-DD format, e.g. 2024-01-31"
    },
    "date_from": {
      "type": "string",
      "description": "Start date in YYYY-MM-DD format, e.g. 2024-01-01"
    },
    "user_proxy_list_id": {
      "type": "string",
      "description": "Filter to a single proxy resource ID, from listProxyResources. Omit to get all proxies."
    }
  },
  "additionalProperties": false
}

getProxyResource

Get full details of a specific proxy resource, including IP/host whitelists not present in listProxyResources. Returns the proxy with its password, IP whitelist, and target host whitelist. Response fields: docs://proxies/getProxyResource.

read-only

Argument	Type	Description
id*	string	Proxy resource ID, e.g. '86Rf07'. Get from listProxyResources.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID, e.g. '86Rf07'. Get from listProxyResources."
    }
  },
  "additionalProperties": false
}

listAccountBalanceHistory

Get balance transaction history for the account over a date range. Returns paginated ledger entries (top-ups, debits, refunds) with signed USD amount, source, and timestamp. For the current balance, use getAccountBalance. Response fields: docs://account/listAccountBalanceHistory.

read-only

Argument	Type	Description
page	integer	One-based page number; omitted or 0 uses page 1
limit	integer	Items per page, default 100, max 200
order	string	Sort direction: asc or desc, default desc
date_to*	string	End date in YYYY-MM-DD format, e.g. 2024-01-31
date_from*	string	Start date in YYYY-MM-DD format, e.g. 2024-01-01

Input schema (JSON)

{
  "type": "object",
  "required": [
    "date_from",
    "date_to"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "description": "One-based page number; omitted or 0 uses page 1"
    },
    "limit": {
      "type": "integer",
      "description": "Items per page, default 100, max 200"
    },
    "order": {
      "type": "string",
      "description": "Sort direction: asc or desc, default desc"
    },
    "date_to": {
      "type": "string",
      "description": "End date in YYYY-MM-DD format, e.g. 2024-01-31"
    },
    "date_from": {
      "type": "string",
      "description": "Start date in YYYY-MM-DD format, e.g. 2024-01-01"
    }
  },
  "additionalProperties": false
}

listGeoCountries

List all available countries for proxy geo targeting, optionally filtered by name. Returns each country's numeric id (for createProxyResource countries) and ISO code (for buildConnectionString country_code). Response fields: docs://geo/listGeoCountries.

read-only

Argument	Type	Description
search	string	Optional country name filter, minimum 2 characters, e.g. 'United'

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "search": {
      "type": "string",
      "description": "Optional country name filter, minimum 2 characters, e.g. 'United'"
    }
  },
  "additionalProperties": false
}

listProxyPlans

List tariff plans for a proxy type. Use the numeric id when calling createProxyResource. Returns each plan's id, title, price, currency, and traffic type (package or pay as you go). Response fields: docs://plans/listProxyPlans.

read-only

Argument	Type	Description
enabled	null \| boolean	Filter by enabled status. Default: true (only purchasable plans). Pass false to see all plans including disabled.
popular	null \| boolean	Filter by popular flag. Omit to return all plans regardless of popularity.
proxy_type*	string	Proxy type to list plans for, one of: residential, mobile

Input schema (JSON)

{
  "type": "object",
  "required": [
    "proxy_type"
  ],
  "properties": {
    "enabled": {
      "type": [
        "null",
        "boolean"
      ],
      "description": "Filter by enabled status. Default: true (only purchasable plans). Pass false to see all plans including disabled."
    },
    "popular": {
      "type": [
        "null",
        "boolean"
      ],
      "description": "Filter by popular flag. Omit to return all plans regardless of popularity."
    },
    "proxy_type": {
      "type": "string",
      "description": "Proxy type to list plans for, one of: residential, mobile"
    }
  },
  "additionalProperties": false
}

listProxyResources

List proxy resources in the account, with optional filters by name and status, and tariff, limits, traffic, and spend detail. Returns paginated proxies without passwords, plus totals for traffic and spend across the whole filtered set. Use getProxyResource for one proxy's password and whitelists. Response fields: docs://proxies/listProxyResources.

read-only

Argument	Type	Description
page	integer	One-based page number; omitted or 0 uses page 1
limit	integer	Items per page, default 100, max 200
order	string	Sort direction: asc or desc, default desc
search	string	Filter by proxy name (partial match, case-insensitive)
status	string	Filter by status: 'active', 'inactive', or comma-separated list e.g. 'active,inactive'
order_by	string	Sort field: name, status, tariff.name, traffic_used.total_used, total_spent, created_at
statistic_to	string	End date for per-proxy traffic statistics in YYYY-MM-DD format
statistic_from	string

regenerateProxyPassword

Generate a new password for a proxy resource. The old password is immediately invalidated — any running traffic using it will be interrupted. User confirmation is required before proceeding. Returns the complete proxy with the new password. Response fields: docs://proxies/regenerateProxyPassword.

destructive

Argument	Type	Description
id*	string	Proxy resource ID. Get from listProxyResources.
confirm	boolean	Set to true only after the user has explicitly confirmed the regeneration. Skips the confirmation step.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID. Get from listProxyResources."
    },
    "confirm": {
      "type": "boolean",
      "description": "Set to true only after the user has explicitly confirmed the regeneration. Skips the confirmation step."
    }
  },
  "additionalProperties": false
}

searchGeoCities

Search cities within a country and optional region (region_code from searchGeoRegions). Use search to narrow results — city lists can be large. Returns each city's extract_parameter, the value for buildConnectionString's city. Response fields: docs://geo/searchGeoCities.

read-only

Argument	Type	Description
search	string	City name search, minimum 2 characters, e.g. 'Los'
region_code	integer	Numeric region code to filter cities, from searchGeoRegions' 'code' field, e.g. 77 for California
country_code*	string	ISO country code, e.g. 'US', 'DE'

Input schema (JSON)

{
  "type": "object",
  "required": [
    "country_code"
  ],
  "properties": {
    "search": {
      "type": "string",
      "description": "City name search, minimum 2 characters, e.g. 'Los'"
    },
    "region_code": {
      "type": "integer",
      "description": "Numeric region code to filter cities, from searchGeoRegions' 'code' field, e.g. 77 for California"
    },
    "country_code": {
      "type": "string",
      "description": "ISO country code, e.g. 'US', 'DE'"
    }
  },
  "additionalProperties": false
}

searchGeoISP

Search the ISP catalog for mobile ISP targeting (mobile proxies only). Always resolve the code through this tool — never accept a real-world ASN number as a substitute. Returns each carrier's name and catalog code, the value for buildConnectionString's isp. Response fields: docs://geo/searchGeoISP.

read-only

Argument	Type	Description
limit	integer	Max results, default 100, max 500
search	string	ISP name substring search, minimum 3 characters, e.g. 'AT&T'

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "description": "Max results, default 100, max 500"
    },
    "search": {
      "type": "string",
      "description": "ISP name substring search, minimum 3 characters, e.g. 'AT&T'"
    }
  },
  "additionalProperties": false
}

searchGeoRegions

Search regions/states within a country, identified by its ISO country_code (from listGeoCountries). Returns each region's extract_parameter, the value for buildConnectionString's state, and its numeric code, used as searchGeoCities' region_code. Response fields: docs://geo/searchGeoRegions.

read-only

Argument	Type	Description
search	string	Optional region name filter, minimum 3 characters, e.g. 'California'
country_code*	string	ISO country code, e.g. 'US', 'DE', 'GB'

Input schema (JSON)

{
  "type": "object",
  "required": [
    "country_code"
  ],
  "properties": {
    "search": {
      "type": "string",
      "description": "Optional region name filter, minimum 3 characters, e.g. 'California'"
    },
    "country_code": {
      "type": "string",
      "description": "ISO country code, e.g. 'US', 'DE', 'GB'"
    }
  },
  "additionalProperties": false
}

searchGeoZips

Search ZIP codes within a country, for use in proxy username params. Returns ZIP values to pass as buildConnectionString's zip; ZIP targeting cannot be combined with state or city. Response fields: docs://geo/searchGeoZips.

read-only

Argument	Type	Description
limit	integer	Max results, default 100, max 500
search	string	ZIP substring search, minimum 3 characters, e.g. '123'
country_code*	string	ISO country code, e.g. 'US', 'DE'

Input schema (JSON)

{
  "type": "object",
  "required": [
    "country_code"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "description": "Max results, default 100, max 500"
    },
    "search": {
      "type": "string",
      "description": "ZIP substring search, minimum 3 characters, e.g. '123'"
    },
    "country_code": {
      "type": "string",
      "description": "ISO country code, e.g. 'US', 'DE'"
    }
  },
  "additionalProperties": false
}

setProxyIpWhitelist

Replace the IP whitelist for a proxy resource, restricting authentication to the given IPs. This controls who can authenticate; to control which domains the proxy can reach, use setProxyTargetHosts. Returns the updated proxy with the applied IP whitelist. Response fields: docs://proxy-settings/setProxyIpWhitelist.

Argument	Type	Description
id*	string	Proxy resource ID. Get from listProxyResources.
ips*	null \| array	List of allowed IP addresses, e.g. ['203.0.113.1', '198.51.100.42']. Empty array removes all IP restrictions.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id",
    "ips"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID. Get from listProxyResources."
    },
    "ips": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "string"
      },
      "description": "List of allowed IP addresses, e.g. ['203.0.113.1', '198.51.100.42']. Empty array removes all IP restrictions."
    }
  },
  "additionalProperties": false
}

setProxyLimits

Set the traffic or spending limit on a proxy resource to control costs. A proxy has one limit: this call replaces any existing limit, and total_limit 0 removes it. The counter resets daily or monthly according to time_period. Returns the updated proxy with the applied limits. To change other settings in the same call, use updateProxyResource. Response fields: docs://proxy-settings/setProxyLimits.

Argument	Type	Description
id*	string	Proxy resource ID. Get from listProxyResources.
limit_type*	string	'money' = USD spend cap, 'traffic' = bytes cap
time_period*	string	Reset period for the limit counter, one of: daily, monthly
total_limit*	number	Limit value: USD amount for 'money' (e.g. 50.00), bytes for 'traffic' (e.g. 1073741824 = 1GB). Set to 0 to remove the limit.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id",
    "limit_type",
    "time_period",
    "total_limit"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID. Get from listProxyResources."
    },
    "limit_type": {
      "type": "string",
      "description": "'money' = USD spend cap, 'traffic' = bytes cap"
    },
    "time_period": {
      "type": "string",
      "description": "Reset period for the limit counter, one of: daily, monthly"
    },
    "total_limit": {
      "type": "number",
      "description": "Limit value: USD amount for 'money' (e.g. 50.00), bytes for 'traffic' (e.g. 1073741824 = 1GB). Set to 0 to remove the limit."
    }
  },
  "additionalProperties": false
}

setProxyTargetHosts

Replace the target host whitelist for a proxy resource, restricting its traffic to the given domains. This controls where the proxy can connect; to control who can authenticate, use setProxyIpWhitelist. Returns the updated proxy with the applied target host whitelist. Response fields: docs://proxy-settings/setProxyTargetHosts.

Argument	Type	Description
id*	string	Proxy resource ID. Get from listProxyResources.
target_hosts*	null \| array	List of allowed domains, e.g. ['example.com', '*.api.service.com']. Empty array removes all restrictions.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id",
    "target_hosts"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID. Get from listProxyResources."
    },
    "target_hosts": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "string"
      },
      "description": "List of allowed domains, e.g. ['example.com', '*.api.service.com']. Empty array removes all restrictions."
    }
  },
  "additionalProperties": false
}

updateProxyResource

Update description, countries, status, IP whitelist, or limits in one call. Name and proxy_type are not mutable through this MCP tool. For single-field changes, prefer setProxyIpWhitelist, setProxyLimits, or deactivateProxyResource. Returns the complete updated proxy without its password. Response fields: docs://proxies/updateProxyResource.

Argument	Type	Description
id*	string	Proxy resource ID. Get from listProxyResources.
limits	null \| object	New spend or traffic limit. Replaces the existing limit.
status	string	New status, one of: active, inactive
countries	null \| array	Replacement country IDs; empty clears.
description	string	New description. See createProxyResource's description field for what to include.
ip_whitelist	null \| array	New IP whitelist. Replaces the existing list entirely. Empty array removes all restrictions.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Proxy resource ID. Get from listProxyResources."
    },
    "limits": {
      "type": [
        "null",
        "object"
      ],
      "required": [
        "limit_type",
        "time_period",
        "total_limit"
      ],
      "properties": {
        "limit_type": {
          "type": "string",
          "description": "'money' = USD spend cap, 'traffic' = bytes cap"
        },
        "time_period": {
          "type": "string",
          "description": "Reset period for the limit counter, one of: daily, monthly"
        },
        "total_limit": {
          "type": "number",
          "description": "Limit value: USD amount for 'money', bytes for 'traffic'"
        }
      },
      "description": "New spend or traffic limit. Replaces the existing limit.",
      "additionalProperties": false
    },
    "status": {
      "type": "string",
      "description": "New status, one of: active, inactive"
    },
    "countries": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "integer",
        "minimum": 0
      },
      "description": "Replacement country IDs; empty clears."
    },
    "description": {
      "type": "string",
      "description": "New description. See createProxyResource's description field for what to include."
    },
    "ip_whitelist": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "string"
      },
      "description": "New IP whitelist. Replaces the existing list entirely. Empty array removes all restrictions."
    }
  },
  "additionalProperties": false
}

2extract

Try it

buildConnectionString Read-only

2extract

Try it

buildConnectionString Read-only

Tools (20)