Ruby SDK

Installation

gem install buyproxy
# or in your Gemfile:
bundle add buyproxy

Ruby 3.0+. No runtime dependencies (uses Net::HTTP).

Authentication

Create an API key under Dashboard → API keys — personal keys start bp_key_, reseller keys bp_live_. The SDK reads BUYPROXY_API_KEY from the environment automatically; you can also pass the key explicitly. A missing key fails immediately with an authentication error, without a network call.

# 1. Environment variable (recommended)
bp = BuyProxy::Client.new

# 2. Explicit key, e.g. from Rails credentials
bp = BuyProxy::Client.new(api_key: Rails.application.credentials.dig(:buyproxy, :api_key))

# 3. Which kind of key is it?
puts bp.key_kind # "personal" | "reseller" | nil

Quick start

require "buyproxy"

bp = BuyProxy::Client.new(api_key: ENV["BUYPROXY_API_KEY"]) # or omit — reads BUYPROXY_API_KEY

plan = bp.plans.list.first
result = bp.plans.generate(plan.id, country: "US", city: "Austin", count: 5)

puts result.first.url # http://user-country-us-city-austin:pass@gw.buyproxy.org:6969

Pass sticky_minutes: 10 to keep the same IP for ten minutes, or protocol: "socks5" for SOCKS5.

Generating proxies

Generation is free and instant — bandwidth is only consumed when traffic flows through a proxy. Every parameter is optional; omit one and the API's default applies. (Names follow each language's conventions, e.g. stickyMinutes / sticky_minutes / StickyMinutes.)

Each returned line is username:password@host:port with your targeting encoded in the username. Lines are on-demand and not persistent — generate fresh ones when you need them instead of storing them, because credentials can rotate when the pool moves.

# Country, state and city — what a plan supports is in plan.generate.targeting
bp.plans.generate(plan.id, country: "US", state: "California", city: "Los Angeles")

# Sticky session: keep one IP for 30 minutes (max is plan.generate.max_sticky_minutes)
bp.plans.generate(plan.id, country: "DE", sticky_minutes: 30)

# SOCKS5 instead of HTTP
bp.plans.generate(plan.id, protocol: "socks5", count: 10)

# Bulk: up to 1000 lines per call
result = bp.plans.generate(plan.id, count: 1000)
File.write("proxies.txt", result.lines.join("\n"))

Every top-up and allocation call takes a product key. Live prices come from the catalog call, so you never hard-code a rate.

Pay-as-you-go top-ups of 100 GB or more include a 10% volume bonus, and a single order is capped at 10,000 GB.

Using the proxies with your stack

Each generated proxy is a small object (host, port, username, password, protocol) with helpers that return exactly what common clients expect, so you never hand-build a proxy URL or worry about percent-encoding special characters in a password.

conn = Faraday.new(proxy: result.first.to_faraday)
puts conn.get("https://api.ipify.org").body

puts HTTParty.get("https://api.ipify.org", **result.first.to_httparty).body

uri = URI("https://api.ipify.org")
http = Net::HTTP.new(uri.host, uri.port, *result.first.to_net_http)
http.use_ssl = true
puts http.get(uri.request_uri).body

# config/initializers/buyproxy.rb
BUYPROXY = BuyProxy::Client.new(api_key: Rails.application.credentials.dig(:buyproxy, :api_key))

Account, balances & history

Read-only calls for building dashboards, alerts and pre-flight checks. balances is the one to watch: it shows spendable GB per product, including GB from a payment that's still being added (pending).

catalog = bp.products.list          # product keys & live prices — no API key needed
account = bp.account.get            # email, plan, lifetime GB
balances = bp.balances.list         # spendable GB per product (+ GB still arriving)
plans = bp.plans.list               # plan ids and what each can generate
history = bp.transactions.list(limit: 20)

Buying bandwidth

