API-dokumentasjon

Autentisering

Alle API-forespørsler må inkludere API-nøkkelen din i X-API-Key forespørselshodet. Du finner API-nøkkelen din i konsollen.

X-API-Key: oip_your_api_key_here

Basis-URL

Alle API-forespørsler sendes til følgende basis-URL over HTTPS:

https://api.openipapi.com

Maskinlesbar spesifikasjon (OpenAPI 3.1): /openapi.yaml.

Svarformat

Alle svar er JSON. Vellykkede svar returnerer HTTP 200. Feilsvar returnerer en passende 4xx- eller 5xx-statuskode med et error felt.

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

GET /v1/lookup/{ip}

Slå opp geolokasjon, nettverk og trusseldata for en enkelt IP-adresse.

Parametere

Svarfelt

Eksempelforespørsel

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

Eksempelsvar

{
  "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

Slå opp flere IP-adresser i én enkelt forespørsel. Grenser for massestørrelse avhenger av planen din.

Grenser for massestørrelse

Forespørselstekst

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

Svar

Returnerer en pakket matrise av fullstendige oppslagsobjekter, i samme rekkefølge som forespørselen.

{
  "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

Returnerer geolokasjon og trusseldata for IP-adressen som sender forespørselen. Nyttig for «Hva er min IP?»-funksjoner.

Svaret er identisk med GET /v1/lookup/{ip} med callerens IP forhåndsutfylt.

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

GET /v1/asn/{asn}

Hent detaljert informasjon om et autonomt systemnummer. Krever Starter-plan eller høyere.

asn parameteren aksepterer både 13335 og AS13335 formater.

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

Eksempelsvar

{
  "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}

Valider en IP-adresse og bestem typen. Forbruker ikke oppslagskvote.

Example response

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

GET /v1/fraud/{ip}

Sammensatt svindelscore (0–100) med risikonivå og handlingsbar anbefaling. Kombinerer VPN-, proxy-, Tor-, datasenter- og historisk misbrukssignaler. Starter-plan eller høyere

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"
}

Risikonivåer og anbefalinger

GET /v1/probe/{ip}

Sanntids nettverksprobingdata fra våre 60+ aktive probingsnoder: åpne TCP-porter, tjenestebannere, omvendt DNS, full TLS-sertifikatdetalj (emne, utsteder, SAN-er, gyldighet) og oppdagede tjenestekategorier. Pro-plan eller høyere

Slik fungerer det

• · Ferske data (≤ 7 dager gamle): returneres umiddelbart fra buffer.
• · Foreldede data (> 7 dager): returneres umiddelbart pluss at en bakgrunns-re-probe settes i kø. Svaret inkluderer "stale": true.
• · Aldri probet: en probe settes i kø for umiddelbar skanning. Første resultater ankommer vanligvis innen 1–5 minutter.
• · Probingkvoten er 10 % av den månedlige oppslagskvoten. Private / reserverte IP-er kan ikke probes.

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
  }
}

Porter vi skanner

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).

Brukstilfeller

• · Svindelbekjempelse — oppdag bot-gårder som kjører identiske SSH-versjoner / TLS-avtrykk
• · Trusselintelligens — overvåk C2-servere for banner- / sertifikatendringer
• · OSINT / bug bounty — enumerer raskt tjenester på en offentlig IP
• · Hosting / ISP-drift — finn åpne proxyer / Tor-utganger i nettverket ditt

GET /v1/proxy-attribution/{ip}

Identifiserer om en IP tilhører en kjent boligproxy-pool, kommersiell VPN eller datasenterlager. I motsetning til generiske is_proxy flagg, tilskriver dette endepunktet IP-en til den spesifikke leverandøren (Bright Data, Oxylabs, NordVPN, osv.) — avgjørende for svindelteam som trenger å tillate noen leverandører og blokkere andre. Proxy Intel-tillegg

Eksempelsvar (IP i VPN-område)

{
  "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"
}

Nettverkstyper

• · residential — boligproxypooler (Bright Data, Oxylabs, Smartproxy, IPRoyal, Hola, Honeygain, EarnApp, Peer2Profit, SOAX)
• · vpn — kommersielle VPN-leverandører (NordVPN, ExpressVPN, Surfshark, Mullvad, ProtonVPN, PIA, IPVanish, CyberGhost)
• · datacenter — hostingleverandører som ofte brukes for kommersielle proxy-utganger (AWS, DigitalOcean, OVH, Hetzner, osv.)
• · tor — Tor-utgangs- / relénoder
• · mobile — mobiloperatørens proxypooler

Anbefalinger

