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/ip/1.1.1.1?apiKey=$WXA_API_KEY"

import os, httpx

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

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

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

Response:

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

The pinned fields (ip, classification, provider, confidence, source, asn, asn_org, observation_count, asn_abuse, sanctions_risk) are contractually stable — see CONTRACT.md. Other fields are incidental and may be added or removed.

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", "192.0.2.1"]}'

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 sub-millisecond local lookups.

ASN abuse triage

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

Sanctions screening

Flag IPs in sanctioned-jurisdiction proxy pools.

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

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

Sanctions screening

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

Sanctions screening

​What’s next

1. Get a key

2. Look up an IP

3. Batch lookups

4. Common workflows

What’s next