Nominatim · Schema

Address

Structured address breakdown returned when addressdetails=1.

GeocodingOpenStreetMapMapsLocationServicesOpenSourcePublic APIs

Properties

Name Type Description
house_number string
road string
neighbourhood string
suburb string
hamlet string
village string
town string
city string
municipality string
county string
state_district string
state string
region string
postcode string
country string
country_code string ISO 3166-1 alpha-2 country code, lowercase.
View JSON Schema on GitHub

JSON Schema

nominatim-address-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://nominatim.org/schemas/address.json",
  "title": "Address",
  "description": "Structured address breakdown returned when addressdetails=1.",
  "type": "object",
  "properties": {
    "house_number": { "type": "string" },
    "road": { "type": "string" },
    "neighbourhood": { "type": "string" },
    "suburb": { "type": "string" },
    "hamlet": { "type": "string" },
    "village": { "type": "string" },
    "town": { "type": "string" },
    "city": { "type": "string" },
    "municipality": { "type": "string" },
    "county": { "type": "string" },
    "state_district": { "type": "string" },
    "state": { "type": "string" },
    "region": { "type": "string" },
    "postcode": { "type": "string" },
    "country": { "type": "string" },
    "country_code": {
      "type": "string",
      "description": "ISO 3166-1 alpha-2 country code, lowercase."
    }
  },
  "additionalProperties": { "type": "string" }
}