1. Call the top-up method — it returns a hosted payment URL and a transaction id. Card payments are processed by Stripe Checkout; crypto by an invoice page.
2. Send your user (or yourself) to that URL to pay.
3. Poll the transaction (or use the SDK's wait helper) until status is succeeded or failed. Crypto payments are checked live on every poll, so they settle even if a webhook is delayed.
4. The GB shows up under balances within seconds — pendingGb while it's arriving, activeGb once it's live.

Plans are subscriptions billed monthly or yearly by card (crypto only covers pay-as-you-go top-ups). If the account already has a subscription, the call returns the subscription settings page as the URL and a null transaction id — switching plans is prorated there, and you can't accidentally subscribe twice.

# Buy 10 GB of Core Residential by card — send the customer to pay_url
checkout = bp.topup.card(product_key: "residential", gb: 10)
puts checkout.pay_url

# Or subscribe to a plan (monthly or yearly)
bp.topup.card(plan: "pro", interval: "year")

# Crypto (pay-as-you-go top-ups only)
bp.topup.crypto(product_key: "residential", gb: 50)

# Wait for the payment to settle — GB appears on bp.balances.list right after
tx = bp.transactions.wait(checkout.transaction_id)
puts tx.status # "succeeded"

Card payments are processed by Stripe; crypto top-ups are pay-as-you-go only. Subscriptions can be managed or cancelled from Dashboard → Billing.

Reseller API

The reseller API lets you build a proxy product on top of BuyProxy. The flow is always the same:

1. Fund your pool — buy GB per product into your reseller pool by card or crypto. Pool GB is priced like a normal top-up (including the volume bonus), fixed at purchase time.
2. Create a customer — an isolated sub-account with its own credentials and no bandwidth. Store the returned username.
3. Allocate — move whole GB of one product from your pool onto that customer, with an idempotency key. The first allocation of a product creates the plan; later ones add to it.
4. Generate — produce proxy lines for the customer from their plan id (found on the customer record), with all the usual targeting options.
5. Monitor — read the customer's usage (remaining, used, total per plan, plus any GB still arriving) to bill or alert.
6. Suspend / reactivate — a suspended customer can't generate new lines (403). Lines already handed out may keep working until they rotate, so stop distributing them at the same time. You can also rename a customer.

Allocated GB can't be moved back to the pool, so allocate what a customer has paid for.

reseller = BuyProxy::Client.new(api_key: "bp_live_…")

reseller.reseller.pool.topup_card(product_key: "residential", gb: 500)        # buy into your pool
customer = reseller.reseller.customers.create(label: "Acme Inc")             # isolated sub-account

reseller.reseller.customers.allocate(customer.username, product_key: "residential", gb: 20, idempotency_key: "order-1042")

detail = reseller.reseller.customers.get(customer.username)
result = reseller.reseller.customers.generate(customer.username, plan_id: detail.plans.first.id, country: "DE")

reseller.reseller.customers.update(customer.username, status: "suspended")

Allocating bandwidth to a customer moves real GB, so it accepts an idempotency key. Send the same key twice and the second call moves nothing and returns alreadyApplied: true with the same result — safe to retry after a timeout or crash.

Use a value you can derive again from your own data (an order id, an invoice number), not a random value created per attempt. Keys are scoped to your account and may be up to 200 characters.

Errors & retries

Every non-success response becomes a typed error carrying the HTTP status and the API's own message, so you can branch on the failure instead of parsing strings.

begin
  bp.plans.generate(plan_id)
rescue BuyProxy::InsufficientBandwidthError
  puts "Out of GB — top up first"
rescue BuyProxy::RateLimitError => e
  puts "Slow down; retry in #{e.retry_after}s"
rescue BuyProxy::AuthenticationError
  puts "Check your API key"
end

Every error inherits from BuyProxy::Error and exposes #status and #body.

Every SDK retries for you, with the same rules:

• Rate limits (`429`) are always retried, waiting for the Retry-After the API sends (capped at 30 s) or an exponential back-off with jitter.
• Reads (GET) are also retried on 502/503/504 and on network failures.
• Writes are not retried on server errors — a repeated checkout or allocation must never double-charge — unless you attach an idempotency key (see below), which makes the retry provably safe.
• The default is 2 retries; set it to 0 to turn retries off. After the last attempt you get the typed error.

The API allows 60 requests per minute per key. Batch with count (up to 1000 lines per call) rather than looping over single-proxy calls.

Configuration

BuyProxy::Client.new(
  api_key: "bp_key_…",                    # default: ENV["BUYPROXY_API_KEY"]
  base_url: "https://www.buyproxy.org",
  timeout: 30,
  max_retries: 2,                          # 429s always; 5xx only for safe requests
  transport: MyTransport.new               # responds to #call(method, uri, headers, body, timeout)
)

Concurrency

# The client holds no mutable state, so it can be shared between threads
threads = plans.map { |p| Thread.new { bp.plans.generate(p.id, count: 10) } }
results = threads.map(&:value)

Testing your code

You don't need a real account or network to unit-test code that uses the SDK — inject a fake transport. This is how the SDK's own test suite works.

# Any object responding to #call(method, uri, headers, body, timeout) is a transport
transport = lambda do |_method, _uri, _headers, _body, _timeout|
  [200, {}, '{"lines":["u:p@gw.buyproxy.org:6969"]}']
end

bp = BuyProxy::Client.new(api_key: "bp_key_test", transport: transport)
assert_equal "gw.buyproxy.org", bp.plans.generate("plan_1").first.host

API reference

Every method maps one-to-one onto a documented REST endpoint.

Notes

• Every error inherits from BuyProxy::Error and exposes #status and #body.

• Proxy has helpers for Faraday, HTTParty, Net::HTTP and environment variables.

• In a Rails app, create one client in an initializer and reuse it.

Developing the SDK

bundle install
bundle exec rake test