📖 Documentación de la API
Referencia completa — autenticación, endpoints, parámetros y ejemplos. Base URL: https://api.scorecidades.com.br
Introducción
La API REST de Score de Cidades proporciona datos socioeconómicos de 5.570 municipios brasileños, 27 estados y más de 20.000 barrios. Los datos integran IBGE, RAIS, Anatel, Banco Central, Ministerio de Salud y Receita Federal.
Base URL: https://api.scorecidades.com.br — todas las respuestas en JSON.
🔑 Autenticación
El plan Free no requiere autenticación. Los planes Starter y Pro requieren una clave de API en el header x-api-key.
# Plan Free (sin clave) curl "https://api.scorecidades.com.br/v1/cidade/sao-paulo?lang=es" # Planes Starter/Pro curl -H "x-api-key: sk_live_TU_TOKEN" \ "https://api.scorecidades.com.br/v1/cidade/sao-paulo/economia?lang=es"
Nunca expongas tu clave en el frontend. Úsala solo en backends o entornos seguros.
📊 Límites de Uso
| Plan | Límite | Período | Reset |
|---|---|---|---|
| Free | 100 req | Por día | Medianoche UTC |
| Starter | 10.000 req | Por mes | Día 1 de cada mes |
| Pro | 100.000 req | Por mes | Día 1 de cada mes |
| Enterprise | Ilimitado | — | — |
⚠️ Errores
| Status | Código | Descripción |
|---|---|---|
| 401 | unauthorized | Clave ausente o inválida |
| 403 | forbidden | Tu plan no incluye este endpoint |
| 404 | not_found | Municipio no encontrado |
| 429 | rate_limited | Límite de solicitudes excedido |
GET /v1/cidade/{slug}Free
GET/v1/cidade/{slug}
Devuelve datos básicos de un municipio. El slug es el nombre en minúsculas con guiones (ej: sao-paulo, belo-horizonte).
curl "https://api.scorecidades.com.br/v1/cidade/curitiba?lang=es"
🌐 Soporte de Idiomas
Todos los endpoints aceptan el parâmetro ?lang=.
| Valor | Idioma | Nota |
|---|---|---|
pt | Portugués (por defecto) | — |
en | Inglés | — |
es | Español | — |
zh | Chino simplificado | Incluye resumen IA (plan Pro) |
¿Preguntas o interesado en un plan Enterprise? Contáctanos.