API-documentatie

Authenticatie

Alle API-verzoeken moeten uw API-sleutel bevatten in de X-API-Key verzoekheader. U kunt uw API-sleutel vinden in de console.

X-API-Key: oip_your_api_key_here

Basis-URL

Alle API-verzoeken worden via HTTPS gedaan naar de volgende basis-URL:

https://api.openipapi.com

Machineleesbare specificatie (OpenAPI 3.1): /openapi.yaml.

Antwoordformaat

Alle antwoorden zijn JSON. Succesvolle antwoorden retourneren HTTP 200. Foutantwoorden retourneren een passende 4xx- of 5xx-statuscode met een error veld.

{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid or has been revoked.",
  "status": 401
}

GET /v1/lookup/{ip}

Zoek geolocatie-, netwerk- en threat data op voor één IP-adres.

Parameters

Antwoordvelden

Voorbeeldverzoek

$ curl https://api.openipapi.com/v1/lookup/185.220.101.45 \
     -H "X-API-Key: oip_your_api_key_here"

Voorbeeldantwoord

{
  "ip": "185.220.101.45",
  "type": "IPv4",
  "geo": {
    "country_code": "DE",
    "country": "Germany",
    "region": "Hessen",
    "region_code": "HE",
    "city": "Frankfurt am Main",
    "postal_code": "60313",
    "latitude": 50.1109,
    "longitude": 8.6821,
    "timezone": "Europe/Berlin",
    "is_sanctioned": false,
    "sanction_lists": []
  },
  "network": {
    "asn": 205100,
    "as_name": "F3 Netze e.V.",
    "as_domain": "f3netze.de",
    "isp": "F3 Netze",
    "organization": "F3 Netze e.V.",
    "connection_type": "datacenter"
  },
  "threat": {
    "is_vpn": true,
    "is_proxy": false,
    "is_tor": true,
    "is_relay": false,
    "is_hosting": true,
    "threat_score": 85,
    "threat_categories": ["tor_exit_node", "known_abuser"],
    "bot_type": null
  },
  "abuse": {
    "contact_email": "abuse@f3netze.de"
  }
}

POST /v1/lookup/batch

Zoek meerdere IP-adressen op in één verzoek. Batchgroottelimieten zijn afhankelijk van uw plan.

Batchgroottelimieten

Verzoekbody

{
  "ips": [
    "185.220.101.45",
    "8.8.8.8",
    "1.1.1.1"
  ]
}

Antwoord

Retourneert een ingepakte array van volledige opzoekobjecten, in dezelfde volgorde als het verzoek.

{
  "results": [
    { "ip": "185.220.101.45", /* full lookup object */ },
    { "ip": "8.8.8.8",          /* full lookup object */ },
    { "ip": "1.1.1.1",          /* full lookup object */ }
  ],
  "count": 3
}

GET /v1/me

Retourneert geolocatie en threat data voor het IP-adres dat het verzoek doet. Handig voor "Wat is mijn IP?"-functies.

Het antwoord is identiek aan GET /v1/lookup/{ip} met het IP van de aanroeper vooraf ingevuld.

$ curl https://api.openipapi.com/v1/me \
     -H "X-API-Key: oip_your_api_key_here"

GET /v1/asn/{asn}

Haal gedetailleerde informatie op over een Autonomous System Number. Vereist Starter-plan of hoger.

De asn parameter accepteert zowel 13335 als AS13335 formaten.

$ curl https://api.openipapi.com/v1/asn/13335 \
     -H "X-API-Key: oip_your_api_key_here"

Voorbeeldantwoord

{
  "asn": 13335,
  "as_name": "Cloudflare, Inc.",
  "as_domain": "cloudflare.com",
  "organization": "Cloudflare, Inc.",
  "country_code": "US",
  "ip_ranges_count": 1284,
  "total_ips": 2359296
}

GET /v1/validate/{ip}

Valideer een IP-adres en bepaal het type. Verbruikt geen opzoekquotum.

