BuyProxy CLI — Generate Residential Proxies from Your Terminal

The official command-line tool for BuyProxy: generate residential, mobile, ISP and datacenter proxies, check bandwidth, buy more by card or crypto, and run a proxy reseller business — from a polished interactive terminal UI, or from scripts with --json.

Keywords: proxy CLI · residential proxy generator · rotating proxies · SOCKS5 · web scraping tools · proxy reseller · BuyProxy command line

Install

The CLI isn't released yet: it isn't on Homebrew or npm, and there's no release to download.

Get started

buyproxy login          # paste your API key (Dashboard → API keys)
buyproxy                # interactive mode

Don't have an account yet? buyproxy signup creates one without leaving the terminal.

Interactive mode

Run buyproxy with no arguments for a guided experience — arrow keys to move, enter to choose, q to quit:

  ██████╗ ██╗   ██╗██╗   ██╗██████╗ ██████╗  ██████╗ ██╗  ██╗██╗   ██╗
  ██╔══██╗██║   ██║╚██╗ ██╔╝██╔══██╗██╔══██╗██╔═══██╗╚██╗██╔╝╚██╗ ██╔╝
  ██████╔╝██║   ██║ ╚████╔╝ ██████╔╝██████╔╝██║   ██║ ╚███╔╝  ╚████╔╝
  ██╔══██╗██║   ██║  ╚██╔╝  ██╔═══╝ ██╔══██╗██║   ██║ ██╔██╗   ╚██╔╝
  ██████╔╝╚██████╔╝   ██║   ██║     ██║  ██║╚██████╔╝██╔╝ ██╗   ██║
  ╚═════╝  ╚═════╝    ╚═╝   ╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═╝   ╚═╝

  Residential, mobile, ISP & datacenter proxies  ·  v1.0.0
  www.buyproxy.org  ·  docs: buyproxy docs

╭─ BuyProxy ───────────────────────────────────────╮
│ Signed in   you@example.com  pro                 │
│ Bandwidth   8.50 GB                              │
╰──────────────────────────────────────────────────╯

? What would you like to do? (↑/↓ move · enter select · q quit)
  ❯ Generate proxies     rotating or sticky, geo-targeted
    Bandwidth & plans    what's left on each product
    Buy bandwidth        card or crypto
    Subscribe to a plan  Pro · Business · Advanced
    Test a proxy         exit IP, location, latency
    Payment history
    Open dashboard
    Account
    Log out
    Quit

Gradient banner, spinners, usage bars, boxed results and colour that respects NO_COLOR. Reseller keys get a reseller-specific menu (customers, pool).

Commands

Command	What it does
buyproxy generate [product]	Generate proxies — rotating or sticky, geo-targeted (-c US -n 5 -s 10)
buyproxy test	Generate a proxy and prove it works: exit IP, location, network, latency
buyproxy balance	Bandwidth left on every product, with usage bars
buyproxy plans	Your plans and what each one can generate
buyproxy topup [product]	Buy bandwidth by card or crypto, opens checkout and waits for the payment
buyproxy subscribe [plan]	Subscribe to Pro / Business / Advanced, monthly or yearly
buyproxy products	Catalog with live per-GB prices
buyproxy transactions	Payment history (or buyproxy tx <id> --wait)
buyproxy customers …	Reseller: new, show, rename, suspend, activate, usage, allocate, generate
buyproxy pool [topup]	Reseller: your unallocated bandwidth
buyproxy login / logout / whoami / signup	Account
buyproxy dashboard / docs	Open the dashboard or API docs
buyproxy completion bash|zsh|fish	Shell completions

Every command accepts --json (machine-readable, no colour, no prompts), --key <key> and --help. Run buyproxy help <command> for examples.

Recipes

Export a proxy into your shell — every tool that honours HTTP_PROXY now uses it:

eval "$(buyproxy generate residential -c US -f env)"
curl https://api.ipify.org

Dump 100 sticky German proxies to a file:

buyproxy generate premium -c DE -n 100 -s 30 -f plain > proxies.txt

Paste straight into code:

buyproxy generate -c US -f playwright --copy   # Playwright launch options on your clipboard
buyproxy generate -f requests                  # Python `requests` snippet
buyproxy generate -f curl                      # ready-to-run curl command

Formats: url (default in a terminal), plain, json, env, curl, playwright, requests.

Check the network is healthy before a big job:

buyproxy test premium -c JP

Run a reseller business from the terminal:

buyproxy pool topup residential --gb 500 --card
buyproxy customers new "Acme Inc"
buyproxy customers allocate bp_acme_1a2b premium 20
buyproxy customers generate bp_acme_1a2b -c DE -n 5
buyproxy customers suspend bp_acme_1a2b

Script it:

buyproxy balance --json | jq '.balances[] | select(.activeGb < 1)'

When stdout isn't a terminal the CLI prints data only — no banners, no colour — so pipes just work.

Configuration

Setting	How
API key	buyproxy login (stored in ~/.config/buyproxy/config.json, mode 0600), BUYPROXY_API_KEY, or --key
Alternate API host	BUYPROXY_BASE_URL
Disable colour	NO_COLOR=1 or --no-color
Debug stack traces	BUYPROXY_DEBUG=1

Key precedence: --key → BUYPROXY_API_KEY → saved config. Personal keys (bp_key_…) and reseller keys (bp_live_…) are detected automatically.

Exit codes

0 success · 1 API or network error · 2 usage error (bad flag, missing login) · 130 cancelled.

FAQ

Where do I get an API key? Create a free account at buyproxy.org, then Dashboard → API keys.

What does it cost? The CLI is free and MIT-licensed. Proxy bandwidth starts at $0.29/GB (IPv6) — residential is $0.99/GB — see buyproxy products for live prices.

What does buyproxy test contact? It generates one proxy and requests https://ipinfo.io/json through it to show the exit IP, location and network — a few kilobytes of your bandwidth. Nothing else is sent anywhere.

Does it work on Windows? Yes — anywhere Node.js 18+ runs. Install with npm.

Is the SDK available in my language? Yes: Node.js · Python · Go · PHP · Ruby · Java · .NET · Rust.

Development

npm install
npm run typecheck && npm test && npm run build
node bin/buyproxy.js --help

The CLI is built on the buyproxy SDK, bundled into a single dependency-free file at build time. Contributions welcome — see CONTRIBUTING.md.

Links

• Website: https://www.buyproxy.org · Docs: https://www.buyproxy.org/docs/sdks · Support: support@buyproxy.org

License

MIT © BuyProxy