Skip to content
VPNDetection

Migrate from GetIPIntel

Move from GetIPIntel to VPNDetection: change the request, map each GetIPIntel field to its VPNDetection field, and compare the answers before you switch.

This guide moves an integration from GetIPIntel to VPNDetection. It shows how the request changes, which VPNDetection field answers each of GetIPIntel'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

GetIPIntel takes no key. Every request carries your contact email in contact, and oflags asks for the extra fields:

bash
curl "http://check.getipintel.net/check.php?ip=8.8.8.8&contact=$GETIPINTEL_CONTACT&format=json&flags=m&oflags=icarb"

VPNDetection takes the address as the path and your key in the Authorization header:

bash
curl -H "Authorization: Bearer $VPNDETECTION_API_KEY" https://api.vpndetection.io/8.8.8.8

If 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

GetIPIntel answers a probability in result, and, with oflags, fields such as ResidentialProxy, Country and ASN. 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.

GetIPIntelVPNDetectionNotes
ResidentialProxyPaid plan: is_resproxy, resproxy.last_seenA flag with dates, where ResidentialProxy is a score from 0 to 1.
iCloudRelayEgress, GoogleOneVPNis_relay, relay.providerrelay.provider names the relay.
Countrylocation.country
ASNasn.asn
BadIPNo counterpart

The IP lookup reference documents every VPNDetection field.

3. Update your rules

The main change is from a probability to classifications:

  • A rule that refused a result above a threshold such as 0.99 becomes a rule over what the address is: is_vpn and is_tor on every plan, and the proxy flags on a paid plan.
  • VPNDetection takes a key instead of a contact email, and answers over HTTPS.
  • 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 GetIPIntel's verdict and VPNDetection's differ. Save it as compare.mjs beside sample.txt, install the library with npm install vpndetection, and run node compare.mjs:

js
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 url = `http://check.getipintel.net/check.php?ip=${ip}`
        + `&contact=${process.env.GETIPINTEL_CONTACT}&format=json&flags=m`;
    const res = await fetch(url);
    const theirs = await res.json();
    const ours = await client.lookup(ip);
    const theirFlag = Number(theirs.result) >= 0.99;
    const ourFlag = ours.isVpn || ours.isTor;
    if (theirFlag !== ourFlag) {
        console.log(ip, 'GetIPIntel:', theirFlag, 'VPNDetection:', ourFlag);
    }
    // GetIPIntel limits how often you may query: check its page for the current limits.
    await new Promise((done) => setTimeout(done, 5000));
}

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:

  1. Run both side by side. Keep deciding with GetIPIntel, and log VPNDetection's answer beside it for a few days of real traffic.
  2. Switch the decisions. Decide with VPNDetection, and keep logging GetIPIntel's answer while you watch for surprises.
  3. Remove GetIPIntel. 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.