Example response

{
  "ip": "185.220.101.45",
  "valid": true,
  "type": "IPv4",
  "private": false,
  "bogon": false
}

GET /v1/fraud/{ip}

Samengestelde fraudescore (0–100) met risiconiveau en uitvoerbare aanbeveling. Combineert VPN-, proxy-, Tor-, datacenter- en historische misbruiksignalen. Starter-plan of hoger

Example response

{
  "ip": "185.220.101.45",
  "fraud_score": 92,
  "risk_level": "critical",
  "signals": {
    "is_vpn": true,
    "is_proxy": false,
    "is_tor": true,
    "is_datacenter": true,
    "is_known_attacker": true,
    "high_risk_country": false
  },
  "recommendation": "block"
}

Risiconiveaus & aanbevelingen

GET /v1/probe/{ip}

Realtime netwerkprobedata van onze 60+ actieve probing-nodes: open TCP-poorten, servicebanners, reverse DNS, volledige TLS-certificaatdetails (subject, issuer, SANs, geldigheid) en gedetecteerde servicecategorieën. Pro-plan of hoger

Hoe het werkt

• · Verse data (≤ 7 dagen oud): direct teruggegeven vanuit cache.
• · Verouderde data (> 7 dagen): direct teruggegeven plus een herprobe op de achtergrond wordt in de wachtrij gezet. Antwoord bevat "stale": true.
• · Nooit geprobed: een probe wordt in de wachtrij gezet voor directe scanning. Eerste resultaten komen typisch binnen 1–5 minuten binnen.
• · Probequotum is 10% van uw maandelijks opzoekquotum. Privé / gereserveerde IP's kunnen niet worden geprobed.

Example response

{
  "ip": "185.220.101.45",
  "reachable": true,
  "last_probed": "2026-04-18T14:23:11+00:00",
  "age_hours": 2.3,
  "stale": false,
  "refresh_queued": false,
  "probe_count_24h": 14,
  "probed_from_nodes": 8,
  "open_ports": [
    { "port": 22,   "service": "ssh",       "banner": "SSH-2.0-OpenSSH_8.9p1" },
    { "port": 80,   "service": "http",      "banner": "nginx/1.24.0" },
    { "port": 443,  "service": "https",     "banner": null },
    { "port": 9001, "service": "tor-relay", "banner": null }
  ],
  "reverse_dns": "tor-exit.f3netze.de",
  "tls": {
    "subject_cn":  "*.f3netze.de",
    "issuer":      "Let's Encrypt",
    "valid_from":  "2026-02-10T00:00:00Z",
    "valid_to":    "2026-05-10T00:00:00Z",
    "sans":        ["f3netze.de", "*.f3netze.de"],
    "fingerprint": "7e:4f:...:b2:e1"
  },
  "banners": {
    "22": "SSH-2.0-OpenSSH_8.9p1",
    "80": "nginx/1.24.0"
  },
  "detected_services": {
    "is_tor_relay":  true,
    "is_ssh_open":   true,
    "is_web_server": true,
    "is_vpn":        false,
    "is_proxy":      false
  }
}

Poorten die we scannen

22 (ssh), 80 / 8080 (http), 443 / 8443 (https), 1080 (socks5), 3128 / 8888 (http-proxy), 9001 / 9030 (tor-relay / tor-dir), 9050 / 9150 (tor-socks), 1194 (openvpn), 4500 (ipsec-nat-t), 51820 (wireguard).

Toepassingsgevallen

• · Anti-fraude — detecteer botboerderijen die identieke SSH-versies / TLS-fingerprints uitvoeren
• · Threat intel — bewaak C2-servers op banner- / certificaatwijzigingen
• · OSINT / bug bounty — snel services opsommen op elk openbaar IP
• · Hosting / ISP-beheer — open proxy's / Tor-exits in uw netwerk vinden

GET /v1/proxy-attribution/{ip}