GET /v1/account/usage

Returnerer nåværende faktureringsperiodebruksstatistikk for kontoen din.

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

Viser MMDB-databaser tilgjengelig for planen din. Drop-in MaxMind .mmdb erstatninger for offline / edge-bruk — fungerer med alle MaxMind DB-lesere (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}

Streamer råfilen MMDB. Støtter ETag + If-None-Match for betingede GET-er (304 Not Modified når filen er uendret). Hastighetsbegrensning: 10 nedlastinger per kilde per dag.

Tilgjengelige kilder

Eksempel: last ned og bruk i 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']

Sanksjonsflagg

Hvert /v1/lookup svar inkluderer to felt i geo blokken som forteller deg om IP-ens land er underlagt internasjonale sanksjoner.

Dekke sanksjonslister: OFAC (USA), EU, FNs sikkerhetsråd, Storbritannias OFSI. Land som for øyeblikket er flagget inkluderer Iran, Nord-Korea, Russland, Hviterussland, Syria, Cuba, Venezuela, Sudan og andre. Listen vedlikeholdes og oppdateres etter hvert som programmene endres.

Eksempel på sanksjonert land

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

Bot-deteksjon

OpenIPApi utfører dobbel omvendt DNS-verifisering for å identifisere legitime crawlere. Resultatet er tilgjengelig i threat.bot_type på hvert oppslag.

Verifikasjonsmetode: (1) PTR-oppslag på IP-en → vertsnavn. (2) Vertsnavn må samsvare med botens domønemønster (f.eks. *.googlebot.com). (3) Forward DNS på vertsnavnet må løses tilbake til den opprinnelige IP-en. Resultater bufres i 24 timer.

Verifisert Googlebot-eksempel

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

Historisk oppslag

Legg til en ?date=YYYY-MM-DD parameter til et enkelt IP-oppslag for å hente øyeblikksbildet fra den datoen.

Eksempelforespørsel

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

Svarkuvert

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

Feil: ingen øyeblikksbilde tilgjengelig

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

Feilkoder

Hastighetsbegrensninger

I tillegg til månedlige oppslagskvoter er forespørsler hastighetsbegrenset per API-nøkkel ved hjelp av et glidende vindu. Når det overskrides, returnerer API-et HTTP 429 med et Retry-After hode.

Tilleggsbegrensninger: /v1/validate (uautentisert) begrenses til 60 req/min per caller-IP; /v1/me til 30 req/min. MMDB-nedlastinger er begrenset til 10/dag per kilde per konto. Hastighetsbegrensningssvar inkluderer Retry-After.

Webhooks

Webhooks lar deg motta sanntids HTTP POST-varsler når statusen til en IP du overvåker endres. Konfigurer dem i konsollen → Webhooks, eller gjennom dashbord-brukergrensesnittet — ingen API-kall kreves.

Hendelser

Forespørselshoder

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

Eksempelnyttelast

{
  "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
  }
}

Verifisere signaturen

Hvert webhook er signert ved hjelp av HMAC-SHA256 av den rå JSON-teksten med webhook-hemmeligheten din. Signaturen sendes i X-OpenIPApi-Signature hodet som sha256=<hex>. Verifiser alltid før du handler på nyttelasten:

$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)
  });

Ny-forsøkspolicy

Endepunktet ditt må svare innen 10 sekunder med HTTP 2xx for å bekrefte mottak. Enhver annen status (eller tidsavbrudd) utløser eksponentielle nye forsøk: 1 min, 5 min, 30 min, 2 t, 12 t. Etter siste forsøk merkes webhook-en som mislykket og et dashbordvarsel opprettes.

Leveringshistorikk og avspilling

konsollen → Webhooks beholder de siste 100 leveringsforsøkene per konto, og viser hendelsestype, HTTP-statuskode og svarteksten returnert av endepunktet ditt. Du kan spille av en hvilken som helst tidligere levering for å sende den originale signerte nyttelasten på nytt, og bruke den innebygde Signaturfeilsøker for å verifisere HMAC-SHA256-signaturer på klientsiden uten å dele hemmeligheten din med noen server.

Avspilte leveringer inkluderer et ekstra X-OpenIPApi-Replay: 1 hode slik at endepunktet ditt kan skille dem fra live hendelser.

Kodeeksempler — curl

Enkelt oppslag

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

Masseoppslag

$ 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"]}'

Din IP

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

Kodeeksempler — JavaScript

Enkelt oppslag (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

Masseoppslag

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);
}

Kodeeksempler — Python

Enkelt oppslag (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

Masseoppslag

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"])