Dokumentacja API

Uwierzytelnianie

Wszystkie żądania API muszą zawierać klucz API w nagłówku X-API-Key żądania. Klucz API znajdziesz w panelu.

X-API-Key: oip_your_api_key_here

Bazowy URL

Wszystkie żądania API są kierowane do poniższego bazowego URL przez HTTPS:

https://api.openipapi.com

Specyfikacja czytelna maszynowo (OpenAPI 3.1): /openapi.yaml.

Format odpowiedzi

Wszystkie odpowiedzi są w formacie JSON. Pomyślne odpowiedzi zwracają HTTP 200. Odpowiedzi błędu zwracają odpowiedni kod statusu 4xx lub 5xx z polem error .

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

GET /v1/lookup/{ip}

Pobierz dane geolokalizacji, sieci i zagrożeń dla jednego adresu IP.

Parametry

Pola odpowiedzi

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Wyszukaj wiele adresów IP w jednym żądaniu. Limity rozmiaru partii zależą od Twojego planu.

Limity rozmiaru partii

Treść żądania

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

Odpowiedź

Zwraca opakowaną tablicę pełnych obiektów wyszukiwania w tej samej kolejności co żądanie.

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

Zwraca dane geolokalizacji i zagrożeń dla adresu IP wysyłającego żądanie. Przydatne do funkcji „Jaki jest mój adres IP?".

Odpowiedź jest identyczna z GET /v1/lookup/{ip} z wstępnie wypełnionym adresem IP wywołującego.

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

GET /v1/asn/{asn}

Pobierz szczegółowe informacje o numerze autonomicznego systemu. Wymaga planu Starter lub wyższego.

Parametr asn akceptuje zarówno format 13335 jak i AS13335 .

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

Przykładowa odpowiedź

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

Zwaliduj adres IP i określ jego typ. Nie zużywa limitu zapytań.

Example response

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

GET /v1/fraud/{ip}

Łączny wskaźnik oszustwa (0–100) z poziomem ryzyka i możliwą do podjęcia rekomendacją. Łączy sygnały VPN, proxy, Tor, centrum danych i historycznych nadużyć. Plan Starter lub wyższy

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

Poziomy ryzyka i rekomendacje

GET /v1/probe/{ip}

Dane sondowania sieciowego w czasie rzeczywistym z naszych ponad 60 aktywnych węzłów sondujących: otwarte porty TCP, nagłówki usług, odwrotny DNS, pełne szczegóły certyfikatu TLS (podmiot, wystawca, SAN-y, ważność) i wykryte kategorie usług. Plan Pro lub wyższy

Jak to działa

• · Świeże dane (≤ 7 dni): zwracane natychmiast z pamięci podręcznej.
• · Nieaktualne dane (> 7 dni): zwracane natychmiast, a w tle jest kolejkowane ponowne sondowanie. Odpowiedź zawiera "stale": true.
• · Nigdy nie sondowane: sondowanie jest kolejkowane do natychmiastowego skanowania. Pierwsze wyniki pojawiają się zazwyczaj w ciągu 1–5 minut.
• · Limit sondowania wynosi 10% miesięcznego limitu zapytań. Prywatnych / zarezerwowanych adresów IP nie można sondować.

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

Skanowane porty

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

Przypadki użycia

• · Zapobieganie oszustwom — wykrywanie farm botów z identycznymi wersjami SSH / odciskami palców TLS
• · Analiza zagrożeń — monitorowanie serwerów C2 pod kątem zmian nagłówków / certyfikatów
• · OSINT / bug bounty — szybkie wyliczanie usług na dowolnym publicznym adresie IP
• · Hosting / operacje ISP — wykrywanie otwartych proxy / węzłów wyjściowych Tor w sieci

GET /v1/proxy-attribution/{ip}

Identyfikuje, czy adres IP należy do znanych pul proxy domowych, komercyjnych VPN lub zakresów centrum danych. W odróżnieniu od ogólnych flag is_proxy ten punkt końcowy przypisuje IP do konkretnego dostawcy (Bright Data, Oxylabs, NordVPN itp.) — kluczowe dla zespołów ds. oszustw, które muszą jednych dostawców przepuszczać, a innych blokować. Dodatek Proxy Intel

Przykładowa odpowiedź (IP w zakresie VPN)

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

Typy sieci

• · residential — pule proxy domowych (Bright Data, Oxylabs, Smartproxy, IPRoyal, Hola, Honeygain, EarnApp, Peer2Profit, SOAX)
• · vpn — komercyjni dostawcy VPN (NordVPN, ExpressVPN, Surfshark, Mullvad, ProtonVPN, PIA, IPVanish, CyberGhost)
• · datacenter — dostawcy hostingu często używani jako wyjścia komercyjnych proxy (AWS, DigitalOcean, OVH, Hetzner itp.)
• · tor — węzły wyjściowe / przekaźnikowe Tor
• · mobile — pule proxy operatorów komórkowych

Rekomendacje