Identificeert of een IP behoort tot een bekende residentiële proxypool, commerciële VPN of datacenter-bereik. In tegenstelling tot generieke is_proxy vlaggen schrijft dit eindpunt het IP toe aan de specifieke provider (Bright Data, Oxylabs, NordVPN, enz.) — cruciaal voor fraudeteams die sommige providers moeten toestaan en andere moeten blokkeren. Proxy Intel-add-on

Voorbeeldantwoord (IP in VPN-bereik)

{
  "ip": "2.56.16.42",
  "detected": true,
  "primary_provider": {
    "provider":     "unknown_vpn",
    "display_name": "Unknown VPN",
    "network_type": "vpn",
    "confidence":   0.75
  },
  "networks": [
    {
      "provider":    "unknown_vpn",
      "network_type": "vpn",
      "confidence":   0.75,
      "source":       "x4bnet-vpn",
      "cidr":         "2.56.16.0/22"
    },
    {
      "provider":    "unknown_datacenter",
      "network_type": "datacenter",
      "confidence":   0.75,
      "source":       "x4bnet-datacenter"
    }
  ],
  "recommendation": "treat_as_vpn"
}

Netwerktypes

• · residential — residentiële proxypools (Bright Data, Oxylabs, Smartproxy, IPRoyal, Hola, Honeygain, EarnApp, Peer2Profit, SOAX)
• · vpn — commerciële VPN-providers (NordVPN, ExpressVPN, Surfshark, Mullvad, ProtonVPN, PIA, IPVanish, CyberGhost)
• · datacenter — hostingproviders die vaak worden gebruikt voor commerciële proxy-exits (AWS, DigitalOcean, OVH, Hetzner, enz.)
• · tor — Tor-exit / relaynodes
• · mobile — mobiele carrier-proxypools

Aanbevelingen

GET /v1/account/usage

Retourneert statistieken over het huidige factureringsperiode-gebruik voor uw account.

Example response

{
  "plan": "Pro",
  "period_start": "2026-03-01",
  "period_end": "2026-03-31",
  "lookups_used": 184320,
  "lookups_limit": 500000,
  "lookups_remaining": 315680,
  "reset_at": "2026-04-01T00:00:00Z"
}

GET /v1/database/list

Geeft een lijst van MMDB-databases die beschikbaar zijn voor uw plan. Drop-in MaxMind .mmdb vervangingen voor offline / edge-gebruik — werkt met elke MaxMind DB-lezer (PHP, Go, Python, Node.js, Rust, Java).

Example response

{
  "plan": "Business",
  "sources": [
    {
      "source": "country",
      "filename": "geo-whois-asn-country.mmdb",
      "size_bytes": 8225621,
      "updated_at": "2026-04-18T02:00:00+00:00",
      "etag": "\"fa2b851f9155838b\"",
      "download_url": "https://api.openipapi.com/v1/database/download/country"
    }
  ]
}

GET /v1/database/download/{source}

Streamt het ruwe MMDB-bestand. Ondersteunt ETag + If-None-Match voor conditionele GETs (304 Not Modified wanneer het bestand ongewijzigd is). Snelheidslimiet: 10 downloads per bron per dag.

Beschikbare bronnen

Voorbeeld: downloaden + gebruiken in PHP

# Download latest MMDB
$ curl -H "X-API-Key: YOUR_KEY" \
    -o asn.mmdb \
    https://api.openipapi.com/v1/database/download/asn

# Use with maxmind-db/reader
$ composer require maxmind-db/reader

<?php
use MaxMind\Db\Reader;
$reader = new Reader('asn.mmdb');
$record = $reader->get('8.8.8.8');
// ['autonomous_system_number' => 15169,
//  'autonomous_system_organization' => 'Google LLC']

Sanctievlag

Elk /v1/lookup antwoord bevat twee velden in het geo blok die aangeven of het land van het IP onderworpen is aan internationale sancties.

