Quickstart

1. Get a key

Sign in to your WhoisXML API account, subscribe to the VPN & Proxy Detection API, and copy your API key from the dashboard.

2. Look up an IP

curl "https://vpn-proxy-detection.whoisxmlapi.com/api/v1?apiKey=$WXA_API_KEY&ipAddress=1.1.1.1"

import os, httpx

resp = httpx.get(
    "https://vpn-proxy-detection.whoisxmlapi.com/api/v1",
    params={"apiKey": os.environ["WXA_API_KEY"], "ipAddress": "1.1.1.1"},
)
print(resp.json())

const res = await fetch(
  `https://vpn-proxy-detection.whoisxmlapi.com/api/v1?apiKey=${process.env.WXA_API_KEY}&ipAddress=1.1.1.1`,
);
console.log(await res.json());

req, _ := http.NewRequest("GET",
    "https://vpn-proxy-detection.whoisxmlapi.com/api/v1?ipAddress=1.1.1.1&apiKey="+os.Getenv("WXA_API_KEY"), nil)
resp, _ := http.DefaultClient.Do(req)

Response (trimmed):

{
  "ip": "1.1.1.1",
  "classification": "cdn",
  "provider": null,
  "confidence": null,
  "source": "public_list",
  "asn": 13335,
  "asn_org": "CLOUDFLARENET - Cloudflare, Inc., US",
  "observation_count": null,
  "asn_abuse": {"abuse_score": 29, "abuse_level": "low"},
  "sanctions_risk": null
}

Every key in the response schema is returned on every plan unless the schema says otherwise, and the schema names the lowest plan that fills each one; new keys may be added. This example is trimmed from what an Intro key receives, which also includes the is_* flags and risk_score. Starter is the first plan that can fill in provider, and Pro the first that fills in confidence and observation_count (see Tiers).

3. Batch lookups

For lists of IPs, use the batch endpoint (Starter tier and above):

curl "https://vpn-proxy-detection.whoisxmlapi.com/api/v1/ip/batch?apiKey=$WXA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ips": ["1.1.1.1", "8.8.8.8", "62.182.99.141"]}'

Up to 100 IPs per call. See the batch endpoint reference.

4. Common workflows

Block residential proxy traffic

Filter signups, logins, or transactions where is_residential_proxy=true.

Daily MMDB mirror

Pull the full dataset nightly for local lookups.

ASN abuse triage

Identify the highest-abuse-density ASNs in your traffic.

Licensing and geo-integrity

Flag VPN, proxy and relay traffic where your content licence is region-bound.

What’s next

Authentication — key formats, rate limits
Tiers and pricing — what each tier unlocks
Error handling — retry strategy, status codes

Getting Started

Guides

Reference

Lookup

Aggregates

Bulk Exports

Account

1. Get a key

2. Look up an IP

3. Batch lookups

4. Common workflows

Block residential proxy traffic

Daily MMDB mirror

ASN abuse triage

Licensing and geo-integrity

What’s next

​1. Get a key

​2. Look up an IP

​3. Batch lookups

​4. Common workflows

Block residential proxy traffic

Daily MMDB mirror

ASN abuse triage

Licensing and geo-integrity

​What’s next

1. Get a key

2. Look up an IP

3. Batch lookups

4. Common workflows

What’s next