Comprobación de estado
Comprueba el estado operativo del servicio SharpAPI y lo actualizados que están sus datos de cuotas.
GET /api/v1/healthAutenticaciónEnlace permanente a esta sección
No requiere autenticación. Es un endpoint público. (Una petición HEAD devuelve solo el código de estado, sin cuerpo.) Solo se aceptan GET y HEAD; consulta Otros métodos.
Ejemplos de solicitudesEnlace permanente a esta sección
cURL
curl -X GET "https://api.sharpapi.io/api/v1/health"RespuestaEnlace permanente a esta sección
La respuesta es un objeto plano con exactamente dos campos, status y newest_odds_age_s. No hay envoltorio checks/timestamp y no se devuelven datos de compilación ni diagnósticos del backend.
Correcto (200)Enlace permanente a esta sección
{
"status": "ok",
"newest_odds_age_s": 1
}Degradado (200)Enlace permanente a esta sección
El servicio está activo pero no tiene datos de cuotas recientes (la última actualización completada tiene más de 60 s, o todavía no se ha completado ninguna). El código HTTP se mantiene en 200 para que los balanceadores de carga sigan enrutando aquí durante una incidencia en los datos de origen:
{
"status": "degraded",
"newest_odds_age_s": 142
}Iniciando (503)Enlace permanente a esta sección
El proceso está activo y aceptando conexiones, pero el arranque (carga de cuotas, preparación de cachés) no ha terminado. Vuelve a intentarlo en breve:
{
"status": "starting",
"newest_odds_age_s": -1
}Caído (503)Enlace permanente a esta sección
Una dependencia principal del backend no está accesible:
{
"status": "down",
"newest_odds_age_s": 9
}Cabeceras de respuestaEnlace permanente a esta sección
X-Request-Id: 1782526326424224-82519El endpoint de health no devuelve cabeceras de límite de peticiones (rate limit) ni cabeceras de nivel (tier), ya que no requiere autenticación.
Campos de respuestaEnlace permanente a esta sección
| Campo | Tipo | Descripción |
|---|---|---|
status | string | Estado general: ok, degraded, starting o down |
newest_odds_age_s | integer | Segundos desde que la API completó por última vez una actualización de sus datos de cuotas. -1 mientras no se hayan cargado datos de cuotas. Mide el ciclo de actualización, no la antigüedad de cada cuota individual. |
Versiones anteriores de este endpoint también devolvían un identificador de compilación y diagnósticos del backend. Ya no forman parte de la respuesta pública: lee solo status y newest_odds_age_s.
Valores de estadoEnlace permanente a esta sección
| Estado | Código HTTP | Significado |
|---|---|---|
ok | 200 | Hay datos de cuotas recientes (última actualización hace 60 s o menos) |
degraded | 200 | Activo, pero sin datos de cuotas recientes (última actualización hace más de 60 s, o ninguna cargada) |
starting | 503 | Proceso activo pero el arranque no ha terminado |
down | 503 | Una dependencia principal del backend no está accesible |
Lógica del estadoEnlace permanente a esta sección
El status general se determina en este orden:
- Arranque sin terminar →
starting(503). - Dependencia principal del backend inaccesible →
down(503). - Datos de cuotas obsoletos o vacíos (la última actualización tiene más de 60 segundos, o todavía no se ha completado ninguna) →
degraded(200). - En cualquier otro caso →
ok(200).
Otros métodosEnlace permanente a esta sección
Cualquier método distinto de GET o HEAD devuelve 405 Method Not Allowed con la cabecera Allow: GET, HEAD:
curl -i -X POST "https://api.sharpapi.io/api/v1/health"HTTP/1.1 405 Method Not Allowed
Allow: GET, HEAD
X-Error-Code: method_not_allowed{
"error": {
"code": "method_not_allowed",
"message": "Method not allowed"
}
}Consulta Códigos de error HTTP.
Casos de usoEnlace permanente a esta sección
Monitorización y alertasEnlace permanente a esta sección
Usa el endpoint de health en tu stack de monitorización (Prometheus, Datadog, UptimeRobot, etc.) para detectar incidencias:
# Simple health check for monitoring scripts
STATUS=$(curl -s https://api.sharpapi.io/api/v1/health | jq -r '.status')
if [ "$STATUS" != "ok" ]; then
echo "ALERT: SharpAPI status is $STATUS"
fiVerificación de salud previa a la solicitudEnlace permanente a esta sección
Comprueba la salud antes de realizar peticiones críticas:
async function safeRequest(endpoint) {
const health = await fetch('https://api.sharpapi.io/api/v1/health')
.then(r => r.json());
if (health.status === 'down' || health.status === 'starting') {
throw new Error(`SharpAPI is not ready (status: ${health.status})`);
}
if (health.status === 'degraded') {
console.warn('SharpAPI is degraded - data may be stale');
}
return fetch(`https://api.sharpapi.io/api/v1${endpoint}`, {
headers: { 'X-API-Key': 'YOUR_API_KEY' }
}).then(r => r.json());
}Panel de uptimeEnlace permanente a esta sección
import requests
response = requests.get('https://api.sharpapi.io/api/v1/health')
health = response.json()
print(f"SharpAPI Status: {health['status'].upper()}")
print(f"Newest odds: {health['newest_odds_age_s']}s old")Endpoints relacionadosEnlace permanente a esta sección
- Información de la cuenta - Comprueba el estado y los límites de tu cuenta
- Resumen de la referencia de la API - Documentación completa de la API