Gedekte sanctielijsten: OFAC (VS), EU, VN-Veiligheidsraad, UK OFSI. Momenteel gevlagde landen zijn onder andere Iran, Noord-Korea, Rusland, Wit-Rusland, Syrië, Cuba, Venezuela, Soedan en anderen. De lijst wordt onderhouden en bijgewerkt naarmate programma's veranderen.

Voorbeeld gesanctioneerd land

"geo": {
  "country_code": "IR",
  "country": "Iran",
  ...
  "is_sanctioned": true,
  "sanction_lists": ["OFAC", "EU", "UN"]
}

Botdetectie

OpenIPApi voert dubbele reverse DNS-verificatie uit om legitieme crawlers te identificeren. Het resultaat is beschikbaar in threat.bot_type bij elke opzoeking.

Verificatiemethode: (1) PTR-opzoeking op het IP → hostnaam. (2) Hostnaam moet overeenkomen met het domeinpatroon van de bot (bijv. *.googlebot.com). (3) Forward DNS op de hostnaam moet worden omgezet naar het originele IP. Resultaten worden 24 uur gecached.

Voorbeeld geverifieerde Googlebot

"threat": {
  "is_vpn": false,
  "is_proxy": false,
  "is_tor": false,
  "threat_score": 0,
  "bot_type": "googlebot"
}

Historisch opzoeken

Voeg een ?date=YYYY-MM-DD parameter toe aan elke enkelvoudige IP-opzoeking om de snapshot van die datum op te halen.

Voorbeeldverzoek

$ curl "https://api.openipapi.com/v1/lookup/185.220.101.45?date=2026-01-15" \
     -H "X-API-Key: oip_your_api_key_here"

Antwoordenvelop

{
  "ip": "185.220.101.45",
  "snapshot_date": "2026-01-15",
  "is_historical": true,
  "data": {
    /* standard lookup response */
  }
}

Fout: geen snapshot beschikbaar

{
  "error": "No historical snapshot available for this IP on 2026-01-15",
  "code": "no_snapshot"
}

Foutcodes

Snelheidslimieten

Naast maandelijkse opzoekquota worden verzoeken per API-sleutel beperkt met een schuifvenster. Bij overschrijding retourneert de API HTTP 429 met een Retry-After header.

Aanvullende limieten: /v1/validate (niet-geauthenticeerd) heeft een limiet van 60 verzoeken/min per aanroeper-IP; /v1/me op 30 verzoeken/min. MMDB-downloads zijn beperkt tot 10/dag per bron per account. Snelheidslimietantwoorden bevatten Retry-After.

Webhooks

Met webhooks kunt u realtime HTTP POST-meldingen ontvangen wanneer de status van een IP dat u bewaakt verandert. Configureer ze in de console → Webhooks, of via de dashboard-UI — geen API-aanroep vereist.

Gebeurtenissen

Verzoekheaders

POST https://your-endpoint.example.com/webhook
Content-Type: application/json
User-Agent: OpenIPApi-Webhook/1.0
X-OpenIPApi-Event: high_threat
X-OpenIPApi-Signature: sha256=8c7f1a...b2e

Voorbeeldpayload

{
  "event": "high_threat",
  "delivered_at": "2026-04-18T12:34:56Z",
  "webhook_id": 142,
  "data": {
    "ip": "185.220.101.45",
    "threat_score": 92,
    "previous_score": 45,
    "is_tor": true,
    "is_vpn": true
  }
}

De handtekening verifiëren

Elke webhook is ondertekend met HMAC-SHA256 van de ruwe JSON-body met uw webhooksecret. De handtekening wordt verzonden in de X-OpenIPApi-Signature header als sha256=<hex>. Verifieer altijd voordat u actie onderneemt op de payload:

$body = file_get_contents('php://input');
$hdr  = $_SERVER['HTTP_X_OPENIPAPI_SIGNATURE'] ?? '';
$expected = 'sha256=' . hash_hmac(
    'sha256', $body, $webhookSecret
);
if (!hash_equals($expected, $hdr)) {
    http_response_code(401);
    exit;
}
// Safe to process $body now

