Docs and API
Three lines
to your first request.
One gateway host for every product, credentials that carry your targeting, and a REST API for everything the dashboard does. No SDK to install unless you want one.
curl -x gateway.proxyhive.io:7000 \
-U "user-YOURKEY-country-us-session-a91f:PASSWORD" \
https://api.ipify.org?format=json200 {"ip":"73.14.208.117"}
- Endpoint
- gateway.proxyhive.io:7000
- One host for every product. The credential decides the pool.
- Auth
- username:password
- Or add an IP allowlist and skip credentials entirely.
- Protocols
- HTTP · HTTPS · SOCKS5
- Same port, negotiated automatically.
Reference
What is in the docs
Written by the people who run the network, kept in step with what it actually does.
Getting started
Create a key, point your client at the gateway, make a request. The whole thing is three lines in most languages.
- Quickstart
- Authentication
- Your first request
- Client examples
Targeting and sessions
Country, state, city and ASN selection, sticky sessions, and how rotation actually behaves per pool.
- Geo-targeting
- Sticky sessions
- Rotation behaviour
- ASN selection
Management API
REST endpoints for provisioning ISP and dedicated IPs, creating sub-users, setting per-key limits and pulling usage.
- IP provisioning
- Sub-users
- Usage and billing
- Rate limits
Operations
Status codes we return, how to read a failure, retry guidance, and the metrics endpoint behind the benchmarks page.
- Error reference
- Retry guidance
- Metrics endpoint
- Status page
The full reference lives in the app alongside your keys, so every example is filled in with your own credentials rather than placeholders. Open the reference.
Before you build
Two pages worth reading first
Both will save you money, and one of them will save you an account.
Live benchmarks
Check your target’s success rate per pool before you decide which product to build against. Datacenter is cheaper right up until it does not work.
See the numbers →Allowed-use policy
What you may and may not point this at, published in plain language before you spend anything. Worth five minutes.
Read the policy →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?
- Yes. Every product answers on gateway.proxyhive.io:7000 and the credential you authenticate with determines which pool you are routed to. Switching between residential and datacenter is a credential change, not a code change.
- How do I hold the same IP across requests?
- Append a session identifier to the username. Drop it and you rotate on every request. Sticky sessions last up to 30 minutes on residential and 60 on datacenter.
- 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 you can back off precisely rather than guess.