Skip to content
VPNDetection

Migrate from Ipregistry

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

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

Ipregistry takes your key in the key query parameter or an Authorization: ApiKey header:

bash
curl "https://api.ipregistry.co/8.8.8.8?key=$IPREGISTRY_KEY"

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

Ipregistry answers its flags in security, and the location in location. 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.

IpregistryVPNDetectionNotes
security.is_vpnis_vpn; Paid plan: vpn.providervpn.provider names the VPN service.
security.is_residential_proxyPaid plan: is_resproxy, resproxy.last_seenresproxy.last_seen says when the address was last seen in a pool.
security.is_proxyPaid plan: is_dcproxy, is_mobproxy, is_pubproxyOne flag for each kind.
security.is_tor, security.is_tor_exitis_toris_tor flags exits, as security.is_tor_exit does.
security.is_relayis_relay, relay.providerCovers every relay operator and company web gateways, not only iCloud Private Relay.
security.is_cloud_providerPaid plan: is_hosting, is_cdn, hosting.providerHosting and CDNs are separate flags.
security.is_abuser, security.is_attacker, security.is_threatNo counterpart
location.city, location.region.namePaid plan: location.city, location.regionlocation.region is a string.

The IP lookup reference documents every VPNDetection field.

3. Update your rules

Most rules move field for field:

  • A rule that read security.is_tor reads is_tor, which flags exits; Ipregistry's also covers middle relays and bridges.
  • security.is_cloud_provider splits into is_hosting and is_cdn.
  • location.region is the region's name as a string, where Ipregistry answers an object.
  • 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 Ipregistry'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:

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 res = await fetch(`https://api.ipregistry.co/${ip}?key=${process.env.IPREGISTRY_KEY}`);
    const theirs = await res.json();
    const ours = await client.lookup(ip);
    const theirFlag = theirs.security?.is_vpn === true;
    const ourFlag = ours.isVpn;
    if (theirFlag !== ourFlag) {
        console.log(ip, 'Ipregistry:', 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:

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