GET /v1/account/usage

Zwraca statystyki użycia dla bieżącego okresu rozliczeniowego na Twoim koncie.

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

Wyświetla bazy MMDB dostępne dla Twojego planu. Drop-in MaxMind .mmdb zamienniki do użytku offline / na brzegu sieci — działa z dowolnym czytnikiem MaxMind DB (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}

Strumieniuje surowy plik MMDB. Obsługuje ETag + If-None-Match dla warunkowych żądań GET (304 Not Modified gdy plik nie zmienił się). Limit szybkości: 10 pobrań na źródło dziennie.

Dostępne źródła

Przykład: pobieranie i użycie w 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']

Flaga sankcji

Każda odpowiedź /v1/lookup zawiera dwa pola w bloku geo informujące, czy kraj adresu IP podlega międzynarodowym sankcjom.

Objęte listy sankcji: OFAC (USA), UE, Rada Bezpieczeństwa ONZ, brytyjski OFSI. Kraje aktualnie oznaczone to m.in.: Iran, Korea Północna, Rosja, Białoruś, Syria, Kuba, Wenezuela, Sudan i inne. Lista jest utrzymywana i aktualizowana w miarę zmian programów.

Przykład sankcjonowanego kraju

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

Wykrywanie botów

OpenIPApi wykonuje podwójną weryfikację odwrotnego DNS w celu identyfikacji legalnych crawlerów. Wynik jest dostępny w polu threat.bot_type przy każdym zapytaniu.

Metoda weryfikacji: (1) Zapytanie PTR na adresie IP → nazwa hosta. (2) Nazwa hosta musi pasować do wzorca domeny bota (np. *.googlebot.com). (3) Forward DNS na nazwie hosta musi rozwiązać się z powrotem do oryginalnego adresu IP. Wyniki są buforowane przez 24 godziny.

Przykład zweryfikowanego Googlebot

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

Zapytanie historyczne

Dodaj parametr ?date=YYYY-MM-DD do dowolnego zapytania o pojedynczy adres IP, aby pobrać migawkę z tamtej daty.

Przykładowe żądanie

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

Koperta odpowiedzi

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

Błąd: brak dostępnej migawki

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

Kody błędów

Limity szybkości

Oprócz miesięcznych limitów zapytań, żądania są ograniczone szybkością per klucz API za pomocą przesuwnego okna czasowego. Po przekroczeniu API zwraca HTTP 429 z nagłówkiem Retry-After .

Dodatkowe limity: /v1/validate (bez uwierzytelnienia) ograniczone do 60 żądań/min per IP wywołującego; /v1/me do 30 żądań/min. Pobieranie MMDB ograniczone do 10/dzień na źródło na konto. Odpowiedzi z limitem szybkości zawierają Retry-After.

Webhooks

Webhooks umożliwiają odbieranie powiadomień HTTP POST w czasie rzeczywistym, gdy status obserwowanego adresu IP ulega zmianie. Skonfiguruj je w panelu → Webhooks, lub przez interfejs panelu — bez potrzeby wywołania API.

Zdarzenia

Nagłówki żądania

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

Przykładowy ładunek

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

Weryfikacja sygnatury

Każdy webhook jest podpisany przy użyciu HMAC-SHA256 surowego ciała JSON z Twoim sekretem webhook. Sygnatura jest wysyłana w nagłówku X-OpenIPApi-Signature jako sha256=<hex>. Zawsze weryfikuj przed działaniem na ładunku:

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

Polityka ponownych prób

Twój punkt końcowy musi odpowiedzieć w ciągu 10 sekund statusem HTTP 2xx, aby potwierdzić odbiór. Każdy inny status (lub przekroczenie czasu) wyzwala ponowne próby z wykładniczym wycofaniem: 1 min, 5 min, 30 min, 2 h, 12 h. Po ostatniej próbie webhook jest oznaczany jako nieudany i w panelu pojawia się alert.

Historia dostarczania i odtwarzanie

panelu → Webhooks przechowuje ostatnie 100 prób dostarczenia na konto, pokazując typ zdarzenia, kod statusu HTTP i treść odpowiedzi zwróconą przez Twój punkt końcowy. Możesz odtworzyć dowolne poprzednie dostarczenie, aby ponownie wysłać oryginalny podpisany ładunek, i użyć wbudowanego Debuggera sygnatur do weryfikacji sygnatur HMAC-SHA256 po stronie klienta bez ujawniania sekretu żadnemu serwerowi.

Odtworzone dostarczenia zawierają dodatkowy nagłówek X-OpenIPApi-Replay: 1 dzięki czemu Twój punkt końcowy może odróżnić je od żywych zdarzeń.

Przykłady kodu — curl

Pojedyncze zapytanie

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

Masowe zapytanie

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

Twój adres IP

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

Przykłady kodu — JavaScript

Pojedyncze zapytanie (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

Masowe zapytanie

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

Przykłady kodu — Python

Pojedyncze zapytanie (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

Masowe zapytanie

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