const crypto = require('crypto');

app.post('/webhook',
  express.raw({ type: 'application/json' }),
  (req, res) => {
    const hdr = req.headers['x-openipapi-signature'];
    const expected = 'sha256=' + crypto
      .createHmac('sha256', process.env.WEBHOOK_SECRET)
      .update(req.body).digest('hex');
    if (expected !== hdr) return res.status(401).end();
    // Process JSON.parse(req.body)
  });

Herprobebeleid

Uw eindpunt moet binnen 10 seconden reageren met HTTP 2xx om ontvangst te bevestigen. Elke andere status (of time-out) activeert exponentieel backoff-herprobes: 1 min, 5 min, 30 min, 2 u, 12 u. Na de laatste poging wordt de webhook gemarkeerd als mislukt en wordt een dashboardmelding aangemaakt.

Aflevergeschiedenis & herspelen

De console → Webhooks bewaart de laatste 100 afleveringspogingen per account, met het gebeurtenistype, de HTTP-statuscode en de antwoordbody van uw eindpunt. U kunt herspelen elke eerdere aflevering om de originele ondertekende payload opnieuw te verzenden, en de ingebouwde Handtekeningdebugger gebruiken om HMAC-SHA256-handtekeningen client-side te verifiëren zonder uw secret met een server te delen.

Herspelde afleveringen bevatten een aanvullende X-OpenIPApi-Replay: 1 header zodat uw eindpunt ze kan onderscheiden van live gebeurtenissen.

Codevoorbeelden — curl

Enkelvoudige opzoeking

$ curl https://api.openipapi.com/v1/lookup/8.8.8.8 \
     -H "X-API-Key: oip_your_api_key_here"

Batchopzoeking

$ curl -X POST https://api.openipapi.com/v1/lookup/batch \
     -H "X-API-Key: oip_your_api_key_here" \
     -H "Content-Type: application/json" \
     -d '{"ips": ["8.8.8.8", "1.1.1.1", "185.220.101.45"]}'

Uw IP

$ curl https://api.openipapi.com/v1/me \
     -H "X-API-Key: oip_your_api_key_here"

Codevoorbeelden — JavaScript

Enkelvoudige opzoeking (fetch)

const response = await fetch('https://api.openipapi.com/v1/lookup/8.8.8.8', {
  headers: {
    'X-API-Key': 'oip_your_api_key_here'
  }
});

const data = await response.json();
console.log(data.geo.country);       // "United States"
console.log(data.threat.is_vpn);     // false
console.log(data.threat.threat_score); // 0

Batchopzoeking

const response = await fetch('https://api.openipapi.com/v1/lookup/batch', {
  method: 'POST',
  headers: {
    'X-API-Key': 'oip_your_api_key_here',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ips: ['8.8.8.8', '1.1.1.1', '185.220.101.45']
  })
});

const { results } = await response.json();
for (const info of results) {
  console.log(info.ip, info.geo.city, info.threat.threat_score);
}

Codevoorbeelden — Python

Enkelvoudige opzoeking (requests)

import requests

API_KEY = "oip_your_api_key_here"
headers = {"X-API-Key": API_KEY}

r = requests.get(
    "https://api.openipapi.com/v1/lookup/8.8.8.8",
    headers=headers
)
r.raise_for_status()
data = r.json()

print(data["geo"]["country"])       # United States
print(data["threat"]["is_vpn"])     # False
print(data["threat"]["threat_score"]) # 0

Batchopzoeking

import requests

API_KEY = "oip_your_api_key_here"
headers = {
    "X-API-Key": API_KEY,
    "Content-Type": "application/json"
}

payload = {
    "ips": ["8.8.8.8", "1.1.1.1", "185.220.101.45"]
}

r = requests.post(
    "https://api.openipapi.com/v1/lookup/batch",
    json=payload,
    headers=headers
)
r.raise_for_status()

for info in r.json()["results"]:
    print(info["ip"], info["geo"]["city"], info["threat"]["threat_score"])