Documentação da API

Autenticação

Todas as requisições à API devem incluir sua chave de API no cabeçalho X-API-Key . Você pode encontrar sua chave de API no console.

X-API-Key: oip_your_api_key_here

URL base

Todas as requisições à API são feitas para a seguinte URL base via HTTPS:

https://api.openipapi.com

Especificação legível por máquina (OpenAPI 3.1): /openapi.yaml.

Formato da resposta

Todas as respostas são JSON. Respostas bem-sucedidas retornam HTTP 200. Respostas de erro retornam um código de status 4xx ou 5xx apropriado com um campo error .

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

GET /v1/lookup/{ip}

Consulte geolocalização, rede e dados de ameaça para um único endereço IP.

Parâmetros

Campos da resposta

Exemplo de requisição

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

Exemplo de resposta

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

Consulte múltiplos endereços IP em uma única requisição. Os limites de tamanho do lote dependem do seu plano.

Limites de tamanho do lote

Corpo da requisição

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

Resposta

Retorna um array encapsulado de objetos de consulta completos, na mesma ordem da requisição.

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

Retorna geolocalização e dados de ameaça para o endereço IP que faz a requisição. Útil para funcionalidades de "Qual é meu IP?".

A resposta é idêntica à GET /v1/lookup/{ip} com o IP do chamador preenchido.

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

GET /v1/asn/{asn}

Recupera informações detalhadas sobre um Número de Sistema Autônomo. Requer plano Starter ou superior.

O parâmetro asn aceita os formatos 13335 e AS13335 .

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

Exemplo de resposta

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

Valida um endereço IP e determina seu tipo. Não consome cota de consulta.

Example response

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

GET /v1/fraud/{ip}

Pontuação de fraude composta (0–100) com nível de risco e recomendação acionável. Combina sinais de VPN, proxy, Tor, datacenter e abuso histórico. Plano Starter ou superior

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

Níveis de risco e recomendações

GET /v1/probe/{ip}

Dados de sonda de rede em tempo real dos nossos mais de 60 nós de probing ativos: portas TCP abertas, banners de serviço, DNS reverso, detalhes completos de certificado TLS (sujeito, emissor, SANs, validade) e categorias de serviço detectadas. Plano Pro ou superior

Como funciona

• · Dados recentes (≤ 7 dias): retornados imediatamente do cache.
• · Dados desatualizados (> 7 dias): retornados imediatamente e um reescaneamento em background é enfileirado. A resposta inclui "stale": true.
• · Nunca sondado: uma sonda é enfileirada para escaneamento imediato. Os primeiros resultados chegam tipicamente em 1–5 minutos.
• · A cota de sonda é 10% da sua cota mensal de consultas. IPs privados / reservados não podem ser sondados.

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

Portas que escaneamos

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

Casos de uso

• · Antifraude — detecte farms de bots executando versões idênticas de SSH / fingerprints TLS
• · Threat intel — monitore servidores C2 para mudanças de banner / certificado
• · OSINT / bug bounty — enumere rapidamente serviços em qualquer IP público
• · Hospedagem / operações ISP — encontre proxies abertos / saídas Tor na sua rede

GET /v1/proxy-attribution/{ip}

Identifica se um IP pertence a um pool de proxy residencial conhecido, VPN comercial ou faixa de datacenter. Ao contrário de flags genéricos is_proxy , este endpoint atribui o IP ao provedor específico (Bright Data, Oxylabs, NordVPN, etc.) — essencial para equipes de fraude que precisam permitir alguns provedores e bloquear outros. Add-on Proxy Intel

Exemplo de resposta (IP em faixa 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"
}

Tipos de rede

• · residential — pools de proxy residencial (Bright Data, Oxylabs, Smartproxy, IPRoyal, Hola, Honeygain, EarnApp, Peer2Profit, SOAX)
• · vpn — provedores VPN comerciais (NordVPN, ExpressVPN, Surfshark, Mullvad, ProtonVPN, PIA, IPVanish, CyberGhost)
• · datacenter — provedores de hospedagem frequentemente usados para saída de proxy comercial (AWS, DigitalOcean, OVH, Hetzner, etc.)
• · tor — nós de saída / relay Tor
• · mobile — pools de proxy de operadora móvel

