Skip to content
IndepAI API Docs

Get City Detail

GET
/api/v1/geo/cities/{slug}
curl --request GET \
  --url https://indepai.app/api/v1/geo/cities/lisbon-portugal

Get full city details by slug, including cost of living, quality of life, visa info, and related cities.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required

City slug identifier

string
Example
lisbon-portugal

Responses

Section titled “Responses”

200

Section titled “200”

Full city detail

Media typeapplication/json
object
success
required
boolean
data
required
Array<object>
object
id
required

City identifier

string
name
required

City name

string
country
required

Country name

string
countryCode
required

ISO 3166-1 alpha-2 country code

string
>= 2 characters <= 2 characters
region
required

Geographic region

string
coordinates
required

City coordinates

object
lat
required
number
>= -90 <= 90
lng
required
number
>= -180 <= 180
costOfLiving
required
object
monthlyTotal
required

Total monthly cost of living (EUR)

number
housing
required

Monthly housing cost (EUR)

number
food
required

Monthly food cost (EUR)

number
transportation
required

Monthly transportation cost (EUR)

number
utilities
required

Monthly utilities cost (EUR)

number
entertainment
required

Monthly entertainment cost (EUR)

number
other
required

Other monthly costs (EUR)

number
qualityOfLife
required
object
overall
required

Overall quality of life score (0-100)

number
<= 100
safety
required

Safety score (0-100)

number
<= 100
healthcare
required

Healthcare quality score (0-100)

number
<= 100
climate
required

Climate score (0-100)

number
<= 100
internet
required

Internet quality score (0-100)

number
<= 100
englishFriendly
required

English-friendliness score (0-100)

number
<= 100
taxInfo
required
object
incomeTaxRate
required

Top marginal income tax rate (%)

number
<= 100
capitalGainsTaxRate
required

Capital gains tax rate (%)

number
<= 100
specialPrograms
required

Available special tax programs

Array<string>
nomadScore
required

Overall nomad-friendliness score (0-100)

number
<= 100
visaInfo
required
object
schengen
required

Is in Schengen area

boolean
digitalNomadVisa
required

Offers digital nomad visa

boolean
visaFreeFor
required

Countries with visa-free access

Array<string>
currency
required

Local currency code

string
>= 3 characters <= 3 characters
lastUpdated
required

Last data update timestamp

string format: date-time
meta
required
object
total
required
integer
limit
required
integer
offset
required
integer
hasMore
required
boolean
timestamp
required
string format: date-time
Example
{
  "success": true,
  "data": [
    {
      "id": "lisbon-portugal",
      "name": "Lisbon",
      "country": "Portugal",
      "countryCode": "PT",
      "region": "Western Europe",
      "coordinates": {
        "lat": 38.7223,
        "lng": -9.1393
      },
      "costOfLiving": {
        "monthlyTotal": 1800,
        "housing": 900,
        "food": 350,
        "transportation": 50,
        "utilities": 100,
        "entertainment": 200,
        "other": 200
      },
      "qualityOfLife": {
        "overall": 75,
        "safety": 80,
        "healthcare": 70,
        "climate": 85,
        "internet": 75,
        "englishFriendly": 70
      },
      "taxInfo": {
        "incomeTaxRate": 48,
        "capitalGainsTaxRate": 28,
        "specialPrograms": [
          "NHR (Non-Habitual Resident)"
        ]
      },
      "nomadScore": 82,
      "visaInfo": {
        "visaFreeFor": [
          "US",
          "UK",
          "CA",
          "AU"
        ]
      },
      "currency": "EUR"
    }
  ]
}

400

Section titled “400”

Missing slug parameter

Media typeapplication/json
object
success
required

Always false for error responses

boolean
error
required

Error type

string
code

Machine-readable error code

string
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
message
required

Error message

string
Example
{
  "success": false,
  "error": "Validation error",
  "code": "VALIDATION_ERROR",
  "details": [
    {
      "path": "currentAge",
      "message": "Must be between 18 and 100"
    }
  ]
}

404

Section titled “404”

City not found

Media typeapplication/json
object
success
required

Always false for error responses

boolean
error
required

Error type

string
code

Machine-readable error code

string
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
message
required

Error message

string
Example
{
  "success": false,
  "error": "Validation error",
  "code": "VALIDATION_ERROR",
  "details": [
    {
      "path": "currentAge",
      "message": "Must be between 18 and 100"
    }
  ]
}