Docs and API
Three lines
to your first request.
The endpoint and credentials for each order are in your dashboard, and a REST API covers everything the dashboard does. No SDK to install unless you want one.
curl -x HOST:PORT \
-U "USERNAME:PASSWORD" \
https://api.ipify.org?format=json200 {"ip":"73.14.208.117"}
- Endpoint
- HOST:PORT
- Listed on each order in the dashboard. ISP and datacenter IPs are each their own.
- Auth
- username:password
- Or add an IP allowlist and skip credentials entirely.
- Protocols
- HTTP · HTTPS · SOCKS5
- Same port, negotiated automatically.
Your client
HTTP · HTTPS · SOCKS5
Your endpoint
HOST:PORT
The pool
one cell, one exit IP
Target site
sees the exit IP
Reference
What the API covers
A question these do not answer goes to [email protected], where a person reads it.
Getting started
Create a key, point your client at the endpoint your order lists, make a request. The whole thing is three lines in most languages.
Targeting and sessions
Country, region, city and carrier selection on ISP and datacenter, sticky sessions on residential, and how rotation behaves per pool.
Management API
REST endpoints for provisioning ISP and dedicated IPs, creating sub-users, setting per-key limits and pulling usage.
Operations
Status codes we return, how to read a failure, and retry guidance.
Before you build
Two pages worth reading first
One tells you which line fits the job, the other what you may point it at.
Questions
API, answered
- How do I get an API key?
- Sign up, open the dashboard, and generate one. It takes about a minute and does not require a card. The free gigabyte is available immediately.
- Is there one endpoint for all products?
- No. Each order in the dashboard lists the host, port and credentials to use with it, and every ISP or datacenter IP is an endpoint of its own. Copy them from the order rather than from this page.
- How do I hold the same IP across requests?
- On residential, name a session in your credentials; the dashboard shows the exact format for your account. Drop it and you rotate on every request. ISP and datacenter addresses are static, so they need no session at all.
- Are there rate limits?
- Concurrency is unlimited on bandwidth plans. The management API is limited per key, and the limit is returned in the response headers so your client knows when to back off.