Recomendações

GET /v1/account/usage

Retorna estatísticas de uso do período de faturamento atual da sua conta.

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

Lista bancos de dados MMDB disponíveis para o seu plano. Substituições drop-in MaxMind .mmdb para uso offline / de borda — funciona com qualquer leitor 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}

Faz streaming do arquivo MMDB bruto. Suporta ETag + If-None-Match para GETs condicionais (304 Not Modified quando o arquivo não mudou). Limite de taxa: 10 downloads por fonte por dia.

Fontes disponíveis

Exemplo: download + uso em 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']

Flag de Sanções

Toda resposta /v1/lookup inclui dois campos no bloco geo que indicam se o país do IP está sujeito a sanções internacionais.

Listas de sanção cobertas: OFAC (EUA), UE, Conselho de Segurança da ONU, OFSI do Reino Unido. Os países atualmente sinalizados incluem Irã, Coreia do Norte, Rússia, Belarus, Síria, Cuba, Venezuela, Sudão e outros. A lista é mantida e atualizada conforme os programas mudam.

Exemplo de país sancionado

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

Detecção de Bots

O OpenIPApi realiza verificação DNS reverso duplo para identificar crawlers legítimos. O resultado está disponível em threat.bot_type em cada consulta.

Método de verificação: (1) consulta PTR no IP → hostname. (2) O hostname deve corresponder ao padrão de domínio do bot (ex.: *.googlebot.com). (3) O DNS direto no hostname deve resolver de volta ao IP original. Os resultados são armazenados em cache por 24 horas.

Exemplo de Googlebot verificado

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

Consulta Histórica

Adicione um parâmetro ?date=YYYY-MM-DD a qualquer consulta de IP único para recuperar o snapshot daquela data.

Exemplo de requisição

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

Envelope de resposta

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

Erro: snapshot não disponível

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

Códigos de erro

Limites de taxa

Além das cotas mensais de consulta, as requisições são limitadas por chave de API usando uma janela deslizante. Quando excedido, a API retorna HTTP 429 com um cabeçalho Retry-After .

Limites adicionais: /v1/validate (não autenticado) tem limite de 60 req/min por IP do chamador; /v1/me a 30 req/min. Downloads MMDB são limitados a 10/dia por fonte por conta. Respostas de limite de taxa incluem Retry-After.

Webhooks

Os webhooks permitem receber notificações HTTP POST em tempo real quando o status de um IP que você está monitorando muda. Configure-os no console → Webhooks, ou pela interface do painel — sem necessidade de chamada à API.

Eventos

Cabeçalhos da requisição

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

Payload de exemplo

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

Verificando a assinatura

Todo webhook é assinado usando HMAC-SHA256 do corpo JSON bruto com o seu segredo de webhook. A assinatura é enviada no cabeçalho X-OpenIPApi-Signature como sha256=<hex>. Sempre verifique antes de agir sobre o 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)
  });

Política de retentativas

Seu endpoint deve responder em 10 segundos com HTTP 2xx para confirmar o recebimento. Qualquer outro status (ou timeout) aciona retentativas com backoff exponencial: 1 min, 5 min, 30 min, 2 h, 12 h. Após a tentativa final, o webhook é marcado como falho e um alerta no painel é gerado.

Histórico de entregas e replay

O console → Webhooks mantém as últimas 100 tentativas de entrega por conta, mostrando o tipo de evento, código de status HTTP e o corpo de resposta retornado pelo seu endpoint. Você pode repetir qualquer entrega anterior para reenviar o payload assinado original, e usar o Depurador de Assinatura integrado para verificar assinaturas HMAC-SHA256 no lado do cliente sem compartilhar o seu segredo com nenhum servidor.

As entregas repetidas incluem um cabeçalho adicional X-OpenIPApi-Replay: 1 para que seu endpoint possa distingui-las de eventos ao vivo.

Exemplos de código — curl

Consulta única

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

Consulta em lote

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

Seu IP

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

Exemplos de código — JavaScript

Consulta única (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

Consulta em lote

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

Exemplos de código — Python

Consulta única (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

Consulta em lote

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