Connecting to the proxies
The API tells you where to connect; this page is how. Hosts, ports, and the password suffixes that pick a country or hold a session.
Endpoints
Each plan entry from plans carries a proxy object with the host and ports for that product. HTTP and HTTPS share the HTTP port (HTTPS is tunnelled with CONNECT); SOCKS5 has its own.
residentialres.birdieproxies.com | HTTP 1000, SOCKS5 1002. Hard sessions use hard.birdieproxies.com on the same ports. |
Username and password
The proxy username is your account username (username on plans and on the account endpoint). The proxy password is the per-product key shown on the dashboard's Generate page. It is not returned by the API: the API is read-only and a leaked API key must not become a way to spend your data.
Targeting and sessions
Options are appended to the password as _key-value pairs, in any order. Leave them all off for a fresh IP on every request from anywhere.
_country-GBISO 3166-1 alpha-2 | Exit from one country. |
_region-… _city-…id from the generator | Narrower than a country. Pick the id on the Generate page; names are not accepted. |
_session-abcd12348 characters | Sticky session: the same IP for every request that carries the same id, for the lifetime below. |
_lifetime-30minutes, 1 to 120 | How long a sticky session holds its IP. Only meaningful with a session. |
_hardsession-abcd123459 characters | Hold the IP for as long as the network can, with no lifetime. Connect to hard.birdieproxies.com for these. |
The Generate page is the source of truth
It lists every option, the ids for regions, cities and providers, and shows the exact string to paste. Use it to build a template, then substitute the session id from your code.Examples
# rotating, any country
curl -x http://USERNAME:[email protected]:1000 https://api.ipify.org
# UK, sticky for 30 minutes
curl -x "http://USERNAME:PASSWORD_country-GB_session-abcd1234_lifetime-30@res.birdieproxies.com:1000" https://api.ipify.org- Sessions are per product and per host: the same id on the residential and mobile hosts is two different sessions.
- A sticky session that goes quiet for its whole lifetime is released, and the next request with that id gets a new IP.
- Bandwidth is measured on the proxy as it flows and shows up on usage within a few minutes, and on the balance as it is consumed.