Documentación de la API

Guía completa para integrar nuestra API de geolocalización por IP

🔐 Autenticación

Todas las rutas de la API requieren un token de autenticación. Puedes obtener tu token en el Dashboard después de registrarte.

Formas de proporcionar el token:

  • Header: X-API-Token: tu_token_aqui
  • Query parameter: ?api_token=tu_token_aqui

Inicio Rápido

Obtén la información geográfica de una IP con una simple petición HTTP:

GET /api/geoip/locate?ip=8.8.8.8&api_token=tu_token_aqui

Endpoints

GET /api/geoip/locate

Obtiene información geográfica detallada de una dirección IP.

Parámetros

Parámetro Tipo Descripción
api_token string Requerido - Token de autenticación (también puede enviarse en header X-API-Token)
ip string Dirección IP a consultar (opcional, por defecto usa la IP del cliente)
format string Formato de respuesta: json (por defecto) o xml
lookBlackList boolean Verificar si la IP está en listas negras (opcional)

Ejemplo de Respuesta (JSON)

{
  "ip": "8.8.8.8",
  "country": "Estados Unidos",
  "country_iso_code": "US",
  "city": "Mountain View",
  "region": "California",
  "region_code": "CA",
  "postal": "94043",
  "lat": 37.4056,
  "lon": -122.0775,
  "timezone": "America/Los_Angeles",
  "isp": "Google LLC",
  "org": "Google LLC"
}

Ejemplo de Uso

cURL (con token en query):

curl "https://tu-dominio.com/api/geoip/locate?ip=8.8.8.8&api_token=tu_token_aqui"

cURL (con token en header):

curl -H "X-API-Token: tu_token_aqui" "https://tu-dominio.com/api/geoip/locate?ip=8.8.8.8"

JavaScript:

fetch('/api/geoip/locate?ip=8.8.8.8&api_token=tu_token_aqui', {
  headers: {
    'X-API-Token': 'tu_token_aqui'  // O usar header en lugar de query
  }
})
  .then(response => response.json())
  .then(data => console.log(data));

PHP:

$token = 'tu_token_aqui';
$url = "https://tu-dominio.com/api/geoip/locate?ip=8.8.8.8&api_token=" . urlencode($token);
$response = file_get_contents($url);
$data = json_decode($response, true);
POST /api/geoip/batch

Consulta múltiples IPs en una sola petición.

Body (JSON)

{
  "ips": ["8.8.8.8", "1.1.1.1", "208.67.222.222"]
}
GET /api/geoip/simple

Versión simplificada que retorna solo país y código ISO.

Códigos de Estado

200 Petición exitosa
401 Token requerido o inválido
400 IP inválida o parámetros incorrectos
429 Límite de requests excedido
500 Error interno del servidor

Límites de Uso

Cada token tiene un límite mensual de requests configurable. Puedes ver y gestionar tus límites en el Dashboard.

Características:

  • Límites mensuales configurables por token
  • Tokens ilimitados disponibles (límite = -1)
  • Reset automático del contador cada mes
  • Seguimiento en tiempo real del uso

Cuando se excede el límite, recibirás un error 429 con información sobre cuándo se resetea el contador.

¿Necesitas ayuda?

Nuestro equipo está listo para ayudarte con cualquier duda sobre la API.

Ver Planes y Precios