Birdie Proxies API

A small, read-only API for your own account: what you hold, what you have bought, and what you have used. Made for dashboards, alerts and billing scripts.

What it covers

Every call is a GET against your own account. There is nothing here that buys, tops up, rotates a key or changes a setting; a leaked key can only read.

  • Plans: one entry per product you hold, with total, used and remaining gigabytes and the endpoint to connect to.
  • Orders: every purchase, with what it cost, any discount, and when it was paid and credited.
  • Usage: bandwidth per product per hour or day, for the last day, week or month.
  • Account: who the key belongs to.

Quick start

Make a key under Account, API keys in the dashboard. It is shown once; keep it somewhere safe, such as an environment variable. Then:

curl https://birdieproxies.com/api/plans \
  -H "Authorization: Bearer $BIRDIE_API_KEY"
200 OK
[
  {
    "type": "residential",
    "billing": "data",
    "plan_name": "Resi V1",
    "data_total_gb": 50,
    "data_used_gb": 12.4,
    "data_remaining_gb": 37.6,
    "used_last_30d_gb": 9.8,
    "expires_at": null,
    "status": "active",
    "proxy": {
      "username": "your_username",
      "host": "rp.birdieproxies.com",
      "hard_session_host": "hard.birdieproxies.com",
      "http_port": 1000,
      "socks5_port": 1002
    }
  }
]

Conventions

  • Base URL: https://birdieproxies.com/api. Everything is HTTPS and JSON.
  • Money is in minor units of the currency: amount_pence with currency: "GBP". Divide by 100 for pounds. No floats for money.
  • Data is in gigabytes (1 GB = 1024 MB) on plans, and in bytes on usage, where precision matters.
  • Times are ISO 8601 in UTC, such as 2026-09-22T09:14:00.000Z. Data never expires, so expires_at on a plan is always null.
  • Product types are lower-case and stable: residential, shared_datacenter, datacenter, mobile.
  • Responses are never cached: every call is answered from the live balance.

Version 1

This is version 1. Fields may be added at any time; nothing listed here will be renamed or removed without a new base path (/api/v2). The same endpoints also answer at /api/customer/v1/….