Skip to content
VPNDetection

Migrate from Spur

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

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

Spur's Context API takes your token in the Token header:

bash
curl -H "Token: $SPUR_TOKEN" https://api.spur.us/v2/context/8.8.8.8

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

Spur answers lists: tunnels for VPNs and Tor, client.proxies for proxy pools and client.behaviors for what the address does. 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.

SpurVPNDetectionNotes
tunnels[].operator, tunnels[].typeis_vpn; Paid plan: vpn.providerOne flag and a stable provider ID, where Spur lists tunnels.
client.proxiesPaid plan: is_resproxy, is_dcproxy, is_mobproxy, resproxy.providerOne flag for each kind, with the pool's ID in provider.
infrastructureasn.type; Paid plan: is_hostingasn.type is the network's kind on every plan.
as.number, as.organizationasn.asn, asn.nameasn.asn is a number, as as.number is.
location.countrylocation.country
location.city, location.statePaid plan: location.city, location.region
client.behaviorsPaid plan: is_bittorrent, bittorrent.days_seenFile sharing only.
client.count, client.types, risksNo counterpart

The IP lookup reference documents every VPNDetection field.

3. Update your rules

The main change is from lists to flags:

  • A rule that searched tunnels for a VPN reads is_vpn, and a rule keyed on tunnels[].operator keys on vpn.provider.
  • A rule over client.proxies reads is_resproxy, is_dcproxy and is_mobproxy, with each pool's ID in its provider.
  • client.count, client.types and risks have no counterpart.
  • 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 Spur's VPN tunnels 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.spur.us/v2/context/${ip}`, {
        headers: { 'Token': process.env.SPUR_TOKEN },
    });
    const theirs = await res.json();
    const ours = await client.lookup(ip);
    const theirFlag = (theirs.tunnels ?? []).some((t) => t.type === 'VPN');
    const ourFlag = ours.isVpn;
    if (theirFlag !== ourFlag) {
        console.log(ip, 'Spur:', 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 Spur, and log VPNDetection's answer beside it for a few days of real traffic.
  2. Switch the decisions. Decide with VPNDetection, and keep logging Spur's answer while you watch for surprises.
  3. Remove Spur. 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.