Proxy API docs & connection methods
Learn how to integrate IPKite residential proxies into your code/tools, plus developer API examples for checking balance, purchases, and proxy lists.
Residential proxy quick start
After purchasing residential proxies, your member page displays proxy credentials. Use a single endpoint with username parameters for country/city/session control. Test connectivity instantly with this one-line command:
- Purchase: Select Desired GBs on the Member Screen to Buy Residential Proxies.
- Check: Verify the proxy username (USERNAME) and password (PASSWORD) on the member screen.
- Connection: Send requests to gw.ipkite.com using HTTP port 7000 or SOCKS5 port 7100.
curl -x http://USERNAME:PASSWORD@gw.ipkite.com:7000 https://example.com/Proxy Connection Details Format
All residential proxy connections use the same address. Send HTTP/HTTPS requests to port 7000, SOCKS5 to port 7100. Append parameters with hyphens to the username - use only the parameters you need.
| Item | Price | Description |
|---|---|---|
| Address | gw.ipkite.com | Connection details for all residential proxies |
| HTTP, HTTPS port | 7000 | Connect to HTTP and HTTPS sites via HTTP proxy |
| SOCKS5 Port | 7100 | Connect using tools and apps that support SOCKS5 |
| cc | Two-letter country code (lowercase) | Example: cc-us, cc-gb, cc-de |
| city | City name (lowercase, no spaces) | Example: city-newyork, city-london |
| sess | Alphanumeric Session Name | Maintain same IP while using identical values |
| ttl | 1-1,440 (minutes) | Duration to maintain sticky session |
USERNAME-cc-us-city-newyork-sess-a1b2c3-ttl-30:PASSWORD@gw.ipkite.com:7000Examples of rotating proxies and sticky sessions
Without sess in your username, you'll get rotating proxies (new IP per request). Add sess and ttl for sticky sessions (same IP for 1-1,440 minutes). Change sess value when you need a new IP.
curl -x http://USERNAME:PASSWORD@gw.ipkite.com:7000 https://example.com/
curl -x http://USERNAME:PASSWORD@gw.ipkite.com:7000 https://example.com/Example of country and city targeting
Use the cc parameter to select from 174 countries/regions and the city parameter to narrow down to major cities. Country and city targeting works with both rotating and sticky sessions.
curl -x http://USERNAME-cc-de:PASSWORD@gw.ipkite.com:7000 https://example.com/Python Requests Proxy Example
In Python requests, use the same proxy address for both HTTP and HTTPS in the proxies value. For SOCKS5, install requests[socks] and change the address to socks5h://.
import requests
proxy = "http://USERNAME-cc-us-sess-a1b2c3-ttl-30:PASSWORD@gw.ipkite.com:7000"
proxies = {"http": proxy, "https": proxy}
r = requests.get("https://example.com/", proxies=proxies, timeout=30)
print(r.status_code)Node.js Proxy Example
In Node.js, connect using undici’s ProxyAgent or the https-proxy-agent package. Both methods require just one line of proxy address.
import { ProxyAgent, fetch } from "undici";
const agent = new ProxyAgent("http://USERNAME-cc-de:PASSWORD@gw.ipkite.com:7000");
const res = await fetch("https://example.com/", { dispatcher: agent });
console.log(res.status);Developer API authentication and base URL
Our REST API returns JSON responses. Generate an API key in your account (starts with ipk_live_) and store it securely. Include it in Authorization headers as 'Bearer [API_KEY]'.
- Base URL: https://ipkite.com/api/v1
- Auth Header: Authorization: Bearer <API Key>
- Call limit: 120 times per minute
- Response format: JSON, returns "ok": true on success
curl https://ipkite.com/api/v1/balance \
-H "Authorization: Bearer ipk_live_YOUR_API_KEY"Developer API endpoints
| Method | Path | Content | Key Response Values |
|---|---|---|---|
| GET | /balance | Current Balance | balance, currency |
| GET | /orders | Purchase Details List | code, product, summary, amount, status, created_at |
| GET | /proxies | Purchased Proxy List | Residential: username, password, host, http_port, socks_port, traffic_gb_left / Static IP: ip, port, username, password, country, expires_at |
{"ok":true,"balance":"25.00","currency":"USD"}API error responses and rate limits
If the API key is missing or incorrect, you'll receive an HTTP 401 response with the message below. Check the header name, the space after 'Bearer,' and ensure the full key is included. The rate limit is 120 calls per minute. For periodic balance or traffic checks, once per minute is sufficient to stay within the limit.
{"ok":false,"error":"unauthorized"}