📖 API文档
完整参考文档 — 身份验证、端点、参数和示例。
Base URL: https://api.scorecidades.com.br
介绍
Score de Cidades REST API提供5,570个巴西城市、27个州和超过20,000个街区的社会经济数据。 数据整合自IBGE(地理统计局)、RAIS(劳工部)、Anatel(电信局)、中央银行、卫生部和Receita Federal(税务局)。
/v1/🔑 身份验证
免费套餐无需身份验证 — 按IP限制请求频率。Starter和Pro ZH套餐需要在请求头 x-api-key 中传入API密钥。
# 免费套餐(无需密钥) curl "https://api.scorecidades.com.br/v1/cidade/sao-paulo?lang=zh" # Starter / Pro ZH 套餐 curl -H "x-api-key: sk_live_您的令牌" \ "https://api.scorecidades.com.br/v1/cidade/sao-paulo?lang=zh"
📊 使用限制
| 套餐 | 限制 | 周期 | 重置时间 |
|---|---|---|---|
| Free(免费) | 100次 | 每天 | 每天UTC零点 |
| Starter | 10,000次 | 每月 | 每月1日 |
| Pro ZH | 100,000次 | 每月 | 每月1日 |
| Enterprise | 无限制 | — | — |
超出限制时,API返回 429 Too Many Requests。
⚠️ 错误码
| 状态码 | 代码 | 说明 |
|---|---|---|
| 400 | bad_request | 参数无效或缺失 |
| 401 | unauthorized | API密钥缺失或无效 |
| 403 | forbidden | 您的套餐不包含此端点 |
| 404 | not_found | 城市或资源未找到 |
| 429 | rate_limited | 超出请求限制 |
| 500 | internal_error | 服务器内部错误 |
// 错误响应示例
{
"error": "rate_limited",
"message": "已超出每天100次请求限制。UTC零点重置。",
"reset_at": "2026-04-11T00:00:00Z"
}GET /v1/cidade/{slug}免费
返回城市的基本数据。slug 是城市名的小写连字符格式(例如:sao-paulo、belo-horizonte、curitiba)。
查询参数
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| lang | string | pt | 响应语言:pt、en、es、zh |
curl "https://api.scorecidades.com.br/v1/cidade/sao-paulo?lang=zh"
{
"slug": "sao-paulo",
"nome": "圣保罗",
"uf": "SP",
"regiao": "东南部",
"populacao": 12325232,
"area_km2": 1521.11,
"idh": 0.805,
"pib_per_capita": 62450,
"score_investidor": 87.3,
"capital": false
}GET /v1/ranking免费
按HDI、人均GDP或投资者评分返回城市排名。
| 参数 | 类型 | 默认值 | 选项 |
|---|---|---|---|
| tipo | string | score | idh、pib、score |
| limit | number | 10 | 最多50条 |
| uf | string | — | 按州筛选(如 SP) |
GET /v1/estados免费
返回巴西27个州的基本数据列表。
GET /v1/cidadesStarter
带高级筛选条件的城市列表。
| 参数 | 类型 | 说明 |
|---|---|---|
| uf | string | 按州筛选(如 SP) |
| min_idh | number | 最低HDI值(如 0.75) |
| min_pib | number | 最低人均GDP |
| min_pop | number | 最低人口 |
| max_pop | number | 最高人口 |
| page | number | 页码(默认: 1) |
| limit | number | 每页条数(最多100) |
GET /v1/compararStarter
并排比较两个城市,包含各指标的百分比差值。
curl -H "x-api-key: sk_live_您的令牌" \ "https://api.scorecidades.com.br/v1/comparar?a=sao-paulo&b=curitiba&lang=zh"
GET /v1/custo-vida/{uf}Starter
各州首府的生活成本数据:一居室租金、基本食品篮子价格和汽油价格。覆盖27个首府城市。
GET /cidade/{slug}/economiaPro ZH
分部门GDP(农业、工业、服务业、公共行政)和银行信贷数据(ESTBAN/中央银行 2025)。
GET /cidade/{slug}/mercado-trabalhoPro ZH
RAIS 2022劳动力数据:月平均工资和大学及以上学历从业者百分比。
GET /cidade/{slug}/segurancaPro ZH
每10万居民凶杀率 — 卫生部死亡信息系统(SIM)2022年数据。
GET /cidade/{slug}/conectividadePro ZH
固定宽带光纤连接比例 — Anatel 2024年数据。
GET /v1/bairros/{slug}Pro ZH
来自Receita Federal(税务局)的按街区企业(CNPJ)汇总数据。目前覆盖巴西50个主要城市。
✨ 中文投资摘要(Pro ZH专属)
?lang=zh 参数时,响应中会自动包含 investment_summary 字段。中文投资摘要由 Claude AI(Anthropic)根据真实统计数据自动生成,内容涵盖:城市经济优势、劳动力市场状况、基础设施水平、安全环境和投资潜力评估。 专为中国投资者、企业决策者和研究人员设计。
curl -H "x-api-key: sk_live_您的令牌" \ "https://api.scorecidades.com.br/v1/cidade/curitiba?lang=zh"
{
"slug": "curitiba",
"nome": "库里蒂巴",
"uf": "PR",
"idh": 0.823,
"pib_per_capita": 48320,
"score_investidor": 84.0,
"investment_summary": "库里蒂巴是巴西南部巴拉那州首府,
以其高质量的城市规划和强劲的工业基础著称。
该市拥有0.823的高人类发展指数,
在全国城市中排名前列。主要优势包括:
发达的汽车和科技产业集群、
相对较低的犯罪率(每10万人16.2起凶杀案)、
以及97.3%的光纤宽带普及率。
对于寻求在巴西南部建立业务的投资者而言,
库里蒂巴提供了良好的商业环境和
受过良好教育的劳动力市场。"
}🌐 语言支持
所有端点均支持 ?lang= 参数。
| 值 | 语言 | 备注 |
|---|---|---|
pt | 葡萄牙语(默认) | — |
en | 英语 | — |
es | 西班牙语 | — |
zh | 简体中文 | Pro ZH套餐包含AI投资摘要(investment_summary) |
有疑问或想了解Enterprise套餐?欢迎联系我们。