Documentation
Open data
The Onde Viver Bem ranking of 175 cities is available as versioned, read-only files, updated November 18, 2026. Each metric carries its value, unit, source, an estimate flag and the method. Scores are editorial and indicative. They are not immigration, investment or real-estate advice.
Dataset date: November 18, 2026. GET and HEAD are open, with CORS allowed for any origin. There is no key and no rate limit beyond the CDN.
Endpoints
| Resource | What it contains | Format |
|---|---|---|
/api/v1/cidades.json | All 175 cities, with every published metric | JSON |
/api/v1/cidades.csv | The same list in a compact table (score, land price, URLs) | CSV |
/api/v1/cidades/{slug}.json | One city, for example es-malaga or pt-porto | JSON |
/api/v1/paises.json | Countries, with each city’s place in the country and in the global ranking | JSON |
/api/v1/bairros.json | Areas on the neighbourhood maps, and combined scores when they are in the public ranking | JSON |
/api/v1/openapi.json | Machine-readable contract (OpenAPI 3.1) | JSON |
/llms.txt | Curated map of the site, in the llms.txt v2 convention | Markdown |
/llms-full.txt | The same, plus every city and score | Markdown |
For AI agents
Start with /llms.txt (short index) or /llms-full.txt (cities and scores). The OpenAPI 3.1 document at /api/v1/openapi.json can be imported as an action schema (no authentication). A discovery manifest is at /.well-known/ai-plugin.json. A read-only MCP endpoint, with no new account or cost, lives at /mcp (manifest: /.well-known/mcp.json). Crawlers including GPTBot, ClaudeBot, PerplexityBot and Google-Extended are allowed in robots.txt.
License and attribution
You may read and reuse the files under /api/v1 with attribution to Onde Viver Bem (https://ondeviverbem.com) and to the source cited on each metric. The scores are an editorial compilation. Underlying figures remain under each source’s terms (listed in the fonte object, including the source’s own licence when we have it). Do not present an estimate as a measurement, and do not cite an internal study version — use the date.
Contact: contato@ondeviverbem.com · Methodology · Who we are