API

MCP server

The Proxya MCP server lets AI clients such as Claude Code, Cursor and VS Code work with the account through tools. It works with the same API key and has no powers beyond the key's permissions.

Updated 22 November 2026

Address#

Text
https://proxya.co/api/mcp

The server uses the Streamable HTTP transport and protocol versions 2025-03-26, 2025-06-18 and 2025-11-25. The API key goes in the Authorization: Bearer header. Clients that connect remote servers only through an OAuth sign-in cannot connect to it.

Connecting a client#

In each example the key is read from the PROXYA_API_KEY environment variable or asked for when the server starts, so it does not end up in a config file.

claude mcp add --transport http proxya https://proxya.co/api/mcp \
  --header "Authorization: Bearer $PROXYA_API_KEY"

Cursor reads ~/.cursor/mcp.json, or .cursor/mcp.json in the project. VS Code reads .vscode/mcp.json in the workspace.

Checking the connection#

The server answers tools/list with the tools the key may use.

Shell
curl -X POST https://proxya.co/api/mcp \
  -H "Authorization: Bearer $PROXYA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}'

Tools#

A client sees only the tools the key's permissions allow.

ToolPermissionDoes
get_accountreadEmail, balance and the key's permissions
list_ordersreadList of orders
get_orderread, credentialsOrder with proxies
get_pricesreadPrice list
check_stockreadStock by location
list_mobile_locationsreadMobile locations
list_transactionsreadBalance history
residential_balancereadResidential traffic balance
get_whitelistreadIP whitelist of an order
generate_residential_proxiescredentialsResidential proxy lines
add_whitelist_ipcredentialsAdd an IP to the whitelist
quote_orderpurchasePrice of a new order and a quote_id
quote_renewalpurchasePrice of a renewal and a quote_id
confirm_purchasepurchaseBuys what the quote describes
change_proxy_passwordmanageNew proxy password
remove_whitelist_ipmanage, credentialsRemove an IP from the whitelist
rotate_mobile_ipmanageNew mobile IP now

Purchases#

  1. quote_order or quote_renewal

    Returns the price and a quote_id valid for 15 minutes. Nothing is bought.

  2. The client shows the price

    confirm_purchase is marked as an action that changes data, and MCP clients ask the user before running such a tool.

  3. confirm_purchase

    Buys what the quote describes and charges the balance. The quote_id serves as the Idempotency-Key: calling the tool again with it returns the same order.

Limits and security#

  • Each tool calls the ordinary API with the same key and the same address. Permissions, the daily limit, the IP list, rate limits and the key's log apply as they do to the API.
  • A quote can be confirmed only with the key that made it.
  • Requests from web pages of other sites are refused.

Didn't find the answer?

Support answers in the chat on this site around the clock. On Telegram the reply usually comes fastest, and a ticket gets an answer by email.