API-dokumentation

Autentisering

Alla API-begäranden måste inkludera din API-nyckel i X-API-Key begäranshuvudet. Du hittar din API-nyckel i konsolen.

X-API-Key: oip_your_api_key_here

Bas-URL

Alla API-begäranden görs till följande bas-URL via HTTPS:

https://api.openipapi.com

Maskinläsbar specifikation (OpenAPI 3.1): /openapi.yaml.

Svarsformat

Alla svar är JSON. Lyckade svar returnerar HTTP 200. Felsvar returnerar en lämplig 4xx- eller 5xx-statuskod med ett error fält.

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

GET /v1/lookup/{ip}

Slå upp geolokalisering, nätverks- och hotdata för en enskild IP-adress.

Parametrar

Svarsfält

Exempelbegäran

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

Exempelsvar

{
  "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å upp flera IP-adresser i en enda begäran. Batchstorleksgränser beror på din plan.

Batchstorleksgränser

Begäranskropp

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

Svar

Returnerar en inkapslad array av fullständiga slagningsobjekt i samma ordning som begäran.

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

Returnerar geolokalisering och hotdata för IP-adressen som gör begäran. Användbart för "Vad är min IP?"-funktioner.

Svaret är identiskt med GET /v1/lookup/{ip} med anropärens IP förifylld.

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

GET /v1/asn/{asn}

Hämta detaljerad information om ett autonomt systemnummer. Kräver Starter-plan eller högre.

asn parametern accepterar både 13335 och AS13335 format.

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

Exempelsvar

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

Validera en IP-adress och bestäm dess typ. Förbrukar inte slagningskvoten.

Example response

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

GET /v1/fraud/{ip}

Sammansatt bedrägerpoäng (0–100) med risknivå och handlingsbara rekommendationer. Kombinerar VPN, proxy, Tor, datacenter och historiska missbrukssignaler. Starter-plan eller högre

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

Risknivåer och rekommendationer

GET /v1/probe/{ip}

Nätverksprobdata i realtid från våra 60+ aktiva probing-noder: öppna TCP-portar, tjänstebanners, omvänd DNS, fullständiga TLS-certifikatdetaljer (subject, issuer, SANs, giltighet) och detekterade tjänstekategorier. Pro-plan eller högre

Hur det fungerar

• · Färsk data (≤ 7 dagar gammal): returneras omedelbart från cache.
• · Inaktuell data (> 7 dagar): returneras omedelbart plus att en bakgrundsomsökning köas. Svaret inkluderar "stale": true.
• · Aldrig probb: en probe köas för omedelbar skanning. Första resultaten kommer vanligtvis inom 1–5 minuter.
• · Probkvoten är 10 % av din månatliga slagningskvot. Privata/reserverade IP-adresser kan inte probas.

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

Portar vi skannar

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

Användningsfall

• · Bedrägeribekämpning — detektera botfarmar som kör identiska SSH-versioner / TLS-fingeravtryck
• · Hotintelligens — övervaka C2-servrar för banner-/certifikatförändringar
• · OSINT / bug bounty — snabbt räkna upp tjänster på valfri offentlig IP
• · Hosting/ISP-drift — hitta öppna proxies / Tor-utgångar i ditt nätverk

GET /v1/proxy-attribution/{ip}

Identifierar om en IP tillhör en känd hushållsproxypool, kommersiell VPN eller datacenterintervall. Till skillnad från generiska is_proxy flaggor attributerar denna slutpunkt IP till den specifika leverantören (Bright Data, Oxylabs, NordVPN, etc.) — avgörande för bedrägeriteam som behöver tillåta vissa leverantörer och blockera andra. Proxy Intel-tillägg

Exempelsvar (IP i VPN-intervall)

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

Nätverkstyper

• · residential — hushållsproxypoolar (Bright Data, Oxylabs, Smartproxy, IPRoyal, Hola, Honeygain, EarnApp, Peer2Profit, SOAX)
• · vpn — kommersiella VPN-leverantörer (NordVPN, ExpressVPN, Surfshark, Mullvad, ProtonVPN, PIA, IPVanish, CyberGhost)
• · datacenter — hostingleverantörer som ofta används för kommersiell proxyutgång (AWS, DigitalOcean, OVH, Hetzner, etc.)
• · tor — Tor-utgångs-/relärnoder
• · mobile — mobiloperatörens proxypoolar

Rekommendationer

GET /v1/account/usage

Returnerar aktuell faktureringsperiodsanvändningsstatistik för ditt konto.

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

Listar MMDB-databaser tillgängliga för din plan. Direktinstallerade MaxMind .mmdb ersättningar för offline/kant-användning — fungerar med alla MaxMind DB-läsare (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}

Strömmar den råa MMDB-filen. Stöder ETag + If-None-Match för villkorliga GET:ar (304 Not Modified när filen är oförändrad). Hastighetsgräns: 10 nedladdningar per källa per dag.

Tillgängliga källor

Exempel: ladda ned + använd 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']

Sanktionsflagga

Varje /v1/lookup svar inkluderar två fält i geo blocket som berättar om IP-adressens land är föremål för internationella sanktioner.

Täckta sanktionslistor: OFAC (USA), EU, FN:s säkerhetsråd, UK OFSI. Länder som för närvarande är flaggade inkluderar Iran, Nordkorea, Ryssland, Vitryssland, Syrien, Kuba, Venezuela, Sudan och andra. Listan underhålls och uppdateras när program förändras.

Exempel på sanktionerat land

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

Botdetektering

OpenIPApi utför dubbel omvänd DNS-verifiering för att identifiera legitima crawlers. Resultatet finns i threat.bot_type i varje slagning.

Verifieringsmetod: (1) PTR-sökning på IP → värdnamn. (2) Värdnamnet måste matcha botens domänmönster (t.ex. *.googlebot.com). (3) Framåt-DNS på värdnamnet måste lösa tillbaka till den ursprungliga IP-adressen. Resultaten cachas i 24 timmar.

Verifierat Googlebot-exempel

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

Historisk slagning

Lägg till en ?date=YYYY-MM-DD parameter till valfri enskild IP-slagning för att hämta ögonblicksbilden från det datumet.

Exempelbegäran

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

Svarsomslagning

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

Fel: ingen ögonblicksbild tillgänglig

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

Felkoder

Hastighetsgränser

Utöver månatliga slagningskvoter hastighetsbegränsas begäranden per API-nyckel med ett glidande fönster. När gränsen överskrids returnerar API:et HTTP 429 med ett Retry-After huvud.

Ytterligare begränsningar: /v1/validate (oautentiserad) begränsar till 60 beg/min per anropar-IP; /v1/me till 30 beg/min. MMDB-nedladdningar begränsas till 10/dag per källa per konto. Hastighetsbegränsningssvar inkluderar Retry-After.

Webhooks

Webhooks låter dig ta emot realtids-HTTP POST-aviseringar när statusen för en IP du bevakar förändras. Konfigurera dem i konsolen → Webhooks, eller via instrumentpanelens gränssnitt — inget API-anrop krävs.

Händelser

Begäranshuvuden

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

Exempelnyttolast

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

Verifiera signaturen

Varje webhook signeras med HMAC-SHA256 av den råa JSON-kroppen med din webhook-hemlighet. Signaturen skickas i X-OpenIPApi-Signature huvudet som sha256=<hex>. Verifiera alltid innan du agerar på nyttolasten:

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

Omförsökspolicy

Din slutpunkt måste svara inom 10 sekunder med HTTP 2xx för att bekräfta mottagning. Annan status (eller timeout) utlöser exponentiell back-off-omförsök: 1 min, 5 min, 30 min, 2 h, 12 h. Efter det sista försöket markeras webhooken som misslyckad och en instrumentpanelavisering skapas.

Leveranshistorik och uppspelning

konsolen → Webhooks sparar de senaste 100 leveransförsöken per konto, med händelsetyp, HTTP-statuskod och svarstext från din slutpunkt. Du kan spela upp valfri tidigare leverans för att återsända den ursprungliga signerade nyttolasten, och använda den inbyggda Signaturavlusare för att verifiera HMAC-SHA256-signaturer i webbläsaren utan att dela din hemlighet med någon server.

Uppspelningsleveranser inkluderar ytterligare ett X-OpenIPApi-Replay: 1 huvud så att din slutpunkt kan skilja dem från levande händelser.

Kodexempel — curl

Enskild slagning

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

Batchslagning

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

Kodexempel — JavaScript

Enskild slagning (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

Batchslagning

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

Kodexempel — Python

Enskild slagning (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

Batchslagning

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