Migrate from ipdata
Move from ipdata to VPNDetection: change the request, map each ipdata field to its VPNDetection field, and compare the answers before you switch.
This guide moves an integration from ipdata's threat intelligence to VPNDetection. It shows how the request changes, which VPNDetection field answers each of ipdata's, how rules that read them change, and how to compare the two services on your own traffic before you switch.
Before you begin
- A VPNDetection API key, if you need more than the free plan's fields. Without a key, a lookup answers the free plan's fields:
is_vpn,is_tor,is_relay, and the address's country and network. See Plans and fields. - A sample of a few hundred addresses from your own traffic, one per line in
sample.txt, for the comparison in step 4.
1. Change the request
ipdata takes your key in the api-key query parameter:
curl "https://api.ipdata.co/8.8.8.8?api-key=$IPDATA_KEY"VPNDetection takes the address as the path and your key in the Authorization header:
curl -H "Authorization: Bearer $VPNDETECTION_API_KEY" https://api.vpndetection.io/8.8.8.8If your code can't set a header, send the key in the apikey query parameter instead; see Authentication. To make the request from your code with an official library, see Use an SDK.
2. Map the fields
ipdata answers its flags in threat, with scores in threat.scores. VPNDetection answers one top-level flag for each kind of address, with a detail object beside it. Fields after Paid plan: come with a paid plan; the rest come with every plan, the free plan included.
| ipdata | VPNDetection | Notes |
|---|---|---|
threat.is_vpn, threat.scores.vpn_score | is_vpn; Paid plan: vpn.provider, vpn.confidence | A named provider and high, medium or low, where ipdata answers a score from 0 to 100. |
threat.is_proxy | Paid plan: is_resproxy, is_dcproxy, is_mobproxy, is_pubproxy | One flag for each kind. |
threat.is_tor | is_tor | |
threat.is_icloud_relay | is_relay, relay.provider | Covers every relay operator and company web gateways, not only iCloud Private Relay. |
threat.is_datacenter | Paid plan: is_hosting, is_cdn, hosting.provider | Hosting and CDNs are separate flags. |
threat.is_known_attacker, threat.is_known_abuser, threat.blocklists | No counterpart |
The IP lookup reference documents every VPNDetection field.
3. Update your rules
Most rules move field for field:
- A rule over
threat.scores.vpn_scorereadsis_vpn, andvpn.confidenceon a paid plan. Decide which ofhigh,mediumandlowit accepts. - A rule over
threat.is_anonymous, which ipdata sets for Tor or a proxy, readsis_torand the proxy flags. - A field your plan doesn't include is absent rather than
false, so a rule checks that a paid field is present before it acts on the value. See Plans and fields.
4. Compare the answers
Before you switch, run both services on your sample and review the addresses where they disagree. This script prints each address where ipdata's VPN flag and VPNDetection's differ. Save it as compare.mjs beside sample.txt, install the library with npm install vpndetection, and run node compare.mjs:
import { readFileSync } from 'node:fs';
import { VPNDetection } from 'vpndetection';
const client = new VPNDetection({ apiKey: process.env.VPNDETECTION_API_KEY });
const ips = readFileSync('sample.txt', 'utf8').split('\n').filter(Boolean);
for (const ip of ips) {
const res = await fetch(`https://api.ipdata.co/${ip}?api-key=${process.env.IPDATA_KEY}`);
const theirs = await res.json();
const ours = await client.lookup(ip);
const theirFlag = theirs.threat?.is_vpn === true;
const ourFlag = ours.isVpn;
if (theirFlag !== ourFlag) {
console.log(ip, 'ipdata:', theirFlag, 'VPNDetection:', ourFlag);
}
}Every provider builds its own data, so some disagreement is expected. Look up a few of the addresses on both sides. If you believe VPNDetection's answer is wrong, send us the address.
5. Switch over
Once the comparison looks right, switch in stages, so you can stop at any point without affecting your users:
- Run both side by side. Keep deciding with ipdata, and log VPNDetection's answer beside it for a few days of real traffic.
- Switch the decisions. Decide with VPNDetection, and keep logging ipdata's answer while you watch for surprises.
- Remove ipdata. Once your logs are clean, delete the old client from your code and revoke its key.
Next steps
When the answers suit your rules, switch your code to VPNDetection. Protect a web app applies rules in middleware, and the guides cover sign-ups, logins, payments and country rules. Before you launch, review the go-live checklist.