# Overture Maps Schema Reference > Schema reference for all Overture Maps data types: addresses, base, buildings, divisions, places, and transportation. This file contains all documentation content in a single document following the llmstxt.org standard. ## Schema Reference # Overture Maps Schema :::note This section has been recently updated to reflect changes in our schema modeling. We welcome your feedback in [GitHub Discussions](https://github.com/OvertureMaps/data/discussions). ::: The Overture Maps schema defines the structure, properties, and constraints for all features across six themes: addresses, base, buildings, divisions, places, and transportation. The reference pages in this section document the theme-based and shared modules in the schema. The schema is authored as [Pydantic](https://docs.pydantic.dev/) models and the reference documentation is generated from those models. The source code lives in the [OvertureMaps/schema](https://github.com/OvertureMaps/schema) repository on GitHub. ## Why Use Pydantic to Define Data Schemas? This project addresses a fundamental challenge in data consumption: bridging the semantic gap between raw data and human understanding while enabling machine-actionable workflows. ## Why Schema at All: Beyond Raw Data Take a column like `pop_2020`. Is it total population? Population density per square kilometer? Working-age population? Without a schema, you're left sampling values and guessing from column names. Compare this to OpenStreetMap's approach: features use well-known key-value pairs like `building=residential` or `addr:housenumber=42` that have semantic meaning and can be looked up on the OSM wiki. This creates a step toward a schema — shared vocabulary with documented semantics used across a vast dataset. However, OSM tags remain free-form: multiple valid ways to express the same concept, no built-in validation, and complex downstream validation because of undocumented keys that might have meaning to someone, somewhere. A schema provides the structured alternative: explicit types, clear validation rules, and semantic meaning that both humans and systems can rely on. Data files containing only column names and values aren't fully documented. External metadata files typically focus on how data was collected and encoded, not on semantic meaning or validation rules. Data consumers struggle to understand what datasets contain and which columns they need for their goals. ## Why Pydantic Over JSON Schema: Solving Multiple Problems We initially chose JSON Schema because it aligned with our mental model and promised to solve our problems as we understood them. But JSON Schema surfaced several pain points: - **Authoring difficulty:** Hard to write correctly, difficult to verify, limited IDE support, no refactoring capabilities - **Tooling gaps:** Generic tools can't tailor output for specific applications like ours - **Development friction:** Schema changes required manual coordination across multiple artifacts Pydantic addresses these systematically: author in Python with full IDE support, generate tailored documentation, and automatically produce the specific artifacts each workflow needs. Pydantic can also produce JSON Schema, so any application that requires it can use it while we gain all the Python benefits during authoring. ## The Result: Faster Understanding, Higher Quality Instead of spending time deciphering what columns mean and whether data matches expectations, users can focus on their actual goals: analysis, visualization, integration. Quality improves because validation happens automatically rather than through manual inspection. The fundamental approach — human-readable authoring that generates machine-actionable outputs — has broader applications beyond Overture and geospatial data. We hope others will adapt these patterns for linking with Overture data or modeling their own domains entirely. ## Schema Modules Browse the schema reference in the sidebar. Modules are organized by theme and shared components: **Themes:** Addresses, Base, Buildings, Divisions, Places, Transportation **Shared:** Core (names, sources, cartographic hints), System (country codes, language tags, geometry primitives) --- ## Address Addresses are structured labels for the geographic locations where businesses and individuals reside. While address formats around the world have some general points in common, the specifics vary extensively from place to place. The rules for dividing an address up into parts or fields vary, as do the names of those parts or fields. The address schema uses a simplified approach to capture the common structure of addresses worldwide while accommodating local variance. The schema is heavily based on the OpenAddresses ([www.openaddresses.io](https://www.openaddresses.io)) project. For sub-country administrative levels (and non-administrative levels such as neighborhoods), the schema provides the `address_levels` field. This is where the names of cities and towns, provinces, state, and regions, and similar addressing units are found. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Position of the address. Addresses are point geometries.*Allowed geometry types: Point* | | `theme` | `"addresses"` | | | `type` | `"address"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `address_levels[]` | `list<`[`AddressLevel`](types/address_level.md)`>` (optional) | Names of the sub-country addressing areas the address belongs to, including the city or locality, in descending order of generality.The list is sorted so that the highest, or most general, level comes first (*e.g.*, region) and the lowest, or most particular level, comes last (*e.g.*, city or town).The number of items in this list and their meaning is country-dependent. For example, in the United States, we expect two items: the state, and the locality or municipality within the state. Other countries might have as few as one, or even three or more.When a specific level that is required for a country is not known. most likely because the data provider has not supplied it and we have not derived it from another source, the list item corresponding to that level must be present, but its `value` field should be omitted.*Minimum length: 1**Maximum length: 5* | | `address_levels[].value` | [`StrippedString`](../system/stripped_string.md) (optional) | A string without leading or trailing whitespace | | `country` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) | The country the address belongs to, as an ISO 3166-1 alpha-2 country code. | | `number` | [`StrippedString`](../system/stripped_string.md) (optional) | The house number.This field does not necessarily contain an integer or even a number. Values such as "74B", "189 1/2", and "208.5", where the non-integer or non-number part is part of the house number, not a unit number, are in common use.*Minimum length: 1* | | `postal_city` | [`StrippedString`](../system/stripped_string.md) (optional) | The postal authority designated city name, if applicable.In some countries or regions, a mailing address may need to specify a different city name than the city that actually contains the address coordinates. This optional field can be used to specify the alternate city name to use.For example:- The postal city for the US address *716 East County Road, Winchester, Indiana* is Ridgeville. - The postal city for the Slovenian address *Tomaj 71, 6221 Tomaj, Slovenia* is Dutovlje.*Minimum length: 1* | | `postcode` | [`StrippedString`](../system/stripped_string.md) (optional) | The postal code.*Minimum length: 1* | | `street` | [`StrippedString`](../system/stripped_string.md) (optional) | The street name.The street name can include a type (*e.g.*, "Street" or "St", "Boulevard" or "Blvd", *etc.*) and a directional (*e.g.*, "NW" or "Northwest", "S" or "Sud"). Both type and directional, if present, may be either a prefix or a suffix to the primary name. They may either be fully spelled-out or abbreviated.*Minimum length: 1* | | `unit` | [`StrippedString`](../system/stripped_string.md) (optional) | The secondary address unit designator.In the case where the primary street address is divided into secondary units, which may be apartments, floors, or even buildings if the primary street address is a campus, this field names the specific secondary unit being addressed.*Minimum length: 1* | ## Examples | Column | Value | | -------: | ------- | | `id` | `416ab01c-d836-4c4f-aedc-2f30941ce94d` | | `bbox.xmin` | `-176.56381225585938` | | `bbox.xmax` | `-176.56378173828125` | | `bbox.ymin` | `-43.94719696044922` | | `bbox.ymax` | `-43.94718933105469` | | `geometry` | `POINT (-176.5637854 -43.9471955)` | | `theme` | `addresses` | | `type` | `address` | | `version` | `1` | | `sources[0].property` | | | `sources[0].dataset` | `OpenAddresses/LINZ` | | `sources[0].record_id` | `null` | | `sources[0].update_time` | `null` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `address_levels[0].value` | `Chatham Islands` | | `address_levels[1].value` | `Chatham Island` | | `country` | `NZ` | | `number` | `54` | | `postal_city` | `null` | | `postcode` | `null` | | `street` | `Tikitiki Hill Road` | | `unit` | `null` | --- ## AddressLevel A sub-country addressing unit, such as a region, city, or neighborhood, that is less specific than a street name and not a postal code. In the following address, the terms `Montréal` and `QC` are address levels: ``` 3998 Rue De Bullion, Montréal, QC H2W 2E4 ``` The number of address levels per address is country-dependent. Other addressing systems may use the terms "administrative level" or "admin level" for the same concept. We have chosen the term "address level" to communicate the fact that in some countries and regions, address levels do not necessarily correspond to administrative units. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`StrippedString`](../../system/stripped_string.md) (optional) | A string without leading or trailing whitespace*Minimum length: 1* | ## Used By - [`Address`](../address.md) --- ## Bathymetry Bathymetry features provide topographic representations of underwater areas, such as parts of lake beds or ocean floors. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Shape of the underwater area, which may be a polygon or multi-polygon.*Allowed geometry types: MultiPolygon, Polygon* | | `theme` | `"base"` | | | `type` | `"bathymetry"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `depth` | [`Depth`](types/depth.md) | Depth below surface level of the feature in meters. | | `cartography` | [`CartographicHints`](../core/cartographic_hints.md) (optional) | | | `cartography.prominence` | [`Prominence`](../core/prominence.md) (optional) | Subjective scale of feature significance or importance, with 1 being the least, and 100 being the most, significant.This value can be used to help drive decisions about how and when to display a feature, and how to treat it relative to neighboring features.When populated by Overture, this value is derived from various factors including, but not limited to: feature and subtype, population, and capital status. | | `cartography.min_zoom` | [`MinZoom`](../core/min_zoom.md) (optional) | Recommended minimum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels below this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `cartography.max_zoom` | [`MaxZoom`](../core/max_zoom.md) (optional) | Recommended maximum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels above this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `cartography.sort_key` | [`SortKey`](../core/sort_key.md) (optional) | Integer indicating the recommended order in which to draw features.Features with a lower number should be drawn "in front" of features with a higher number. | ## Examples | Column | Value | | -------: | ------- | | `id` | `5d40bd6c-db14-5492-b29f-5e25a59032bc` | | `bbox.xmin` | `-175.12791442871094` | | `bbox.xmax` | `-170.05111694335938` | | `bbox.ymin` | `-77.9718246459961` | | `bbox.ymax` | `-75.64299774169922` | | `geometry` | `MULTIPOLYGON (((-170.71296928 -76.744313428, -170.719841483 -76.757076376, -170.731061124 -76.761...` | | `theme` | `base` | | `type` | `bathymetry` | | `version` | `0` | | `sources[0].property` | | | `sources[0].dataset` | `ETOPO/GLOBathy` | | `sources[0].record_id` | `2024-12-09T00:00:00.000Z` | | `sources[0].update_time` | `null` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `depth` | `500` | | `cartography.prominence` | `null` | | `cartography.min_zoom` | `null` | | `cartography.max_zoom` | `null` | | `cartography.sort_key` | `12` | --- ## Infrastructure Infrastructure features provide basic information about real-world infrastructure entitites such as bridges, airports, runways, aerialways, communication towers, and power lines. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Geometry of the infrastructure feature, which may be a point, line string, polygon, or multi-polygon.*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* | | `theme` | `"base"` | | | `type` | `"infrastructure"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `class` | [`InfrastructureClass`](types/infrastructure_class.md) | | | `subtype` | [`InfrastructureSubtype`](types/infrastructure_subtype.md) | | | `height` | [`Height`](types/height.md) (optional) | Height of the feature in meters. | | `surface` | [`SurfaceMaterial`](types/surface_material.md) (optional) | | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level | | `source_tags` | [`SourceTags`](types/source_tags.md) (map, optional) | Key-value pairs imported directly from the source data without change.This field provides access to raw OSM entity tags for features sourced from OpenStreetMap. | | `wikidata` | [`WikidataId`](../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | ## Examples | Column | Value | | -------: | ------- | | `id` | `e9e3d506-89c0-3473-8cee-5e5ac6596d6c` | | `bbox.xmin` | `-180.0` | | `bbox.xmax` | `-179.99998474121094` | | `bbox.ymin` | `-82.42408752441406` | | `bbox.ymax` | `-82.42407989501953` | | `geometry` | `POINT (-179.9999994 -82.42408)` | | `theme` | `base` | | `type` | `infrastructure` | | `version` | `0` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `n7674174803@2` | | `sources[0].update_time` | `2023-04-07T17:37:48.000Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `class` | `information` | | `subtype` | `pedestrian` | | `height` | `null` | | `surface` | `null` | | `names.primary` | `1306 km to South Pole` | | `names.common` | `null` | | `names.rules` | `null` | | `level` | `null` | | `source_tags` | `{"description": "1036 km to South Pole.", "information": "route_marker", "note": "The road contin...` | | `wikidata` | `Q800558` | --- ## Land Land features are representations of physical land surfaces. In Overture data releases, land features are sourced from OpenStreetMap. TODO. Finish this whenI get more info from Jennings. Physical representations of land surfaces. Global land derived from the inverse of OSM Coastlines. Translates `natural` tags from OpenStreetMap. TODO: Update this description when the relationship to `land_cover` is better understood. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Geometry of the land feature, which may be a point, line string, polygon, or multi-polygon.*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* | | `theme` | `"base"` | | | `type` | `"land"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `class` | [`LandClass`](types/land_class.md) (optional) | | | `subtype` | [`LandSubtype`](types/land_subtype.md) (optional) | | | `elevation` | [`Elevation`](types/elevation.md) (optional) | Elevation above sea level of the feature in meters. | | `surface` | [`SurfaceMaterial`](types/surface_material.md) (optional) | | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level | | `source_tags` | [`SourceTags`](types/source_tags.md) (map, optional) | Key-value pairs imported directly from the source data without change.This field provides access to raw OSM entity tags for features sourced from OpenStreetMap. | | `wikidata` | [`WikidataId`](../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | ## Examples | Column | Value | | -------: | ------- | | `id` | `70fc3596-a987-3fea-820c-c016c0a2f0da` | | `bbox.xmin` | `-178.7000274658203` | | `bbox.xmax` | `-178.6999969482422` | | `bbox.ymin` | `-85.45001220703125` | | `bbox.ymax` | `-85.44999694824219` | | `geometry` | `POINT (-178.7 -85.45)` | | `theme` | `base` | | `type` | `land` | | `version` | `0` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `n11693475112@1` | | `sources[0].update_time` | `2024-03-05T09:23:39.000Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `class` | `cliff` | | `subtype` | `physical` | | `elevation` | `null` | | `surface` | `null` | | `names.primary` | `Dismal Buttress` | | `names.common` | `null` | | `names.rules` | `null` | | `level` | `null` | | `source_tags` | `{"natural": "cliff", "ref:linz:place_id": "12318", "wikipedia": "en:Dismal Buttress"}` | | `wikidata` | `Q5282342` | --- ## LandCover Land cover features indicate the primary natural or artificial surface material covering a land area on the earth, including vegetation types like forests and crops, built environments like cities, and natural surfaces like wetlands or barren ground. Land cover features relate to `LandUse` features in the following way: land cover is the physical thing covering the land, while land use is the human use to which the land is being put. TODO: Explain relationship to `Land` features. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Shape of the covered land area, which may be a polygon or multi-polygon.*Allowed geometry types: MultiPolygon, Polygon* | | `theme` | `"base"` | | | `type` | `"land_cover"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `subtype` | [`LandCoverSubtype`](types/land_cover_subtype.md) | | | `cartography` | [`CartographicHints`](../core/cartographic_hints.md) (optional) | | | `cartography.prominence` | [`Prominence`](../core/prominence.md) (optional) | Subjective scale of feature significance or importance, with 1 being the least, and 100 being the most, significant.This value can be used to help drive decisions about how and when to display a feature, and how to treat it relative to neighboring features.When populated by Overture, this value is derived from various factors including, but not limited to: feature and subtype, population, and capital status. | | `cartography.min_zoom` | [`MinZoom`](../core/min_zoom.md) (optional) | Recommended minimum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels below this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `cartography.max_zoom` | [`MaxZoom`](../core/max_zoom.md) (optional) | Recommended maximum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels above this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `cartography.sort_key` | [`SortKey`](../core/sort_key.md) (optional) | Integer indicating the recommended order in which to draw features.Features with a lower number should be drawn "in front" of features with a higher number. | ## Examples | Column | Value | | -------: | ------- | | `id` | `c347312d-012b-5e73-8bd3-a10d04b2981d` | | `bbox.xmin` | `-180.0001983642578` | | `bbox.xmax` | `-179.99313354492188` | | `bbox.ymin` | `65.95172119140625` | | `bbox.ymax` | `65.96218872070312` | | `geometry` | `POLYGON ((-179.99877531181616 65.95172539425603, -179.99740705536922 65.95265577758867, -179.9975...` | | `theme` | `base` | | `type` | `land_cover` | | `version` | `0` | | `sources[0].property` | | | `sources[0].dataset` | `ESA WorldCover` | | `sources[0].record_id` | `null` | | `sources[0].update_time` | `2024-11-07T00:00:00.000Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `subtype` | `barren` | | `cartography.prominence` | `null` | | `cartography.min_zoom` | `8` | | `cartography.max_zoom` | `15` | | `cartography.sort_key` | `3` | --- ## LandUse Land use features specify the predominant human use of an area of land, for example commercial activity, recreation, farming, housing, education, or military use. Land use features relate to `LandCover` features in the following way: land use is the human human activity being done with the land, while land cover is the physical thing that covers it. TODO: Explain relationship to `Land` features. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Geometry of the land use area, which may be a point, line string, polygon, or multi-polygon.*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* | | `theme` | `"base"` | | | `type` | `"land_use"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `class` | [`LandUseClass`](types/land_use_class.md) | | | `subtype` | [`LandUseSubtype`](types/land_use_subtype.md) | | | `elevation` | [`Elevation`](types/elevation.md) (optional) | Elevation above sea level of the feature in meters. | | `surface` | [`SurfaceMaterial`](types/surface_material.md) (optional) | | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level | | `source_tags` | [`SourceTags`](types/source_tags.md) (map, optional) | Key-value pairs imported directly from the source data without change.This field provides access to raw OSM entity tags for features sourced from OpenStreetMap. | | `wikidata` | [`WikidataId`](../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | ## Examples | Column | Value | | -------: | ------- | | `id` | `1e1f6095-5bd2-3fdb-a422-41351b848e9d` | | `bbox.xmin` | `-176.56825256347656` | | `bbox.xmax` | `-176.56231689453125` | | `bbox.ymin` | `-43.96001052856445` | | `bbox.ymax` | `-43.95420837402344` | | `geometry` | `POLYGON ((-176.5623454 -43.9567812, -176.5627644 -43.9561272, -176.5626898 -43.9557432, -176.5624...` | | `theme` | `base` | | `type` | `land_use` | | `version` | `0` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `w56117029@3` | | `sources[0].update_time` | `2010-04-24T22:35:13.000Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `class` | `golf_course` | | `subtype` | `golf` | | `elevation` | `null` | | `surface` | `null` | | `names.primary` | `Chatham Islands Golf Club` | | `names.common` | `null` | | `names.rules` | `null` | | `level` | `null` | | `source_tags` | `{"LINZ:source_version": "V16", "attribution": "http://wiki.osm.org/wiki/Attribution#LINZ", "leisu...` | | `wikidata` | `null` | --- ## Depth Depth below surface level of the feature in meters. Underlying type: `int32` ## Constraints - `≥ 0` - `≥ -2147483648` (from [`int32`](../../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../../system/primitive/primitives.md)) ## Used By - [`Bathymetry`](../bathymetry.md) --- ## Elevation Elevation above sea level of the feature in meters. Underlying type: `int32` ## Constraints - `≤ 9000` - `≥ -2147483648` (from [`int32`](../../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../../system/primitive/primitives.md)) ## Used By - [`Land`](../land.md) - [`LandUse`](../land_use.md) --- ## Height Height of the feature in meters. Underlying type: `float64` ## Constraints - `> 0` ## Used By - [`Infrastructure`](../infrastructure.md) --- ## InfrastructureClass Further classification of the type of infrastructure. The infrastructure class adds detail to the broad classification of `InfrastructureSubtype`. ## Values - `aerialway_station` - `airport` - `airport_gate` - `airstrip` - `apron` - `aqueduct` - `artwork` - `atm` - `barrier` - `bell_tower` - `bench` - `bicycle_parking` - `bicycle_rental` - `block` - `boardwalk` - `bollard` - `border_control` - `breakwater` - `bridge` - `bridge_support` - `bump_gate` - `bus_route` - `bus_station` - `bus_stop` - `bus_trap` - `cable` - `cable_barrier` - `cable_car` - `cable_distribution` - `camp_site` - `cantilever` - `catenary_mast` - `cattle_grid` - `chain` - `chair_lift` - `charging_station` - `city_wall` - `communication_line` - `communication_pole` - `communication_tower` - `connection` - `cooling` - `covered` - `crossing` - `cutline` - `cycle_barrier` - `dam` - `defensive` - `ditch` - `diving` - `drag_lift` - `drain` - `drinking_water` - `entrance` - `fence` - `ferry_terminal` - `fire_hydrant` - `fountain` - `full-height_turnstile` - `gasometer` - `gate` - `generator` - `give_way` - `gondola` - `goods` - `guard_rail` - `hampshire_gate` - `handrail` - `hedge` - `height_restrictor` - `heliostat` - `helipad` - `heliport` - `hose` - `information` - `insulator` - `international_airport` - `j-bar` - `jersey_barrier` - `kerb` - `kissing_gate` - `launchpad` - `lift_gate` - `lighting` - `lightning_protection` - `magic_carpet` - `manhole` - `milestone` - `military_airport` - `minaret` - `minor_line` - `mixed_lift` - `mobile_phone_tower` - `monitoring` - `motorcycle_parking` - `motorway_junction` - `movable` - `municipal_airport` - `observation` - `parking` - `parking_entrance` - `parking_space` - `pedestrian_crossing` - `picnic_table` - `pier` - `pipeline` - `plant` - `planter` - `platform` - `platter` - `portal` - `post_box` - `power_line` - `power_pole` - `power_tower` - `private_airport` - `pylon` - `quay` - `radar` - `railway_halt` - `railway_station` - `recycling` - `regional_airport` - `reservoir_covered` - `retaining_wall` - `roller_coaster` - `rope_tow` - `runway` - `sally_port` - `seaplane_airport` - `sewer` - `silo` - `siren` - `stile` - `stop` - `stop_position` - `stopway` - `storage_tank` - `street_cabinet` - `street_lamp` - `substation` - `subway_station` - `swing_gate` - `switch` - `t-bar` - `taxilane` - `taxiway` - `terminal` - `toilets` - `toll_booth` - `traffic_signals` - `transformer` - `trestle` - `utility_pole` - `vending_machine` - `viaduct` - `viewpoint` - `wall` - `waste_basket` - `waste_disposal` - `watchtower` - `water_tower` - `weir` - `zip_line` ## Used By - [`Infrastructure`](../infrastructure.md) --- ## InfrastructureSubtype Broadest classification of the type of infrastructure. This broad classification can be refined by `InfrastructureClass`. ## Values - `aerialway` - `airport` - `barrier` - `bridge` - `communication` - `emergency` - `manhole` - `pedestrian` - `pier` - `power` - `quay` - `recreation` - `tower` - `transit` - `transportation` - `utility` - `waste_management` - `water` ## Used By - [`Infrastructure`](../infrastructure.md) --- ## LandClass Further classification of the land. The land class adds detail to the broad classification of `LandSubtype`. ## Values - `archipelago` - `bare_rock` - `beach` - `cave_entrance` - `cliff` - `desert` - `dune` - `fell` - `forest` - `glacier` - `grass` - `grassland` - `heath` - `hill` - `island` - `islet` - `land` - `meadow` - `meteor_crater` - `mountain_range` - `peak` - `peninsula` - `plateau` - `reef` - `ridge` - `rock` - `saddle` - `sand` - `scree` - `scrub` - `shingle` - `shrub` - `shrubbery` - `stone` - `tree` - `tree_row` - `tundra` - `valley` - `volcanic_caldera_rim` - `volcano` - `wetland` - `wood` ## Used By - [`Land`](../land.md) --- ## LandCoverSubtype Primary or dominant material covering the land. ## Values - `barren` - `crop` - `forest` - `grass` - `mangrove` - `moss` - `shrub` - `snow` - `urban` - `wetland` ## Used By - [`LandCover`](../land_cover.md) --- ## LandSubtype Broadest classification of the land. This broad classification can be refined by `LandClass`. ## Values - `crater` - `desert` - `forest` - `glacier` - `grass` - `land` - `physical` - `reef` - `rock` - `sand` - `shrub` - `tree` - `wetland` ## Used By - [`Land`](../land.md) --- ## LandUseClass Further classification of the land use. The land use class adds detail to the broad classification of `LandUseSubtype`. ## Values - `aboriginal_land` - `airfield` - `allotments` - `animal_keeping` - `aquaculture` - `barracks` - `base` - `beach_resort` - `brownfield` - `bunker` - `camp_site` - `cemetery` - `clinic` - `college` - `commercial` - `connection` - `construction` - `danger_area` - `doctors` - `dog_park` - `downhill` - `driving_range` - `driving_school` - `education` - `environmental` - `fairway` - `farmland` - `farmyard` - `fatbike` - `flowerbed` - `forest` - `garages` - `garden` - `golf_course` - `grass` - `grave_yard` - `green` - `greenfield` - `greenhouse_horticulture` - `highway` - `hike` - `hospital` - `ice_skate` - `industrial` - `institutional` - `kindergarten` - `landfill` - `lateral_water_hazard` - `logging` - `marina` - `meadow` - `military` - `military_hospital` - `military_school` - `music_school` - `national_park` - `natural_monument` - `nature_reserve` - `naval_base` - `nordic` - `nuclear_explosion_site` - `obstacle_course` - `orchard` - `park` - `peat_cutting` - `pedestrian` - `pitch` - `plant_nursery` - `playground` - `plaza` - `protected` - `protected_landscape_seascape` - `quarry` - `railway` - `range` - `recreation_ground` - `religious` - `residential` - `resort` - `retail` - `rough` - `salt_pond` - `school` - `schoolyard` - `ski_jump` - `skitour` - `sled` - `sleigh` - `snow_park` - `species_management_area` - `stadium` - `state_park` - `static_caravan` - `strict_nature_reserve` - `tee` - `theme_park` - `track` - `traffic_island` - `training_area` - `trench` - `university` - `village_green` - `vineyard` - `water_hazard` - `water_park` - `wilderness_area` - `winter_sports` - `works` - `zoo` ## Used By - [`LandUse`](../land_use.md) --- ## LandUseSubtype Broadest classification of the land use. This broad classification can be refined by `LandUseClass`. ## Values - `agriculture` - `aquaculture` - `campground` - `cemetery` - `construction` - `developed` - `education` - `entertainment` - `golf` - `grass` - `horticulture` - `landfill` - `managed` - `medical` - `military` - `park` - `pedestrian` - `protected` - `recreation` - `religious` - `residential` - `resource_extraction` - `transportation` - `winter_sports` ## Used By - [`LandUse`](../land_use.md) --- ## SourceTags Key-value pairs imported directly from the source data without change. This field provides access to raw OSM entity tags for features sourced from OpenStreetMap. Underlying type: `map` ## Used By - [`Infrastructure`](../infrastructure.md) - [`Land`](../land.md) - [`LandUse`](../land_use.md) - [`Water`](../water.md) --- ## SurfaceMaterial Material that makes up the surface of `Infrastructure` and `Land` features. ## Values - `asphalt` - `cobblestone` - `compacted` - `concrete` - `concrete_plates` - `dirt` - `earth` - `fine_gravel` - `grass` - `gravel` - `ground` - `paved` - `paving_stones` - `pebblestone` - `recreation_grass` - `recreation_paved` - `recreation_sand` - `rubber` - `sand` - `sett` - `tartan` - `unpaved` - `wood` - `woodchips` ## Used By - [`Infrastructure`](../infrastructure.md) - [`Land`](../land.md) - [`LandUse`](../land_use.md) --- ## WaterClass Further description of the type of water body. The water class adds detail to the broad classification of `WaterSubtype`. ## Values - `basin` - `bay` - `blowhole` - `canal` - `cape` - `ditch` - `dock` - `drain` - `fairway` - `fish_pass` - `fishpond` - `geyser` - `hot_spring` - `lagoon` - `lake` - `moat` - `ocean` - `oxbow` - `pond` - `reflecting_pool` - `reservoir` - `river` - `salt_pond` - `sea` - `sewage` - `shoal` - `spring` - `strait` - `stream` - `swimming_pool` - `tidal_channel` - `wastewater` - `water` - `water_storage` - `waterfall` ## Used By - [`Water`](../water.md) --- ## WaterSubtype The broad classification of water body such as river, ocean or lake. This broad classification can be refined using `WaterClass`. ## Values - `canal` - `human_made` - `lake` - `ocean` - `physical` - `pond` - `reservoir` - `river` - `spring` - `stream` - `wastewater` - `water` ## Used By - [`Water`](../water.md) --- ## Water Water features represent ocean and inland water bodies. In Overture data releases, water features are sourced from OpenStreetMap. There are two main categories of water feature: ocean and inland water bodies. Ocean ----- The `subytpe` value `"ocean"` indicates an ocean area feature whose geometry represents the surface area of an ocean or part of an ocean. Ocean area may be tiled into many small polygons of consistent complexity to ensure manageable geometry. In Overture data releases, ocean area features are created from OpenStreetMap coastlines data (`natural=coastline`) using a QA'd version of the output from the OSMCoastline tool. In aggregate, all the ocean area features represent the inverse of the land features with subtype `"land"` and class `"land"`. The names and recommended label position for oceans and seas can be found in features with the subtype `"physical"` and the class `"ocean"` or `"sea"`. Inland Water ------------ Subtypes other than `"ocean"` (and `"physical"`) represent inland water bodies. In Overture data releases, these features are sourced from the OpenStreetMap tag `natural=*` where the tag value indicates a water body, as well as the tags `natural=water`, `waterway=*`, and `water=*`. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Geometry of the water feature, which may be a point, line string, polygon, or multi-polygon.*Allowed geometry types: LineString, MultiPolygon, Point, Polygon* | | `theme` | `"base"` | | | `type` | `"water"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `class` | [`WaterClass`](types/water_class.md) (optional) | | | `subtype` | [`WaterSubtype`](types/water_subtype.md) (optional) | | | `is_intermittent` | `boolean` (optional) | Whether the water body exists intermittently, not permanently*`strict=True`* | | `is_salt` | `boolean` (optional) | Whether the water body contains salt water*`strict=True`* | | `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `source_tags` | [`SourceTags`](types/source_tags.md) (map, optional) | Key-value pairs imported directly from the source data without change.This field provides access to raw OSM entity tags for features sourced from OpenStreetMap. | | `wikidata` | [`WikidataId`](../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | ## Examples | Column | Value | | -------: | ------- | | `id` | `6bbb5fe5-bf26-3efa-b120-0a7079b60840` | | `bbox.xmin` | `-177.03179931640625` | | `bbox.xmax` | `-177.0317840576172` | | `bbox.ymin` | `-84.93480682373047` | | `bbox.ymax` | `-84.9347915649414` | | `geometry` | `POINT (-177.031799 -84.934793)` | | `theme` | `base` | | `type` | `water` | | `version` | `0` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `n11109190647@2` | | `sources[0].update_time` | `2024-02-11T05:52:05.000Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `class` | `cape` | | `subtype` | `physical` | | `is_intermittent` | `null` | | `is_salt` | `null` | | `level` | `null` | | `names.primary` | `Thanksgiving Point` | | `names.common` | `null` | | `names.rules` | `null` | | `source_tags` | `{"natural": "cape", "ref:linz:place_id": "13433"}` | | `wikidata` | `Q33140589` | --- ## Building Buildings are man-made structures with roofs that exist permanently in one place. A building's geometry represents the two-dimensional footprint of the building as viewed from directly above, looking down. Fields such as `height` and `num_floors` allow the three-dimensional shape to be approximated. Some buildings, identified by the `has_parts` field, have associated `BuildingPart` features which can be used to generate a more representative 3D model of the building. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | The building's footprint or roofprint (if traced from aerial/satellite imagery).*Allowed geometry types: MultiPolygon, Polygon* | | `theme` | `"buildings"` | | | `type` | `"building"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `subtype` | [`BuildingSubtype`](types/building_subtype.md) (optional) | A broad classification of the current use and purpose of the building.If the current use of the building no longer accords with the original built purpose, the current use should be specified. For example, a building built as a train station but later converted into a shopping mall would have the value `"commercial"` rather than `"transportation"`. | | `class` | [`BuildingClass`](types/building_class.md) (optional) | A more specific classification of the current use and purpose of the building.If the current use of the building no longer accords with the original built purpose, the current use should be specified. | | `has_parts` | `boolean` (optional) | Whether the building has associated building part features*`strict=True`* | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level | | `height` | [`float64`](../system/primitive/primitives.md) (optional) | Height of the building or part in meters.This is the distance from the lowest point to the highest point.*`> 0`* | | `is_underground` | `boolean` (optional) | Whether the entire building or part is completely below ground.The underground flag is useful for display purposes. Buildings and building parts that are entirely below ground can be styled differently or omitted from the rendered image.This flag is conceptually different from the `level` field, which indicates relative z-ordering and, notably, can be negative even if the building is entirely above-ground.*`strict=True`* | | `num_floors` | [`int32`](../system/primitive/primitives.md) (optional) | Number of above-ground floors of the building or part.*`> 0`* | | `num_floors_underground` | [`int32`](../system/primitive/primitives.md) (optional) | Number of below-ground floors of the building or part.*`> 0`* | | `min_height` | [`float64`](../system/primitive/primitives.md) (optional) | Altitude above ground where the bottom of the building or building part starts.If present, this value indicates that the lowest part of the building or building part starts is above ground level. | | `min_floor` | [`int32`](../system/primitive/primitives.md) (optional) | Start floor of this building or part.If present, this value indicates that the building or part is "floating" and its bottom-most floor is above ground level, usually because it is part of a larger building in which some parts do reach down to ground level. An example is a building that has an entry road or driveway at ground level into an interior courtyard, where part of the building bridges above the entry road. This property may sometimes be populated when `min_height` is missing and in these cases can be used as a proxy for `min_height`.*`> 0`* | | `facade_color` | [`HexColor`](../system/hex_color.md) (optional) | Facade color in `#rgb` or `#rrggbb` hex notation | | `facade_material` | [`FacadeMaterial`](types/facade_material.md) (optional) | Outer surface material of the facade | | `roof_material` | [`RoofMaterial`](types/roof_material.md) (optional) | Outer surface material of the roof | | `roof_shape` | [`RoofShape`](types/roof_shape.md) (optional) | Shape of the roof | | `roof_direction` | [`float64`](../system/primitive/primitives.md) (optional) | Bearing of the roof ridge line in degrees*`≥ 0`**`< 360`* | | `roof_orientation` | [`RoofOrientation`](types/roof_orientation.md) (optional) | Orientation of the roof shape relative to the footprint shape | | `roof_color` | [`HexColor`](../system/hex_color.md) (optional) | The roof color in `#rgb` or `#rrggbb` hex notation | | `roof_height` | [`float64`](../system/primitive/primitives.md) (optional) | Height of the roof in meters.This is the distance from the base of the roof to its highest point. | ## Examples | Column | Value | | -------: | ------- | | `id` | `148f35b1-7bc1-4180-9280-10d39b13883b` | | `bbox.xmin` | `-176.643798828125` | | `bbox.xmax` | `-176.64349365234375` | | `bbox.ymin` | `-43.9938850402832` | | `bbox.ymax` | `-43.993709564208984` | | `geometry` | `POLYGON ((-176.6435004 -43.9938042, -176.6435738 -43.9937107, -176.6437726 -43.9937913, -176.6436...` | | `theme` | `buildings` | | `type` | `building` | | `version` | `1` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `w519166507@1` | | `sources[0].update_time` | `2017-08-27T21:39:50.000Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `subtype` | `null` | | `class` | `null` | | `has_parts` | `false` | | `names` | `null` | | `level` | `null` | | `height` | `null` | | `is_underground` | `false` | | `num_floors` | `null` | | `num_floors_underground` | `null` | | `min_height` | `null` | | `min_floor` | `null` | | `facade_color` | `null` | | `facade_material` | `null` | | `roof_material` | `null` | | `roof_shape` | `null` | | `roof_direction` | `null` | | `roof_orientation` | `null` | | `roof_color` | `null` | | `roof_height` | `null` | --- ## BuildingPart Building parts represent parts of larger building features. They allow buildings to be modeled in rich detail suitable for creating realistic 3D models. Every building part is associated with a parent `Building` feature via the `building_id` field. In addition, a building part has a footprint geometry and may include additional details such as its height, the number of floors, and the color and material of its facade and roof. Building parts can float or be stacked on top of each other. The `min_height`, `min_floor`, `height`, and `num_floors`, fields can be used to arrange the parts correctly along the vertical dimension. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | The footprint or roofprint of the building part.*Allowed geometry types: MultiPolygon, Polygon* | | `theme` | `"buildings"` | | | `type` | `"building_part"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `building_id` | [`Id`](../system/ref/id.md) | The building to which this part belongs*References [`Building`](building.md) (belongs to)* | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `level` | [`Level`](../core/level.md) (optional) | Z-order of the feature where 0 is visual level | | `height` | [`float64`](../system/primitive/primitives.md) (optional) | Height of the building or part in meters.This is the distance from the lowest point to the highest point.*`> 0`* | | `is_underground` | `boolean` (optional) | Whether the entire building or part is completely below ground.The underground flag is useful for display purposes. Buildings and building parts that are entirely below ground can be styled differently or omitted from the rendered image.This flag is conceptually different from the `level` field, which indicates relative z-ordering and, notably, can be negative even if the building is entirely above-ground.*`strict=True`* | | `num_floors` | [`int32`](../system/primitive/primitives.md) (optional) | Number of above-ground floors of the building or part.*`> 0`* | | `num_floors_underground` | [`int32`](../system/primitive/primitives.md) (optional) | Number of below-ground floors of the building or part.*`> 0`* | | `min_height` | [`float64`](../system/primitive/primitives.md) (optional) | Altitude above ground where the bottom of the building or building part starts.If present, this value indicates that the lowest part of the building or building part starts is above ground level. | | `min_floor` | [`int32`](../system/primitive/primitives.md) (optional) | Start floor of this building or part.If present, this value indicates that the building or part is "floating" and its bottom-most floor is above ground level, usually because it is part of a larger building in which some parts do reach down to ground level. An example is a building that has an entry road or driveway at ground level into an interior courtyard, where part of the building bridges above the entry road. This property may sometimes be populated when `min_height` is missing and in these cases can be used as a proxy for `min_height`.*`> 0`* | | `facade_color` | [`HexColor`](../system/hex_color.md) (optional) | Facade color in `#rgb` or `#rrggbb` hex notation | | `facade_material` | [`FacadeMaterial`](types/facade_material.md) (optional) | Outer surface material of the facade | | `roof_material` | [`RoofMaterial`](types/roof_material.md) (optional) | Outer surface material of the roof | | `roof_shape` | [`RoofShape`](types/roof_shape.md) (optional) | Shape of the roof | | `roof_direction` | [`float64`](../system/primitive/primitives.md) (optional) | Bearing of the roof ridge line in degrees*`≥ 0`**`< 360`* | | `roof_orientation` | [`RoofOrientation`](types/roof_orientation.md) (optional) | Orientation of the roof shape relative to the footprint shape | | `roof_color` | [`HexColor`](../system/hex_color.md) (optional) | The roof color in `#rgb` or `#rrggbb` hex notation | | `roof_height` | [`float64`](../system/primitive/primitives.md) (optional) | Height of the roof in meters.This is the distance from the base of the roof to its highest point. | ## Examples | Column | Value | | -------: | ------- | | `id` | `19412d64-51ac-3d6a-ac2f-8a8c8b91bb60` | | `bbox.xmin` | `-73.24630737304688` | | `bbox.xmax` | `-73.24613952636719` | | `bbox.ymin` | `-39.81101608276367` | | `bbox.ymax` | `-39.81088638305664` | | `geometry` | `POLYGON ((-73.2462509 -39.8108937, -73.2462755 -39.8109047, -73.246291 -39.8109182, -73.2463022 -...` | | `theme` | `buildings` | | `type` | `building_part` | | `version` | `0` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `w223076787@2` | | `sources[0].update_time` | `2014-10-31T22:55:36.000Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `building_id` | `bd663bd4-1844-4d7d-a400-114de051cf49` | | `names` | `null` | | `level` | `3` | | `height` | `null` | | `is_underground` | `false` | | `num_floors` | `null` | | `num_floors_underground` | `null` | | `min_height` | `null` | | `min_floor` | `null` | | `facade_color` | `null` | | `facade_material` | `null` | | `roof_material` | `null` | | `roof_shape` | `null` | | `roof_direction` | `null` | | `roof_orientation` | `null` | | `roof_color` | `null` | | `roof_height` | `null` | --- ## BuildingClass Further classification of the type and purpose of a building. The building class adds detail to the broad classification of `BuildingSubtype`. ## Values - `agricultural` - `allotment_house` - `apartments` - `barn` - `beach_hut` - `boathouse` - `bridge_structure` - `bungalow` - `bunker` - `cabin` - `carport` - `cathedral` - `chapel` - `church` - `civic` - `college` - `commercial` - `cowshed` - `detached` - `digester` - `dormitory` - `dwelling_house` - `factory` - `farm` - `farm_auxiliary` - `fire_station` - `garage` - `garages` - `ger` - `glasshouse` - `government` - `grandstand` - `greenhouse` - `guardhouse` - `hangar` - `hospital` - `hotel` - `house` - `houseboat` - `hut` - `industrial` - `kindergarten` - `kiosk` - `library` - `manufacture` - `military` - `monastery` - `mosque` - `office` - `outbuilding` - `parking` - `pavilion` - `post_office` - `presbytery` - `public` - `religious` - `residential` - `retail` - `roof` - `school` - `semi` - `semidetached_house` - `service` - `shed` - `shrine` - `silo` - `slurry_tank` - `sports_centre` - `sports_hall` - `stable` - `stadium` - `static_caravan` - `stilt_house` - `storage_tank` - `sty` - `supermarket` - `synagogue` - `temple` - `terrace` - `toilets` - `train_station` - `transformer_tower` - `transportation` - `trullo` - `university` - `warehouse` - `wayside_shrine` ## Used By - [`Building`](../building.md) --- ## BuildingSubtype Broadest classification of the type and purpose of a building. This broad classification can be refined by `BuildingClass`. ## Values - `agricultural` - `civic` - `commercial` - `education` - `entertainment` - `industrial` - `medical` - `military` - `outbuilding` - `religious` - `residential` - `service` - `transportation` ## Used By - [`Building`](../building.md) --- ## FacadeMaterial The outer surface material of building facade. ## Values - `brick` - `cement_block` - `clay` - `concrete` - `glass` - `metal` - `plaster` - `plastic` - `stone` - `timber_framing` - `wood` ## Used By - [`Building`](../building.md) - [`BuildingPart`](../building_part.md) --- ## RoofMaterial The outermost material of the roof. ## Values - `concrete` - `copper` - `eternit` - `glass` - `grass` - `gravel` - `metal` - `plastic` - `roof_tiles` - `slate` - `solar_panels` - `tar_paper` - `thatch` - `wood` ## Used By - [`Building`](../building.md) - [`BuildingPart`](../building_part.md) --- ## RoofOrientation Orientation of the roof shape relative to the footprint shape. The members of this enumeration, `"across"` and `"along"`, are borrowed from the OpenStreetMap `roof:orientation=*` tag and have the same meanings as they do in OSM. ## Values - `across` - The roof ridge runs perpendicular to the longer of the two building edges, parallel to the shorter - `along` - The roof ridge runs parallel to the longer of the two building edges ## Used By - [`Building`](../building.md) - [`BuildingPart`](../building_part.md) --- ## RoofShape The shape of the roof. ## Values - `dome` - `flat` - `gabled` - `gambrel` - `half_hipped` - `hipped` - `mansard` - `onion` - `pyramidal` - `round` - `saltbox` - `sawtooth` - `skillion` - `spherical` ## Used By - [`Building`](../building.md) - [`BuildingPart`](../building_part.md) --- ## CartographicHints Cartographic hints for optimal use of Overture features in map-making. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `prominence` | [`Prominence`](prominence.md) (optional) | Subjective scale of feature significance or importance, with 1 being the least, and 100 being the most, significant.This value can be used to help drive decisions about how and when to display a feature, and how to treat it relative to neighboring features.When populated by Overture, this value is derived from various factors including, but not limited to: feature and subtype, population, and capital status. | | `min_zoom` | [`MinZoom`](min_zoom.md) (optional) | Recommended minimum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels below this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `max_zoom` | [`MaxZoom`](max_zoom.md) (optional) | Recommended maximum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels above this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `sort_key` | [`SortKey`](sort_key.md) (optional) | Integer indicating the recommended order in which to draw features.Features with a lower number should be drawn "in front" of features with a higher number. | ## Used By - [`Bathymetry`](../base/bathymetry.md) - [`Division`](../divisions/division.md) - [`LandCover`](../base/land_cover.md) --- ## CommonNames A mapping from language to the most commonly used or recognized name in that language. Underlying type: `map<`[`LanguageTag`](../system/language_tag.md)`,`[`StrippedString`](../system/stripped_string.md)`>` ## Used By - [`Division`](../divisions/division.md) - [`Names`](names.md) --- ## ConfidenceScore Confidence score between 0.0 and 1.0 Underlying type: `float64` ## Constraints - `≥ 0.0` - `≤ 1.0` ## Used By - [`Place`](../places/place.md) - [`SourceItem`](source_item.md) --- ## FeatureVersion Underlying type: `int32` ## Constraints - `≥ 0` - `≥ -2147483648` (from [`int32`](../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../system/primitive/primitives.md)) ## Used By - [`Address`](../addresses/address.md) - [`Bathymetry`](../base/bathymetry.md) - [`Building`](../buildings/building.md) - [`BuildingPart`](../buildings/building_part.md) - [`Connector`](../transportation/connector.md) - [`Division`](../divisions/division.md) - [`DivisionArea`](../divisions/division_area.md) - [`DivisionBoundary`](../divisions/division_boundary.md) - [`Infrastructure`](../base/infrastructure.md) - [`Land`](../base/land.md) - [`LandCover`](../base/land_cover.md) - [`LandUse`](../base/land_use.md) - [`Place`](../places/place.md) - [`Segment`](../transportation/segment.md) - [`Water`](../base/water.md) --- ## LengthUnit Unit of length. ## Values - `in` - One inch in the imperial and US customary systems - `ft` - One foot in the imperial and US customary systems (12 inches) - `yd` - One yard in the imperial and US customary systems (three feet) - `mi` - One mile in the imperial and US customary systems (1,760 yards) - `cm` - One centimeter in the metric and SI systems - `m` - One meter in the metric and SI systems - `km` - One kilometer in the metric and SI systems ## Used By - [`VehicleHeightSelector`](scoping/vehicle_height_selector.md) - [`VehicleLengthSelector`](scoping/vehicle_length_selector.md) - [`VehicleWidthSelector`](scoping/vehicle_width_selector.md) --- ## Level Z-order of the feature where 0 is visual level Underlying type: `int32` ## Constraints - `≥ -2147483648` (from [`int32`](../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../system/primitive/primitives.md)) ## Used By - [`Building`](../buildings/building.md) - [`BuildingPart`](../buildings/building_part.md) - [`Infrastructure`](../base/infrastructure.md) - [`Land`](../base/land.md) - [`LandUse`](../base/land_use.md) - [`LevelRule`](../transportation/types/level_rule.md) - [`Water`](../base/water.md) --- ## MaxZoom Recommended maximum tile zoom level in which this feature should be displayed. It is recommended that the feature be hidden at zoom levels above this value. Zoom levels follow the Slippy Maps convention, documented in the following references: - [https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames) - [https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection](https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection) Underlying type: `int32` ## Constraints - `≥ 0` - `≤ 23` - `≥ -2147483648` (from [`int32`](../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../system/primitive/primitives.md)) ## Used By - [`CartographicHints`](cartographic_hints.md) --- ## MinZoom Recommended minimum tile zoom level in which this feature should be displayed. It is recommended that the feature be hidden at zoom levels below this value. Zoom levels follow the Slippy Maps convention, documented in the following references: - [https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames) - [https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection](https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection) Underlying type: `int32` ## Constraints - `≥ 0` - `≤ 23` - `≥ -2147483648` (from [`int32`](../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../system/primitive/primitives.md)) ## Used By - [`CartographicHints`](cartographic_hints.md) --- ## NameRule A rule that can be evaluated to determine the name in advanced scenarios. Name rules are used for cases where the primary name is not sufficient; the common name is not the right fit for the use case and another variant is needed; or where the name only applies in certain specific circumstances. Examples might include: - An official, alternate, or short name. - A name that only applies to part of a linear path like a road segment (geometric range scoping). - A name that only applies to the left or right side of a linear path like a road segment (side scoping). - A name that is only accepted by some political perspectives. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`StrippedString`](../system/stripped_string.md) | The actual name value.*Minimum length: 1* | | `variant` | [`NameVariant`](name_variant.md) | The name variant for this name rule. | | `language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `perspectives` | [`Perspectives`](perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `perspectives.mode` | [`PerspectiveMode`](perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `between` | [`LinearlyReferencedRange`](scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `side` | [`Side`](scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | ## Used By - [`Names`](names.md) --- ## NameVariant Name variant used in a `NameRule`. ## Values - `common` - The most commonly used or recognized name for a feature in the specified language. In a `Names` value, most common names will appear in the `Names.common` field and will not need to be specified as `NameRule` values in `Names.rules`. This member of the enumeration should only be used to construct a `NameRule` if the common name needs to be scoped in some way and therefore cannot be accurately represented in `CommonNames`. - `official` - The legally or administratively recognized name, often used by government agencies or official documents. - `alternate` - An alternative name, which may be a historical name, a local colloquial name, or some other well-known name is not the common name. - `short` - An abbreviated or shortened version of the name, which may be an acronym or some other commonly-used short form. An example is "NYC" for New York City. ## Used By - [`NameRule`](name_rule.md) --- ## Names Multilingual names container. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name.*Minimum length: 1* | | `common` | [`CommonNames`](common_names.md) (map, optional) | | | `rules[]` | `list<`[`NameRule`](name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `rules[].variant` | [`NameVariant`](name_variant.md) | The name variant for this name rule. | | `rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `rules[].perspectives` | [`Perspectives`](perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `rules[].perspectives.mode` | [`PerspectiveMode`](perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `rules[].between` | [`LinearlyReferencedRange`](scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `rules[].side` | [`Side`](scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | ## Used By - [`Brand`](../places/types/brand.md) - [`Building`](../buildings/building.md) - [`BuildingPart`](../buildings/building_part.md) - [`Division`](../divisions/division.md) - [`DivisionArea`](../divisions/division_area.md) - [`Infrastructure`](../base/infrastructure.md) - [`Land`](../base/land.md) - [`LandUse`](../base/land_use.md) - [`Place`](../places/place.md) - [`Segment`](../transportation/segment.md) - [`Water`](../base/water.md) --- ## PerspectiveMode Perspective mode for disputed names. ## Values - `accepted_by` - `disputed_by` ## Used By - [`Perspectives`](perspectives.md) --- ## Perspectives Political perspectives container. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `mode` | [`PerspectiveMode`](perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | ## Used By - [`Division`](../divisions/division.md) - [`DivisionBoundary`](../divisions/division_boundary.md) - [`NameRule`](name_rule.md) --- ## Prominence Subjective scale of feature significance or importance, with 1 being the least, and 100 being the most, significant. This value can be used to help drive decisions about how and when to display a feature, and how to treat it relative to neighboring features. When populated by Overture, this value is derived from various factors including, but not limited to: feature and subtype, population, and capital status. Underlying type: `int32` ## Constraints - `≥ 1` - `≤ 100` - `≥ -2147483648` (from [`int32`](../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../system/primitive/primitives.md)) ## Used By - [`CartographicHints`](cartographic_hints.md) --- ## Heading Travel direction along an oriented path: forward or backward. ## Values - `forward` - `backward` ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`DestinationRule`](../../transportation/types/destination_rule.md) - [`DestinationRule.When`](../../transportation/types/destination_rule.when.md) - [`ProhibitedTransitionRule`](../../transportation/types/prohibited_transition_rule.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## LinearlyReferencedPosition Represents a linearly-referenced position between 0% and 100% of the distance along a path such as a road segment or a river center-line segment. Underlying type: `float64` ## Constraints - `≥ 0.0` - `≤ 1.0` ## Used By - [`ConnectorReference`](../../transportation/types/connector_reference.md) - [`LinearlyReferencedRange`](linearly_referenced_range.md) --- ## LinearlyReferencedRange Represents a non-empty range of positions along a path as a pair linearly-referenced positions. For example, the pair [0.25, 0.5] represents the range beginning 25% of the distance from the start of the path and ending 50% of the distance from the path Underlying type: `list` ## Constraints - Linear reference range constraint (0.0 to 1.0). (`LinearReferenceRangeConstraint`) - `≥ 0.0` (from [`LinearlyReferencedPosition`](linearly_referenced_position.md)) - `≤ 1.0` (from [`LinearlyReferencedPosition`](linearly_referenced_position.md)) ## Used By - [`AccessRestrictionRule`](../../transportation/types/access_restriction_rule.md) - [`LevelRule`](../../transportation/types/level_rule.md) - [`NameRule`](../name_rule.md) - [`ProhibitedTransitionRule`](../../transportation/types/prohibited_transition_rule.md) - [`RailFlagRule`](../../transportation/types/rail_flag_rule.md) - [`RoadFlagRule`](../../transportation/types/road_flag_rule.md) - [`RouteReference`](../../transportation/types/route_reference.md) - [`SourceItem`](../source_item.md) - [`SpeedLimitRule`](../../transportation/types/speed_limit_rule.md) - [`SubclassRule`](../../transportation/types/subclass_rule.md) - [`SurfaceRule`](../../transportation/types/surface_rule.md) - [`WidthRule`](../../transportation/types/width_rule.md) --- ## OpeningHours Time span or time spans during which something is open or active, specified in the OpenStreetMap opening hours specification: [https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification](https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification). Underlying type: `string` ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## PurposeOfUse Reason why a person or entity travelling on the transportation network is using a particular location. ## Values - `as_customer` - `at_destination` - `to_deliver` - `to_farm` - `for_forestry` ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## RecognizedStatus Status of the person or entity travelling as recognized by authorities controlling the particular location. ## Values - `as_permitted` - `as_private` - `as_disabled` - `as_employee` - `as_student` ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## Side The side, left or right, on which something appears relative to a facing or heading direction (*e.g.*, the side of a road relative to the road orientation), or relative to the direction of travel of a person or vehicle. ## Values - `left` - On the left relative to the facing direction - `right` - On the right side relative to the facing direction ## Used By - [`NameRule`](../name_rule.md) - [`Norms`](../../divisions/types/division/norms.md) --- ## TravelMode Enumerates possible travel modes. Some modes represent groups of modes. ## Values - `vehicle` - `motor_vehicle` - `car` - `truck` - `motorcycle` - `foot` - `bicycle` - `bus` - `hgv` - `hov` - `emergency` ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## VehicleAxleCountSelector Selects vehicles based on the number of axles they have. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `dimension` | `"axle_count"` | | | `comparison` | [`VehicleRelation`](vehicle_relation.md) | | | `value` | [`uint8`](../../system/primitive/primitives.md) | Number of axles on the vehicle | ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## VehicleHeightSelector Selects vehicles based on their height. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `dimension` | `"height"` | | | `comparison` | [`VehicleRelation`](vehicle_relation.md) | | | `value` | [`float64`](../../system/primitive/primitives.md) | Vehicle height selection threshold in the given `unit`*`≥ 0`* | | `unit` | [`LengthUnit`](../length_unit.md) | Height unit in which `value` is expressed | ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## VehicleLengthSelector Selects vehicles based on their length. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `dimension` | `"length"` | | | `comparison` | [`VehicleRelation`](vehicle_relation.md) | | | `value` | [`float64`](../../system/primitive/primitives.md) | Vehicle length selection threshold in the given `unit`*`≥ 0`* | | `unit` | [`LengthUnit`](../length_unit.md) | Length unit in which `value` is expressed | ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## VehicleRelation Relational operator, such as less than or equal to. ## Values - `greater_than` - `greater_than_equal` - `equal` - `less_than` - `less_than_equal` ## Used By - [`VehicleAxleCountSelector`](vehicle_axle_count_selector.md) - [`VehicleHeightSelector`](vehicle_height_selector.md) - [`VehicleLengthSelector`](vehicle_length_selector.md) - [`VehicleWeightSelector`](vehicle_weight_selector.md) - [`VehicleWidthSelector`](vehicle_width_selector.md) --- ## VehicleWeightSelector Selects vehicles based on their weight. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `dimension` | `"weight"` | | | `comparison` | [`VehicleRelation`](vehicle_relation.md) | | | `value` | [`float64`](../../system/primitive/primitives.md) | Vehicle weight selection threshold in the given `unit`*`≥ 0`* | | `unit` | [`WeightUnit`](../weight_unit.md) | Weight unit in which `value` is expressed | ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## VehicleWidthSelector Selects vehicles based on their width. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `dimension` | `"width"` | | | `comparison` | [`VehicleRelation`](vehicle_relation.md) | | | `value` | [`float64`](../../system/primitive/primitives.md) | Vehicle width selection threshold in the given `unit`*`≥ 0`* | | `unit` | [`LengthUnit`](../length_unit.md) | Width unit in which `value` is expressed | ## Used By - [`AccessRestrictionRule.When`](../../transportation/types/access_restriction_rule.when.md) - [`ProhibitedTransitionRule.When`](../../transportation/types/prohibited_transition_rule.when.md) - [`SpeedLimitRule.When`](../../transportation/types/speed_limit_rule.when.md) --- ## SortKey Integer indicating the recommended order in which to draw features. Features with a lower number should be drawn "in front" of features with a higher number. Underlying type: `int32` ## Constraints - `≥ -2147483648` (from [`int32`](../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../system/primitive/primitives.md)) ## Used By - [`CartographicHints`](cartographic_hints.md) --- ## SourceItem Specifies the source of the data used for a feature or one of its properties. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `dataset` | `string` | Name of the dataset where the source data can be found. | | `license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `update_time` | `datetime` (optional) | Last update time of the source data record. | | `confidence` | [`ConfidenceScore`](confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `between` | [`LinearlyReferencedRange`](scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | ## Used By - [`Address`](../addresses/address.md) - [`Bathymetry`](../base/bathymetry.md) - [`Building`](../buildings/building.md) - [`BuildingPart`](../buildings/building_part.md) - [`Connector`](../transportation/connector.md) - [`Division`](../divisions/division.md) - [`DivisionArea`](../divisions/division_area.md) - [`DivisionBoundary`](../divisions/division_boundary.md) - [`Infrastructure`](../base/infrastructure.md) - [`Land`](../base/land.md) - [`LandCover`](../base/land_cover.md) - [`LandUse`](../base/land_use.md) - [`Place`](../places/place.md) - [`Segment`](../transportation/segment.md) - [`Water`](../base/water.md) - [`Sources`](sources.md) --- ## Sources Information about the source data used to assemble the feature. Underlying type: `list<`[`SourceItem`](source_item.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Address`](../addresses/address.md) - [`Bathymetry`](../base/bathymetry.md) - [`Building`](../buildings/building.md) - [`BuildingPart`](../buildings/building_part.md) - [`Connector`](../transportation/connector.md) - [`Division`](../divisions/division.md) - [`DivisionArea`](../divisions/division_area.md) - [`DivisionBoundary`](../divisions/division_boundary.md) - [`Infrastructure`](../base/infrastructure.md) - [`Land`](../base/land.md) - [`LandCover`](../base/land_cover.md) - [`LandUse`](../base/land_use.md) - [`Place`](../places/place.md) - [`Segment`](../transportation/segment.md) - [`Water`](../base/water.md) --- ## SpeedUnit Unit of speed. ## Values - `mph` - Miles per hour - `km/h` - Kilometers per hour ## Used By - [`Speed`](../transportation/types/speed.md) --- ## WeightUnit Unit of weight. ## Values - `oz` - One ounce in the imperial and US customary systems - `lb` - One pound in the imperial and US customary systems - `st` - One short ton, or one ton in the US customary system (2,000 pounds) - `lt` - One long ton, or one ton in the imperial system (2,400 pounds) - `g` - One gram in the metric and SI systems - `kg` - One kilogram in the metric and SI systems - `t` - One tonne in the metric and SI systems ## Used By - [`VehicleWeightSelector`](scoping/vehicle_weight_selector.md) --- ## Division Divisions are recognized official or non-official organizations of people as seen from a given political perspective. Examples include countries, provinces, cities, towns, neighborhoods, etc. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `cartography` | [`CartographicHints`](../core/cartographic_hints.md) (optional) | | | `cartography.prominence` | [`Prominence`](../core/prominence.md) (optional) | Subjective scale of feature significance or importance, with 1 being the least, and 100 being the most, significant.This value can be used to help drive decisions about how and when to display a feature, and how to treat it relative to neighboring features.When populated by Overture, this value is derived from various factors including, but not limited to: feature and subtype, population, and capital status. | | `cartography.min_zoom` | [`MinZoom`](../core/min_zoom.md) (optional) | Recommended minimum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels below this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `cartography.max_zoom` | [`MaxZoom`](../core/max_zoom.md) (optional) | Recommended maximum tile zoom level in which this feature should be displayed.It is recommended that the feature be hidden at zoom levels above this value.Zoom levels follow the Slippy Maps convention, documented in the following references: - https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames - https://www.maptiler.com/google-maps-coordinates-tile-bounds-projection | | `cartography.sort_key` | [`SortKey`](../core/sort_key.md) (optional) | Integer indicating the recommended order in which to draw features.Features with a lower number should be drawn "in front" of features with a higher number. | | `names` | [`Names`](../core/names.md) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Approximate location of a position commonly associated with the real-world entity modeled by the division feature.*Allowed geometry types: Point* | | `theme` | `"divisions"` | | | `type` | `"division"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `subtype` | [`PlaceType`](types/place_type.md) | *`admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country`**`parent_division_id` is required when `subtype` ≠ `country`**`parent_division_id` is forbidden when `subtype` = `country`* | | `country` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) | ISO 3166-1 alpha-2 country code of the country or country-like entity, that this division represents or belongs to.If the entity this division represents has a country code, the country property contains it. If it does not, the country property contains the country code of the first division encountered by traversing the parent_division_id chain to the root.For example: - The country value for the United States is 'US' - The country value for New York City is 'US' - The country value for Puerto Rico, a dependency of the US, is 'PR'. - The country value for San Juan, Puerto Rico is 'PR'.If an entity has an internationally-recognized ISO 3166-1 alpha-2 country code, it should always be used. In cases where the schema requires the code but no internationally-recognized code is available, a synthetic code may be used provided it does not conflict with any internationally-recognized codes. | | `hierarchies[][]` | `list<`[`Hierarchy`](types/hierarchy.md)`>` | Hierarchies in which this division participates.Every division participates in at least one hierarchy. Most participate in only one. Some divisions may participate in more than one hierarchy, for example if they are claimed by different parent divisions from different political perspectives; or if there are other real-world reasons why the division or one of its ancestors has multiple parents.The first hierarchy in the list is the default hierarchy, and the second-to-last entry in the default hierarchy (if there is such an entry) always corresponds to the `parent_division_id' property. The ordering of hierarchies after the first one is arbitrary.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `hierarchies[][].division_id` | [`DivisionId`](types/division_id.md) | ID of the division | | `hierarchies[][].subtype` | [`PlaceType`](types/place_type.md) | | | `hierarchies[][].name` | [`StrippedString`](../system/stripped_string.md) | Primary name of the division | | `parent_division_id` | [`Id`](../system/ref/id.md) (optional) | Division ID of this division's parent division.Not allowed for top-level divisions (countries) and required for all other divisions.The default parent division is the parent division as seen from the default political perspective, if there is one, and is otherwise chosen somewhat arbitrarily. The hierarchies property can be used to inspect the exhaustive list of parent divisions.*Minimum length: 1**`parent_division_id` is required when `subtype` ≠ `country`**`parent_division_id` is forbidden when `subtype` = `country`* | | `admin_level` | [`AdminLevel`](types/admin_level.md) (optional) | Integer representing the division's position in its country's administrative hierarchy, where lower numbers correspond to higher level administrative units.*`admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country`* | | `class` | [`DivisionClass`](types/division_class.md) (optional) | | | `local_type` | [`CommonNames`](../core/common_names.md) (map, optional) | Local name for the subtype property, optionally localized.For example, the Canadian province of Quebec has the subtype 'region', but in the local administrative hierarchy it is referred to as a 'province'. Similarly, the Canadian Yukon territory also has subtype 'region', but is locally called a 'territory'.This property is localized using a standard Overture names structure. So for example, in Switzerland the top-level administrative subdivision corresponding to subtype 'region' is the canton, which is may be translated in each of Switzerland's official languages as, 'canton' in French, 'kanton' in German, 'cantone' in Italian, and 'chantun' in Romansh. | | `region` | [`RegionCode`](../system/region_code.md) (optional) | ISO 3166-2 principal subdivision code of the subdivision-like entity this division represents or belongs to.If the entity this division represents has a principal subdivision code, the region property contains it. If it does not, the region property contains the principal subdivision code of the first division encountered by traversing the parent_division_id chain to the root.For example: - The region value for the United States is omitted. - The region value for the U.S. state of New York is 'US-NY'. - The region value for New York City is 'US-NY', which it inherits from the state of New York. - The region value for Puerto Rico is 'US-PR'. | | `perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which this division is considered to be an accurate representation.If this property is absent, then this division is not known to be disputed from any political perspective. Consequently, there is only one division feature representing the entire real world entity.If this property is present, it means the division represents one of several alternative perspectives on the same real-world entity.There are two modes of perspective:1. `accepted_by` means the representation of the division is accepted by the listed entities and would be included on a map drawn from their perspective.2. `disputed_by` means the representation of the division is disputed by the listed entities and would be excluded from a map drawn from their perspective.When drawing a map from the perspective of a given country, one would start by gathering all the undisputed divisions (with no `perspectives` property), and then adding to that first all divisions explicitly accepted by the country, and second all divisions not explicitly disputed by the country. | | `perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `norms` | [`Norms`](types/division/norms.md) (optional) | Collects information about local norms and rules within the division that are generally useful for mapping and map-related use cases.If the norms property or a desired sub-property of the norms property is missing on a division, but at least one of its ancestor divisions has the norms property and the desired sub-property, then the value from the nearest ancestor division may be assumed. | | `norms.driving_side` | [`Side`](../core/scoping/side.md) (optional) | Side of the road on which vehicles drive in the division. | | `population` | [`int32`](../system/primitive/primitives.md) (optional) | Population of the division*`≥ 0`* | | `capital_division_ids` | `list<`[`Id`](../system/ref/id.md)`>` (optional) | Division IDs of this division's capital divisions. If present, this property will refer to the division IDs of the capital cities, county seats, etc. of a division.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `capital_of_divisions[]` | `list<`[`CapitalOfDivisionItem`](types/capital_of_division_item.md)`>` (optional) | Division IDs and subtypes of divisions this division is a capital of.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `capital_of_divisions[].division_id` | [`DivisionId`](types/division_id.md) | ID of the division | | `capital_of_divisions[].subtype` | [`PlaceType`](types/place_type.md) | | | `wikidata` | [`WikidataId`](../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | ## Constraints - `admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country` - `parent_division_id` is required when `subtype` ≠ `country` - `parent_division_id` is forbidden when `subtype` = `country` ## Examples | Column | Value | | -------: | ------- | | `cartography.prominence` | `29` | | `cartography.min_zoom` | `null` | | `cartography.max_zoom` | `null` | | `cartography.sort_key` | `null` | | `names.primary` | `Sia'atoutai` | | `names.common` | `null` | | `id` | `350e85f6-68ba-4114-9906-c2844815988b` | | `bbox.xmin` | `-175.25515747070312` | | `bbox.xmax` | `-175.255126953125` | | `bbox.ymin` | `-21.1353702545166` | | `bbox.ymax` | `-21.13536834716797` | | `geometry` | `POINT (-175.2551522 -21.1353686)` | | `theme` | `divisions` | | `type` | `division` | | `version` | `1` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `n3173231082@4` | | `sources[0].update_time` | `2014-12-18T09:17:03Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `subtype` | `locality` | | `country` | `TO` | | `hierarchies[0][0].division_id` | `fef8748b-0c91-46ad-9f2d-976d8d2de3e9` | | `hierarchies[0][0].subtype` | `country` | | `hierarchies[0][0].name` | `Tonga` | | `hierarchies[0][1].division_id` | `4d67561a-2292-41bd-8996-7853d276a42c` | | `hierarchies[0][1].subtype` | `region` | | `hierarchies[0][1].name` | `Tongatapu` | | `hierarchies[0][2].division_id` | `8730f0cc-d436-4f11-a7d3-49085813ef44` | | `hierarchies[0][2].subtype` | `county` | | `hierarchies[0][2].name` | `Vahe Kolomotu'a` | | `hierarchies[0][3].division_id` | `350e85f6-68ba-4114-9906-c2844815988b` | | `hierarchies[0][3].subtype` | `locality` | | `hierarchies[0][3].name` | `Sia'atoutai` | | `parent_division_id` | `8730f0cc-d436-4f11-a7d3-49085813ef44` | | `class` | `village` | | `local_type` | `{"en": "village"}` | | `region` | `TO-04` | | `perspectives` | `null` | | `norms` | `null` | | `population` | `534` | | `capital_division_ids` | `null` | | `capital_of_divisions` | `null` | | `wikidata` | `null` | | `names.rules[0].variant` | `alternate` | | `names.rules[0].language` | `null` | | `names.rules[0].perspectives` | `null` | | `names.rules[0].value` | `Nafualu` | | `names.rules[0].between` | `null` | | `names.rules[0].side` | `null` | --- ## DivisionArea Division areas are polygons that represent the land or maritime area covered by a division. Each division area belongs to a division which it references by ID, and for which the division area provides an area polygon. For ease of use, every division area repeats the subtype, names, country, and region properties of the division it belongs to. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `names` | [`Names`](../core/names.md) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | The area covered by the division with which this area feature is associated*Allowed geometry types: MultiPolygon, Polygon* | | `theme` | `"divisions"` | | | `type` | `"division_area"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `subtype` | [`PlaceType`](types/place_type.md) | *`admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country`* | | `class` | [`AreaClass`](types/division_area/area_class.md) | | | `is_land` | `boolean` (optional) | A boolean to indicate whether or not the feature geometry represents the land-clipped, non-maritime boundary. The geometry can be used for map rendering, cartographic display, and similar purposes.*`strict=True`**Exactly one of `is_land`, `is_territorial` must be `true`* | | `is_territorial` | `boolean` (optional) | A boolean to indicate whether or not the feature geometry represents Overture's best approximation of this place's maritime boundary. For coastal places, this would tend to include the water area. The geometry can be used for data processing, reverse-geocoding, and similar purposes.*`strict=True`**Exactly one of `is_land`, `is_territorial` must be `true`* | | `division_id` | [`Id`](../system/ref/id.md) | Division ID of the division this area belongs to.*References [`Division`](division.md) (belongs to)* | | `country` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) | ISO 3166-1 alpha-2 country code of the division this area belongs to. | | `region` | [`RegionCode`](../system/region_code.md) (optional) | ISO 3166-2 principal subdivision code of the division this area belongs to. | | `admin_level` | [`AdminLevel`](types/admin_level.md) (optional) | Integer representing the division's position in its country's administrative hierarchy, where lower numbers correspond to higher level administrative units.*`admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country`* | ## Constraints - Exactly one of `is_land`, `is_territorial` must be `true` - `admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country` ## Examples | Column | Value | | -------: | ------- | | `names.primary` | `ʻEua` | | `names.common` | `null` | | `names.rules` | `null` | | `id` | `eb9b112f-ec3c-47f7-b519-6f9f2e6fc2bd` | | `bbox.xmin` | `-174.97535705566406` | | `bbox.xmax` | `-174.90040588378906` | | `bbox.ymin` | `-21.473018646240234` | | `bbox.ymax` | `-21.283489227294922` | | `geometry` | `MULTIPOLYGON (((-174.9553949 -21.4730179, -174.9514163 -21.4719978, -174.9520108 -21.4681253, -17...` | | `theme` | `divisions` | | `type` | `division_area` | | `version` | `2` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `r7247527@3` | | `sources[0].update_time` | `2020-12-30T18:41:56Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `subtype` | `region` | | `class` | `land` | | `is_land` | `true` | | `is_territorial` | `false` | | `division_id` | `21597af0-b564-463c-a356-42c29e712b7d` | | `country` | `TO` | | `region` | `TO-01` | --- ## DivisionBoundary Boundaries represent borders between divisions of the same subtype. Some boundaries may be disputed by the divisions on one or both sides. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Boundary line or lines*Allowed geometry types: LineString, MultiLineString* | | `theme` | `"divisions"` | | | `type` | `"division_boundary"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `subtype` | [`PlaceType`](types/place_type.md) | *`admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country`**`country` is required when `subtype` ≠ `country`**`country` is forbidden when `subtype` = `country`* | | `class` | [`BoundaryClass`](types/division_boundary/boundary_class.md) | | | `is_land` | `boolean` (optional) | A boolean to indicate whether or not the feature geometry represents the land-clipped, non-maritime boundary. The geometry can be used for map rendering, cartographic display, and similar purposes.*`strict=True`**Exactly one of `is_land`, `is_territorial` must be `true`* | | `is_territorial` | `boolean` (optional) | A boolean to indicate whether or not the feature geometry represents Overture's best approximation of this place's maritime boundary. For coastal places, this would tend to include the water area. The geometry can be used for data processing, reverse-geocoding, and similar purposes.*`strict=True`**Exactly one of `is_land`, `is_territorial` must be `true`* | | `division_ids` | `list<`[`Id`](../system/ref/id.md)`>` | Identifies the two divisions to the left and right, respectively, of the boundary line. The left- and right-hand sides of the boundary are considered from the perspective of a person standing on the line facing in the direction in which the geometry is oriented, i.e. facing toward the end of the line.The first array element is the Overture ID of the left division. The second element is the Overture ID of the right division.*References [`Division`](division.md) (boundary of)**Minimum length: 2**Maximum length: 2**All items must be unique. (`UniqueItemsConstraint`)* | | `country` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) (optional) | ISO 3166-1 alpha-2 country code of the country or country-like entity that both sides of the boundary share.This property will be present on boundaries between two regions, counties, or similar entities within the same country, but will not be present on boundaries between two countries or country-like entities.*`country` is required when `subtype` ≠ `country`**`country` is forbidden when `subtype` = `country`* | | `region` | [`RegionCode`](../system/region_code.md) (optional) | ISO 3166-2 principal subdivision code of the subdivision-like entity that both sides of the boundary share.This property will be present on boundaries between two counties, localadmins or similar entities within the same principal subdivision, but will not be present on boundaries between different principal subdivisions or countries. | | `admin_level` | [`AdminLevel`](types/admin_level.md) (optional) | Integer representing the division's position in its country's administrative hierarchy, where lower numbers correspond to higher level administrative units.*`admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country`* | | `is_disputed` | `boolean` (optional) | Indicator if there are entities disputing this division boundary. Information about entities disputing this boundary should be included in perspectives property.This property should also be true if boundary between two entities is unclear and this is "best guess". So having it true and no perspectives gives map creators reason not to fully trust the boundary, but use it if they have no other.*`strict=True`* | | `perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which this division boundary is considered to be an accurate representation.If this property is absent, then this boundary is not known to be disputed from any political perspective. Consequently, there is only one boundary feature representing the entire real world entity.If this property is present, it means the boundary represents one of several alternative perspectives on the same real-world entity.There are two modes of perspective: 1. `accepted_by` means the representation of the boundary is accepted by the listed entities and would be included on a map drawn from their perspective. 2. `disputed_by` means the representation of the boundary is disputed by the listed entities and would be excluded from a map drawn from their perspective.When drawing a map from the perspective of a given country, one would start by gathering all the undisputed boundary (with no `perspectives` property), and then adding to that first all boundary explicitly accepted by the country, and second all boundary not explicitly disputed by the country. | | `perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | ## Constraints - Exactly one of `is_land`, `is_territorial` must be `true` - `admin_level` is required when `subtype` is one of: `county`, `macrocounty`, `region`, `macroregion`, `dependency`, `country` - `country` is required when `subtype` ≠ `country` - `country` is forbidden when `subtype` = `country` ## Examples | Column | Value | | -------: | ------- | | `id` | `2bdf68e4-860d-3d8c-a472-ccf439a5302a` | | `bbox.xmin` | `-147.06483459472656` | | `bbox.xmax` | `-147.04847717285156` | | `bbox.ymin` | `-15.4231538772583` | | `bbox.ymax` | `-15.151169776916504` | | `geometry` | `LINESTRING (-147.064823 -15.4231537, -147.0519131 -15.2885069, -147.048482 -15.1511701)` | | `theme` | `divisions` | | `type` | `division_boundary` | | `version` | `1` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `r6063055@9` | | `sources[0].update_time` | `2023-07-20T00:28:40Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `sources[1].property` | | | `sources[1].dataset` | `OpenStreetMap` | | `sources[1].record_id` | `r6063063@12` | | `sources[1].update_time` | `2023-07-20T00:28:40Z` | | `sources[1].confidence` | `null` | | `sources[1].between` | `null` | | `subtype` | `county` | | `class` | `maritime` | | `is_land` | `false` | | `is_territorial` | `true` | | `division_ids` | `["ae266459-63a4-4508-8295-0101e27d039b", "d4a6873d-885a-4f2a-bc0f-37e9d9e874e4"]` | | `country` | `PF` | | `region` | `null` | | `is_disputed` | `false` | | `perspectives` | `null` | --- ## AdminLevel Integer representing the division's position in its country's administrative hierarchy, where lower numbers correspond to higher level administrative units. Underlying type: `uint8` ## Constraints - `≥ 0` (from [`uint8`](../../system/primitive/primitives.md)) - `≤ 255` (from [`uint8`](../../system/primitive/primitives.md)) ## Used By - [`Division`](../division.md) - [`DivisionArea`](../division_area.md) - [`DivisionBoundary`](../division_boundary.md) --- ## CapitalOfDivisionItem One division that has capital. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `division_id` | [`DivisionId`](division_id.md) | ID of the division | | `subtype` | [`PlaceType`](place_type.md) | | ## Used By - [`Division`](../division.md) --- ## Norms Local norms and standards. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `driving_side` | [`Side`](../../../core/scoping/side.md) (optional) | Side of the road on which vehicles drive in the division. | ## Used By - [`Division`](../../division.md) --- ## AreaClass Area and boundary class designations. ## Values - `land` - `maritime` ## Used By - [`DivisionArea`](../../division_area.md) --- ## BoundaryClass ## Values - `land` - `maritime` ## Used By - [`DivisionBoundary`](../../division_boundary.md) --- ## DivisionClass Division-specific class designations. ## Values - `megacity` - `city` - `town` - `village` - `hamlet` ## Used By - [`Division`](../division.md) --- ## DivisionId ID of the division Underlying type: `string` ## Constraints - Minimum length: 1 - Minimum length: 1 (from [`Id`](../../system/ref/id.md)) - Allows only strings that contain no whitespace characters. (`NoWhitespaceConstraint`, pattern: `^\S+$`) (from [`NoWhitespaceString`](../../system/no_whitespace_string.md)) ## Used By - [`CapitalOfDivisionItem`](capital_of_division_item.md) - [`HierarchyItem`](hierarchy_item.md) --- ## Hierarchy A hierarchy of divisions, with the first entry being a country; each subsequent entry, if any, being a division that is a direct child of the previous entry; and the last entry representing the division that contains the hierarchy. For example, a hierarchy for the United States is simply [United States]. A hierarchy for the U.S. state of New Hampshire would be [United States, New Hampshire], and a hierarchy for the city of Concord, NH would be [United States, New Hampshire, Merrimack County, Concord]. Underlying type: `list<`[`HierarchyItem`](hierarchy_item.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Division`](../division.md) --- ## HierarchyItem One division in a hierarchy. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `division_id` | [`DivisionId`](division_id.md) | ID of the division | | `subtype` | [`PlaceType`](place_type.md) | | | `name` | [`StrippedString`](../../system/stripped_string.md) | Primary name of the division*Minimum length: 1* | ## Used By - [`Division`](../division.md) - [`Hierarchy`](hierarchy.md) --- ## PlaceType Category of the division from a finite, hierarchical, ordered list of categories (e.g., country, region, locality, etc.) similar to a Who's on First placetype. ## Values - `country` - `dependency` - `macroregion` - `region` - `macrocounty` - `county` - `localadmin` - `locality` - `borough` - `macrohood` - `neighborhood` - `microhood` ## Used By - [`CapitalOfDivisionItem`](capital_of_division_item.md) - [`Division`](../division.md) - [`DivisionArea`](../division_area.md) - [`DivisionBoundary`](../division_boundary.md) - [`HierarchyItem`](hierarchy_item.md) --- ## Place Places are point representations of real-world facilities, businesses, services, or amenities. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Position of the place. Places are point geometries.*Allowed geometry types: Point* | | `theme` | `"places"` | | | `type` | `"place"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `operating_status` | [`OperatingStatus`](types/operating_status.md) | An indication of whether a place is: in continued operation, in a temporary operating hiatus, or closed permanently.This is not an indication of opening hours or that the place is open/closed at the current time-of-day or day-of-week.When `operating_status` is `"permanently_closed"`, the `confidence` field will be set to 0. | | `categories` | [`Categories`](types/categories.md) (optional) | | | `categories.primary` | [`SnakeCaseString`](../system/snake_case_string.md) | The primary or main category of the place. | | `categories.alternate` | `list<`[`SnakeCaseString`](../system/snake_case_string.md)`>` (optional) | Alternate categories of the place.Some places might fit into two categories, e.g., a book store and a coffee shop. In these cases, the primary category can be augmented with additional categories. | | `basic_category` | [`SnakeCaseString`](../system/snake_case_string.md) (optional) | The basic level category of a place.This field classifies places into categories at a level that most people find intuitive. The full list of possible values it may hold can be found at (TODO).The basic level category, or simply basic category, is based on a cognitive science model use in taxonomy and ontology development. The idea is to provide the category name at the level of generality that is preferred by humans in learning and memory tasks. This category to be roughly in the middle of the general-to-specific category hierarchy.The full list of basic level categories is available at https://docs.overturemaps.org/guides/places/ | | `taxonomy` | [`Taxonomy`](types/taxonomy.md) (optional) | A structured representation of the place's category within the Overture taxonomy.Provides the primary classification, full hierarchy path, and alternate categories. | | `taxonomy.primary` | [`SnakeCaseString`](../system/snake_case_string.md) | The primary, or most specific, category known about this place.The `primary` category value must always equal the last or rightmost entry in the `hierarchy` field. | | `taxonomy.hierarchy` | `list<`[`SnakeCaseString`](../system/snake_case_string.md)`>` | The full primary hierarchy of categories known for this place, ordered from most general to most specific. An example hierarchy might be: `["food_and_drink", "restaurant", "casual_eatery", "gas_station_sushi"]`.The rightmost, or most specific, value in the `hierarchy` must always be equal to the `primary` field. The basic level category of the place will typically be found in the middle of the primary hierarchy. The primary hierarchy does not include any of the alternate categories found in the `alternates` field. | | `taxonomy.alternates` | `list<`[`SnakeCaseString`](../system/snake_case_string.md)`>` (optional) | Unordered list of additional categories that are known for this place but that are not part of the primary category hierarchy.Alternate categories allow a more complete picture of the place to be surfaced when it fits multiple unconnected branches in the taxonomy. For example a gas station that also sells groceries might have primary category of "gas_station" with an alternate of "grocery_store".Alternate categories are not part of the primary hierarchy or another alternate category's hierarchy. In other words, if a category is a parent in the hierarchy of another category, that category can't be a primary or alternate category itself.Note as well that this field is an unordered list of extra categories and does not represent a hierarchy. | | `confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | A score between 0 and 1 indicating how confident we are that the place exists.A confidence score of 0 indicates that we are certain the place doesn't exist anymore and will always be paired with an `operating_status` of `"permanently_closed"`.A confidence score of 1 indicates that we are certain the place does exist.If there is no value for confidence, it means we don't have enough information on which to estimate our confidence level. | | `websites` | `list<`[`HttpUrl`](../pydantic/networks/http_url.md)`>` (optional) | The sites of the place.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `socials` | `list<`[`HttpUrl`](../pydantic/networks/http_url.md)`>` (optional) | The social media URLs of the place.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `emails` | `list<`[`EmailStr`](../pydantic/networks/email_str.md)`>` (optional) | The email addresses of the place.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `phones` | `list<`[`PhoneNumber`](../system/phone_number.md)`>` (optional) | The phone numbers of the place.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `brand` | [`Brand`](types/brand.md) (optional) | The brand associated with the place. | | `brand.names` | [`Names`](../core/names.md) (optional) | | | `brand.names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `brand.names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `brand.names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `brand.names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `brand.names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `brand.names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `brand.names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `brand.names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `brand.names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `brand.names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `brand.names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `brand.wikidata` | [`WikidataId`](../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | | `addresses[]` | `list<`[`Address`](types/address.md)`>` (optional) | The address or addresses of the place*Minimum length: 1* | | `addresses[].freeform` | `string` (optional) | Free-form address that contains street name, house number and other address info | | `addresses[].locality` | `string` (optional) | City, town, or neighborhood component of the place address | | `addresses[].postcode` | `string` (optional) | Postal code component of the place address | | `addresses[].region` | [`RegionCode`](../system/region_code.md) (optional) | An ISO 3166-2 principal subdivision code | | `addresses[].country` | [`CountryCodeAlpha2`](../system/country_code_alpha2.md) (optional) | An ISO 3166-1 alpha-2 country code | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | ## Examples | Column | Value | | -------: | ------- | | `id` | `99003ee6-e75b-4dd6-8a8a-53a5a716c50d` | | `bbox.xmin` | `-150.46875` | | `bbox.xmax` | `-150.46875` | | `bbox.ymin` | `-79.17134094238281` | | `bbox.ymax` | `-79.17133331298828` | | `geometry` | `POINT (-150.46875 -79.1713346)` | | `theme` | `places` | | `type` | `place` | | `version` | `1` | | `sources[0].property` | | | `sources[0].dataset` | `meta` | | `sources[0].record_id` | `107663894904826` | | `sources[0].update_time` | `2025-06-30T07:00:00.000Z` | | `sources[0].confidence` | `0.7337175792507205` | | `sources[0].between` | `null` | | `operating_status` | `open` | | `categories.primary` | `hotel` | | `categories.alternate` | `null` | | `confidence` | `0.7337175792507205` | | `websites` | `["https://www.superhotel.co.jp/s_hotels/beppu/"]` | | `socials` | `["https://www.facebook.com/107663894904826"]` | | `emails` | `null` | | `phones` | `["+81977009000"]` | | `brand.wikidata` | `null` | | `brand.names.primary` | `SUPER HOTEL` | | `brand.names.common` | `null` | | `brand.names.rules` | `null` | | `addresses[0].freeform` | `秋田県横手市駅前町１３−８` | | `addresses[0].locality` | `横手市` | | `addresses[0].postcode` | `013-0036` | | `addresses[0].region` | `null` | | `addresses[0].country` | `JP` | | `names.primary` | `スーパーホテル別府駅前` | | `names.common` | `null` | | `names.rules` | `null` | --- ## Address(Types) An address associated with a place. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `freeform` | `string` (optional) | Free-form address that contains street name, house number and other address info | | `locality` | `string` (optional) | City, town, or neighborhood component of the place address | | `postcode` | `string` (optional) | Postal code component of the place address | | `region` | [`RegionCode`](../../system/region_code.md) (optional) | An ISO 3166-2 principal subdivision code | | `country` | [`CountryCodeAlpha2`](../../system/country_code_alpha2.md) (optional) | An ISO 3166-1 alpha-2 country code | ## Used By - [`Place`](../place.md) --- ## Brand A brand associated with a place. A location with multiple brands is modeled as multiple separate places, each with its own brand. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `names` | [`Names`](../../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `wikidata` | [`WikidataId`](../../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | ## Used By - [`Place`](../place.md) --- ## Categories Categories a place belongs to. Complete list is available on GitHub: [https://github.com/OvertureMaps/schema/blob/main/docs/schema/concepts/by-theme/places/overture_categories.csv](https://github.com/OvertureMaps/schema/blob/main/docs/schema/concepts/by-theme/places/overture_categories.csv) ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `primary` | [`SnakeCaseString`](../../system/snake_case_string.md) | The primary or main category of the place. | | `alternate` | `list<`[`SnakeCaseString`](../../system/snake_case_string.md)`>` (optional) | Alternate categories of the place.Some places might fit into two categories, e.g., a book store and a coffee shop. In these cases, the primary category can be augmented with additional categories.*All items must be unique. (`UniqueItemsConstraint`)* | ## Used By - [`Place`](../place.md) --- ## OperatingStatus General indication of whether a place is: in continued operation, in a temporary operating hiatus, or closed permanently. Operating status should not be confused with opening hours or operating hours. In particular, the status `"open"` does not mean the place is open *right now*, it means that in general the place is continuing to operate normally, as opposed to being in an operating hiatus (`"temporarily_closed"`) or shuttered (`"permanently_closed"`). ## Values - `open` - `permanently_closed` - `temporarily_closed` ## Used By - [`Place`](../place.md) --- ## Taxonomy A structured representation of the place's category within the Overture taxonomy. Provides the primary classification, full hierarchy path, and alternate categories. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `primary` | [`SnakeCaseString`](../../system/snake_case_string.md) | The primary, or most specific, category known about this place.The `primary` category value must always equal the last or rightmost entry in the `hierarchy` field. | | `hierarchy` | `list<`[`SnakeCaseString`](../../system/snake_case_string.md)`>` | The full primary hierarchy of categories known for this place, ordered from most general to most specific. An example hierarchy might be: `["food_and_drink", "restaurant", "casual_eatery", "gas_station_sushi"]`.The rightmost, or most specific, value in the `hierarchy` must always be equal to the `primary` field. The basic level category of the place will typically be found in the middle of the primary hierarchy. The primary hierarchy does not include any of the alternate categories found in the `alternates` field.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `alternates` | `list<`[`SnakeCaseString`](../../system/snake_case_string.md)`>` (optional) | Unordered list of additional categories that are known for this place but that are not part of the primary category hierarchy.Alternate categories allow a more complete picture of the place to be surfaced when it fits multiple unconnected branches in the taxonomy. For example a gas station that also sells groceries might have primary category of "gas_station" with an alternate of "grocery_store".Alternate categories are not part of the primary hierarchy or another alternate category's hierarchy. In other words, if a category is a parent in the hierarchy of another category, that category can't be a primary or alternate category itself.Note as well that this field is an unordered list of extra categories and does not represent a hierarchy.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | ## Used By - [`Place`](../place.md) --- ## EmailStr See: [Pydantic docs](https://docs.pydantic.dev/latest/api/networks/#pydantic.networks.EmailStr) ## Used By - [`Place`](../../places/place.md) --- ## HttpUrl A type that will accept any http or https URL. See: [Pydantic docs](https://docs.pydantic.dev/latest/api/networks/#pydantic.networks.HttpUrl) ## Used By - [`Place`](../../places/place.md) --- ## CountryCodeAlpha2 An ISO-3166-1 alpha-2 country code. Underlying type: `string` ## Constraints - Allows only ISO 3166-1 alpha-2 country codes. (`CountryCodeAlpha2Constraint`, pattern: `^[A-Z]{2}$`) ## Used By - [`Address`](../addresses/address.md) - [`Address`](../places/types/address.md) - [`Division`](../divisions/division.md) - [`DivisionArea`](../divisions/division_area.md) - [`DivisionBoundary`](../divisions/division_boundary.md) - [`Perspectives`](../core/perspectives.md) --- ## HexColor A color represented as an #RRGGBB or #RGB hexadecimal string. For example: - `"#ff0000"` or `#f00` for pure red 🟥 - `"#ffa500"` for bright orange 🟧 - `"#000000"` or `"#000"` for black ⬛ Underlying type: `string` ## Constraints - Allows only hexadecimal color codes (e.g., #FF0000 or #FFF). (`HexColorConstraint`, pattern: `^#[0-9A-Fa-f]{3}([0-9A-Fa-f]{3})?$`) ## Used By - [`Building`](../buildings/building.md) - [`BuildingPart`](../buildings/building_part.md) --- ## JsonPointer A JSON Pointer As described in `the JSON Pointer specification, RFC-6901`_. .. _the JSON Pointer specification, RFC-6901: [https://rfc-editor.org/rfc/rfc6901.html](https://rfc-editor.org/rfc/rfc6901.html) For example: - `""` (root value) - `"/connectors/"` - `"/connectors/0/at"` Underlying type: `string` ## Constraints - Allows only valid JSON Pointer values (RFC 6901). (`JsonPointerConstraint`) ## Used By - [`SourceItem`](../core/source_item.md) --- ## LanguageTag A BCP-47 language tag. As described in `Tags for Identifying Languages, BCP-47`_. .. _Tags for Identifying Languages, BCP-47: [https://www.rfc-editor.org/rfc/bcp/bcp47.txt](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) For example: - `"en"` - `"en-US"` - `"fr-CA"` - `"zh-Hant-TW"` Underlying type: `string` ## Constraints - Allows only `BCP-47`_ language tags. (`LanguageTagConstraint`, pattern: `^(?:(?:[A-Za-z]{2,3}(?:-[A-Za-z]{3}){0,3}?)|(?:[A-Za-z]{4,8}))(?:-[A-Za-z]{4})?(?:-[A-Za-z]{2}|[0-9]{3})?(?:-(?:[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(?:-[A-WY-Za-wy-z0-9](?:-[A-Za-z0-9]{2,8})+)*$`) ## Used By - [`Division`](../divisions/division.md) - [`NameRule`](../core/name_rule.md) - [`Names`](../core/names.md) - [`CommonNames`](../core/common_names.md) --- ## NoWhitespaceString A string that contains no whitespace characters. Underlying type: `string` ## Constraints - Allows only strings that contain no whitespace characters. (`NoWhitespaceConstraint`, pattern: `^\S+$`) ## Used By - [`DivisionId`](../divisions/types/division_id.md) - [`Id`](ref/id.md) --- ## PhoneNumber An international phone number. Underlying type: `string` ## Constraints - Allows only international phone numbers. (`PhoneNumberConstraint`, pattern: `^\+\d{1,3}[\s\-\(\)0-9]+$`) ## Used By - [`Place`](../places/place.md) --- ## Geometry Types Spatial types for representing geographic features. ## Types | Type | Description | | -----: | ------------- | | `Geometry` | GeoJSON geometry value (Point, LineString, Polygon, etc.) | | `BBox` | Bounding box as 4 or 6 coordinate values: [west, south, east, north] or [west, south, min-altitude, east, north, max-altitude] | | `GeometryType` | Enumeration of geometry types: `geometry_collection`, `line_string`, `multi_line_string`, `multi_point`, `multi_polygon`, `point`, `polygon` | --- ## Primitive Types Numeric types used for schema field definitions. ## Integer Types | Type | Range | Description | | -----: | :-----: | ------------- | | `int8` | -128 to 127 | Portable 8-bit signed integer. | | `int16` | -32,768 to 32,767 | Portable 16-bit signed integer. | | `int32` | -2,147,483,648 to 2,147,483,647 | Portable 32-bit signed integer. | | `int64` | -2^63 to 2^63-1 | Portable 64-bit signed integer. | ## Unsigned Integer Types | Type | Range | Description | | -----: | :-----: | ------------- | | `uint8` | 0 to 255 | Portable 8-bit unsigned integer. | | `uint16` | 0 to 65,535 | Portable 16-bit unsigned integer. | | `uint32` | 0 to 4,294,967,295 | Portable 32-bit unsigned integer. | ## Floating Point Types | Type | Precision | Description | | -----: | :---------: | ------------- | | `float32` | ~7 decimal digits | Portable IEEE 32-bit floating point number. | | `float64` | ~15 decimal digits | Portable IEEE 64-bit floating point number. | --- ## ID A unique identifier. Underlying type: `string` ## Constraints - Minimum length: 1 - Allows only strings that contain no whitespace characters. (`NoWhitespaceConstraint`, pattern: `^\S+$`) (from [`NoWhitespaceString`](../no_whitespace_string.md)) ## Used By - [`Address`](../../addresses/address.md) - [`Bathymetry`](../../base/bathymetry.md) - [`Building`](../../buildings/building.md) - [`BuildingPart`](../../buildings/building_part.md) - [`Connector`](../../transportation/connector.md) - [`ConnectorReference`](../../transportation/types/connector_reference.md) - [`DestinationRule`](../../transportation/types/destination_rule.md) - [`Division`](../../divisions/division.md) - [`DivisionArea`](../../divisions/division_area.md) - [`DivisionBoundary`](../../divisions/division_boundary.md) - [`Infrastructure`](../../base/infrastructure.md) - [`Land`](../../base/land.md) - [`LandCover`](../../base/land_cover.md) - [`LandUse`](../../base/land_use.md) - [`Place`](../../places/place.md) - [`Segment`](../../transportation/segment.md) - [`SequenceEntry`](../../transportation/types/sequence_entry.md) - [`Water`](../../base/water.md) - [`DivisionId`](../../divisions/types/division_id.md) --- ## RegionCode An ISO 3166-2 principal subdivision code. Underlying type: `string` ## Constraints - Allows only ISO 3166-2 principal subdivision codes. (`RegionCodeConstraint`, pattern: `^[A-Z]{2}-[A-Z0-9]{1,3}$`) ## Used By - [`Address`](../places/types/address.md) - [`Division`](../divisions/division.md) - [`DivisionArea`](../divisions/division_area.md) - [`DivisionBoundary`](../divisions/division_boundary.md) --- ## SnakeCaseString A string that looks like a snake_case identifier, like a Python variable name (*e.g.*, `foo_bar`). Underlying type: `string` ## Constraints - Allows only strings that look like snake_case identifiers, *e.g.* `"foo_bar"`. (`SnakeCaseConstraint`, pattern: `^[a-z0-9]+(_[a-z0-9]+)*$`) ## Used By - [`Categories`](../places/types/categories.md) - [`Place`](../places/place.md) - [`Taxonomy`](../places/types/taxonomy.md) --- ## StrippedString A string without leading or trailing whitespace. Underlying type: `string` ## Constraints - Allows only strings that have no leading/trailing whitespace. (`StrippedConstraint`) ## Used By - [`Address`](../addresses/address.md) - [`AddressLevel`](../addresses/types/address_level.md) - [`DestinationLabels`](../transportation/types/destination_labels.md) - [`Division`](../divisions/division.md) - [`HierarchyItem`](../divisions/types/hierarchy_item.md) - [`NameRule`](../core/name_rule.md) - [`Names`](../core/names.md) - [`RouteReference`](../transportation/types/route_reference.md) - [`SourceItem`](../core/source_item.md) - [`CommonNames`](../core/common_names.md) --- ## WikidataId A wikidata ID, as found on [https://www.wikidata.org/](https://www.wikidata.org/). - `"Q42"` - `"Q11643"` - `"Q116257497"` Underlying type: `string` ## Constraints - Allows only Wikidata identifiers (Q followed by digits). (`WikidataIdConstraint`, pattern: `^Q\d+$`) ## Used By - [`Brand`](../places/types/brand.md) - [`Division`](../divisions/division.md) - [`Infrastructure`](../base/infrastructure.md) - [`Land`](../base/land.md) - [`LandUse`](../base/land_use.md) - [`RouteReference`](../transportation/types/route_reference.md) - [`Water`](../base/water.md) --- ## Connector Connectors create physical connections between segments. Connectors are compatible with GeoJSON Point features. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Position of the connector*Allowed geometry types: Point* | | `theme` | `"transportation"` | | | `type` | `"connector"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | ## Examples | Column | Value | | -------: | ------- | | `id` | `39542bee-230f-4b91-b7e5-a9b58e0c59b1` | | `bbox.xmin` | `-176.54730224609375` | | `bbox.xmax` | `-176.54727172851562` | | `bbox.ymin` | `-43.96794891357422` | | `bbox.ymax` | `-43.96794128417969` | | `geometry` | `POINT (-176.5472979 -43.9679472)` | | `theme` | `transportation` | | `type` | `connector` | | `version` | `1` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `null` | | `sources[0].update_time` | `null` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | --- ## Segment ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `id` | [`Id`](../system/ref/id.md) | A feature ID. This may be an ID associated with the Global Entity Reference System (GERS) if—and-only-if the feature represents an entity that is part of GERS. | | `bbox` | [`bbox`](../system/primitive/geometry.md) (optional) | An optional bounding box for the feature | | `geometry` | [`geometry`](../system/primitive/geometry.md) | Segment centerline*Allowed geometry types: LineString* | | `theme` | `"transportation"` | | | `type` | `"segment"` | | | `version` | [`FeatureVersion`](../core/feature_version.md) | | | `sources[]` | [`Sources`](../core/sources.md) (list, optional) | Information about the source data used to assemble the feature. | | `sources[].property` | [`JsonPointer`](../system/json_pointer.md) | A JSON Pointer identifying the property (field) that this source information applies to.The root document value `""` indicates that this source information applies to the entire feature, excepting properties (fields) for which a dedicated source information record exists.Any other JSON Pointer apart from `""` indicates that this source record provides dedicated source information for the property at the path in the JSON Pointer. As an example, the value `"/names/common/en"` indicates that the source information applies to the English common name of a named feature, while the value `"/geometry"` indicates that it applies to the feature geometry. | | `sources[].dataset` | `string` | Name of the dataset where the source data can be found. | | `sources[].license` | [`StrippedString`](../system/stripped_string.md) (optional) | Source data license name.This should be a valid SPDX license identifier when available.If omitted, contact the data provider for more license information. | | `sources[].record_id` | `string` (optional) | Identifies the specific record within the source dataset where the source data can be found.The format of record identifiers is dataset-specific. | | `sources[].update_time` | `datetime` (optional) | Last update time of the source data record. | | `sources[].confidence` | [`ConfidenceScore`](../core/confidence_score.md) (optional) | Confidence value from the source dataset.This is a value between 0.0 and 1.0 and is particularly relevant for ML-derived data. | | `sources[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SourceItem applies to. | | `subtype` | [`Subtype`](types/subtype.md) | Broad category of transportation segment. | | `access_restrictions[]` | [`AccessRules`](types/access_rules.md) (list, optional) | Rules governing access to this road segment | | `access_restrictions[].access_type` | [`AccessType`](types/access_type.md) | | | `access_restrictions[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing AccessRestrictionRule applies to. | | `access_restrictions[].when` | [`AccessRestrictionRule.When`](types/access_restriction_rule.when.md) (optional) | Scopes for AccessRestrictionRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE | | `access_restrictions[].when.heading` | [`Heading`](../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing AccessRestrictionRule applies to. | | `access_restrictions[].when.during` | [`OpeningHours`](../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing AccessRestrictionRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification. | | `access_restrictions[].when.mode` | `list<`[`TravelMode`](../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing AccessRestrictionRule applies to. | | `access_restrictions[].when.using` | `list<`[`PurposeOfUse`](../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing AccessRestrictionRule applies to. | | `access_restrictions[].when.recognized` | `list<`[`RecognizedStatus`](../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing AccessRestrictionRule applies to. | | `access_restrictions[].when.vehicle` | [`VehicleAxleCountSelector`](../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing AccessRestrictionRule applies to. | | `connectors[]` | `list<`[`ConnectorReference`](types/connector_reference.md)`>` (optional) | List of connectors which this segment is physically connected to and their relative location. Each connector is a possible routing decision point, meaning it defines a place along the segment in which there is possibility to transition to other segments which share the same connector.*Minimum length: 2**All items must be unique. (`UniqueItemsConstraint`)* | | `connectors[].connector_id` | [`Id`](../system/ref/id.md) | A unique identifier | | `connectors[].at` | [`LinearlyReferencedPosition`](../core/scoping/linearly_referenced_position.md) (optional) | The linearly-referenced position on the geometry, specified as a percentage displacement from the start of the geometry, that the containing ConnectorReference applies to. | | `level_rules[]` | [`LevelRules`](types/level_rules.md) (list, optional) | Defines the Z-order, i.e. stacking order, of the road segment. | | `level_rules[].value` | [`Level`](../core/level.md) | Z-order of the feature where 0 is visual level | | `level_rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing LevelRule applies to. | | `routes[]` | [`Routes`](types/routes.md) (list, optional) | Routes this segment belongs to | | `routes[].name` | [`StrippedString`](../system/stripped_string.md) (optional) | Full name of the route | | `routes[].network` | [`StrippedString`](../system/stripped_string.md) (optional) | Name of the highway system this route belongs to | | `routes[].ref` | [`StrippedString`](../system/stripped_string.md) (optional) | Code or number used to reference the route | | `routes[].symbol` | [`StrippedString`](../system/stripped_string.md) (optional) | URL or description of route signage | | `routes[].wikidata` | [`WikidataId`](../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | | `routes[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing RouteReference applies to. | | `subclass_rules[]` | [`SubclassRules`](types/subclass_rules.md) (list, optional) | Set of subclasses scoped along segment | | `subclass_rules[].value` | [`Subclass`](types/subclass.md) | | | `subclass_rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SubclassRule applies to. | | `names` | [`Names`](../core/names.md) (optional) | | | `names.primary` | [`StrippedString`](../system/stripped_string.md) | The most commonly used name. | | `names.common` | [`CommonNames`](../core/common_names.md) (map, optional) | | | `names.rules[]` | `list<`[`NameRule`](../core/name_rule.md)`>` (optional) | Rules for names that cannot be specified in the simple common names property. These rules can cover other name variants such as official, alternate, and short; and they can optionally include geometric scoping (linear referencing) and side-of-road scoping for complex cases. | | `names.rules[].value` | [`StrippedString`](../system/stripped_string.md) | The actual name value. | | `names.rules[].variant` | [`NameVariant`](../core/name_variant.md) | The name variant for this name rule. | | `names.rules[].language` | [`LanguageTag`](../system/language_tag.md) (optional) | The language in which the name `value` is specified, if known, as an IETF BCP 47 language tag. | | `names.rules[].perspectives` | [`Perspectives`](../core/perspectives.md) (optional) | Political perspectives from which a named feature is viewed. | | `names.rules[].perspectives.mode` | [`PerspectiveMode`](../core/perspective_mode.md) | Whether the perspective holder accepts or disputes this name. | | `names.rules[].perspectives.countries` | `list<`[`CountryCodeAlpha2`](../system/country_code_alpha2.md)`>` | Countries holding the given mode of perspective. | | `names.rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing NameRule applies to. | | `names.rules[].side` | [`Side`](../core/scoping/side.md) (optional) | The side, either left or right, that the containing NameRule applies to. | | `class` *(Road)* | [`RoadClass`](types/road_class.md) | | | `destinations[]` *(Road)* | [`Destinations`](types/destinations.md) (list, optional) | Describes objects that can be reached by following a transportation segment in the same way those objects are described on signposts or ground writing that a traveller following the segment would observe in the real world. This allows navigation systems to refer to signs and observable writing that a traveller actually sees. | | `destinations[].from_connector_id` | [`Id`](../system/ref/id.md) | Identifies the point of physical connection on this segment before which the destination sign or marking is visible. | | `destinations[].to_connector_id` | [`Id`](../system/ref/id.md) | Identifies the point of physical connection on the segment identified by 'to_segment_id' to transition to for reaching the destination(s). | | `destinations[].to_segment_id` | [`Id`](../system/ref/id.md) | Identifies the segment to transition to reach the destination(s) labeled on the sign or marking. | | `destinations[].final_heading` | [`Heading`](../core/scoping/heading.md) | Direction of travel on the segment identified by 'to_segment_id' that leads to the destination. | | `destinations[].labels[]` | `list<`[`DestinationLabels`](types/destination_labels.md)`>` (optional) | Labeled destinations that can be reached by following the segment. | | `destinations[].labels[].value` | [`StrippedString`](../system/stripped_string.md) | Names the object that is reached | | `destinations[].labels[].type` | [`DestinationLabelType`](types/destination_label_type.md) | | | `destinations[].symbols` | `list<`[`DestinationSignSymbol`](types/destination_sign_symbol.md)`>` (optional) | A collection of symbols or icons present on the sign next to current destination label. | | `destinations[].when` | [`DestinationRule.When`](types/destination_rule.when.md) (optional) | Scope for DestinationRule: | | `destinations[].when.heading` | [`Heading`](../core/scoping/heading.md) | The heading, either forward or backward, that the containing DestinationRule applies to. | | `prohibited_transitions[]` *(Road)* | [`ProhibitedTransitions`](types/prohibited_transitions.md) (list, optional) | Rules preventing transitions from this segment to another segment. | | `prohibited_transitions[].sequence[]` | `list<`[`SequenceEntry`](types/sequence_entry.md)`>` | Ordered sequence of connector/segment pairs that it is prohibited to follow from this segment. | | `prohibited_transitions[].sequence[].connector_id` | [`Id`](../system/ref/id.md) | Identifies the point of physical connection between the previous segment in the sequence and the segment in this sequence entry. | | `prohibited_transitions[].sequence[].segment_id` | [`Id`](../system/ref/id.md) | Identifies the segment that the previous segment in the sequence is physically connected to via the sequence entry's connector. | | `prohibited_transitions[].final_heading` | [`Heading`](../core/scoping/heading.md) | Direction of travel that is prohibited on the destination segment of the sequence. | | `prohibited_transitions[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing ProhibitedTransitionRule applies to. | | `prohibited_transitions[].when` | [`ProhibitedTransitionRule.When`](types/prohibited_transition_rule.when.md) (optional) | Scopes for ProhibitedTransitionRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE | | `prohibited_transitions[].when.heading` | [`Heading`](../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing ProhibitedTransitionRule applies to. | | `prohibited_transitions[].when.during` | [`OpeningHours`](../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing ProhibitedTransitionRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification. | | `prohibited_transitions[].when.mode` | `list<`[`TravelMode`](../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing ProhibitedTransitionRule applies to. | | `prohibited_transitions[].when.using` | `list<`[`PurposeOfUse`](../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing ProhibitedTransitionRule applies to. | | `prohibited_transitions[].when.recognized` | `list<`[`RecognizedStatus`](../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing ProhibitedTransitionRule applies to. | | `prohibited_transitions[].when.vehicle` | [`VehicleAxleCountSelector`](../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing ProhibitedTransitionRule applies to. | | `road_flags[]` *(Road)* | [`RoadFlags`](types/road_flags.md) (list, optional) | Set of boolean attributes applicable to roads. May be specified either as a single flag array of flag values, or as an array of flag rules. | | `road_flags[].values` | `list<`[`RoadFlag`](types/road_flag.md)`>` | | | `road_flags[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing RoadFlagRule applies to. | | `road_surface[]` *(Road)* | [`Surfaces`](types/surfaces.md) (list, optional) | Physical surface of the road. May either be specified as a single global value for the segment, or as an array of surface rules. | | `road_surface[].value` | [`RoadSurface`](types/road_surface.md) | | | `road_surface[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SurfaceRule applies to. | | `speed_limits[]` *(Road)* | [`SpeedLimits`](types/speed_limits.md) (list, optional) | Rules governing speed on this road segment | | `speed_limits[].max_speed` | [`Speed`](types/speed.md) (optional) | | | `speed_limits[].max_speed.value` | [`SpeedValue`](types/speed_value.md) | Speed value | | `speed_limits[].max_speed.unit` | [`SpeedUnit`](../core/speed_unit.md) | | | `speed_limits[].min_speed` | [`Speed`](types/speed.md) (optional) | | | `speed_limits[].min_speed.value` | [`SpeedValue`](types/speed_value.md) | Speed value | | `speed_limits[].min_speed.unit` | [`SpeedUnit`](../core/speed_unit.md) | | | `speed_limits[].is_max_speed_variable` | `boolean` (optional) | Indicates a variable speed corridor | | `speed_limits[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SpeedLimitRule applies to. | | `speed_limits[].when` | [`SpeedLimitRule.When`](types/speed_limit_rule.when.md) (optional) | Scopes for SpeedLimitRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE | | `speed_limits[].when.heading` | [`Heading`](../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing SpeedLimitRule applies to. | | `speed_limits[].when.during` | [`OpeningHours`](../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing SpeedLimitRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification. | | `speed_limits[].when.mode` | `list<`[`TravelMode`](../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing SpeedLimitRule applies to. | | `speed_limits[].when.using` | `list<`[`PurposeOfUse`](../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing SpeedLimitRule applies to. | | `speed_limits[].when.recognized` | `list<`[`RecognizedStatus`](../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing SpeedLimitRule applies to. | | `speed_limits[].when.vehicle` | [`VehicleAxleCountSelector`](../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing SpeedLimitRule applies to. | | `subclass` *(Road)* | [`Subclass`](types/subclass.md) (optional) | | | `width_rules[]` *(Road)* | [`WidthRules`](types/width_rules.md) (list, optional) | Edge-to-edge width of the road modeled by this segment, in meters.Examples: (1) If this segment models a carriageway without sidewalk, this value represents the edge-to-edge width of the carriageway, inclusive of any shoulder. (2) If this segment models a sidewalk by itself, this value represents the edge-to-edge width of the sidewalk. (3) If this segment models a combined sidewalk and carriageway, this value represents the edge-to-edge width inclusive of sidewalk. | | `width_rules[].value` | [`Width`](types/width.md) | | | `width_rules[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing WidthRule applies to. | | `class` *(Rail)* | [`RailClass`](types/rail_class.md) | | | `rail_flags[]` *(Rail)* | [`RailFlags`](types/rail_flags.md) (list, optional) | Set of boolean attributes applicable to railways. May be specified either as a single flag array of flag values, or as an array of flag rules. | | `rail_flags[].values` | `list<`[`RailFlag`](types/rail_flag.md)`>` | | | `rail_flags[].between` | [`LinearlyReferencedRange`](../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing RailFlagRule applies to. | ## Examples | Column | Value | | -------: | ------- | | `id` | `1bc62f3b-08b5-42b8-89fe-36f685f60455` | | `bbox.xmin` | `-176.5650177001953` | | `bbox.xmax` | `-176.56361389160156` | | `bbox.ymin` | `-43.954410552978516` | | `bbox.ymax` | `-43.953250885009766` | | `geometry` | `LINESTRING (-176.5636191 -43.954404, -176.5643637 -43.9538145, -176.5647264 -43.9535274, -176.564...` | | `theme` | `transportation` | | `type` | `segment` | | `version` | `1` | | `sources[0].property` | | | `sources[0].dataset` | `OpenStreetMap` | | `sources[0].record_id` | `w53435546@6` | | `sources[0].update_time` | `2021-05-03T06:37:03Z` | | `sources[0].confidence` | `null` | | `sources[0].between` | `null` | | `subtype` | `road` | | `access_restrictions` | `null` | | `connectors[0].connector_id` | `15b2c131-9137-4add-88c6-2acd3fa61355` | | `connectors[0].at` | `0.0` | | `connectors[1].connector_id` | `23ae2702-ef77-4d2e-b39d-77360b696d20` | | `connectors[1].at` | `0.523536154` | | `connectors[2].connector_id` | `8e944ce1-4b81-49eb-a823-7d98779c855c` | | `connectors[2].at` | `1.0` | | `level_rules` | `null` | | `routes` | `null` | | `subclass_rules` | `null` | | `names.primary` | `Meteorological Lane` | | `names.common` | `null` | | `destinations` | `null` | | `prohibited_transitions` | `null` | | `road_flags` | `null` | | `road_surface[0].value` | `gravel` | | `road_surface[0].between` | `null` | | `speed_limits` | `null` | | `subclass` | `null` | | `width_rules` | `null` | | `class` | `residential` | | `rail_flags` | `null` | | `names.rules[0].variant` | `common` | | `names.rules[0].language` | `null` | | `names.rules[0].perspectives` | `null` | | `names.rules[0].value` | `Meteorological Lane` | | `names.rules[0].between` | `null` | | `names.rules[0].side` | `null` | --- ## AccessRestrictionRule ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `access_type` | [`AccessType`](access_type.md) | | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing AccessRestrictionRule applies to. | | `when` | [`AccessRestrictionRule.When`](access_restriction_rule.when.md) (optional) | Scopes for AccessRestrictionRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE | | `when.heading` | [`Heading`](../../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing AccessRestrictionRule applies to. | | `when.during` | [`OpeningHours`](../../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing AccessRestrictionRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification. | | `when.mode` | `list<`[`TravelMode`](../../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing AccessRestrictionRule applies to. | | `when.using` | `list<`[`PurposeOfUse`](../../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing AccessRestrictionRule applies to. | | `when.recognized` | `list<`[`RecognizedStatus`](../../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing AccessRestrictionRule applies to. | | `when.vehicle` | [`VehicleAxleCountSelector`](../../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing AccessRestrictionRule applies to. | ## Used By - [`Segment`](../segment.md) - [`AccessRules`](access_rules.md) --- ## AccessRestrictionRule.When Scopes for AccessRestrictionRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `heading` | [`Heading`](../../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing AccessRestrictionRule applies to.*At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `during` | [`OpeningHours`](../../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing AccessRestrictionRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification.*At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `mode` | `list<`[`TravelMode`](../../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing AccessRestrictionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `using` | `list<`[`PurposeOfUse`](../../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing AccessRestrictionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `recognized` | `list<`[`RecognizedStatus`](../../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing AccessRestrictionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `vehicle` | [`VehicleAxleCountSelector`](../../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing AccessRestrictionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | ## Constraints - At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set ## Used By - [`AccessRestrictionRule`](access_restriction_rule.md) --- ## AccessRules Rules governing access to this road segment Underlying type: `list<`[`AccessRestrictionRule`](access_restriction_rule.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Segment`](../segment.md) --- ## AccessType ## Values - `allowed` - `denied` - `designated` ## Used By - [`AccessRestrictionRule`](access_restriction_rule.md) --- ## ConnectorReference Contains the GERS ID and relative position between 0 and 1 of a connector feature along the segment. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `connector_id` | [`Id`](../../system/ref/id.md) | A unique identifier*References [`Connector`](../connector.md) (connects to)* | | `at` | [`LinearlyReferencedPosition`](../../core/scoping/linearly_referenced_position.md) (optional) | The linearly-referenced position on the geometry, specified as a percentage displacement from the start of the geometry, that the containing ConnectorReference applies to. | ## Used By - [`Segment`](../segment.md) --- ## DestinationLabelType Indicates what special symbol/icon is present on a signpost, visible as road marking or similar. ## Values - `street` - `country` - `route_ref` - `toward_route_ref` - `unknown` ## Used By - [`DestinationLabels`](destination_labels.md) --- ## DestinationLabels The type of object of the destination label. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`StrippedString`](../../system/stripped_string.md) | Names the object that is reached*Minimum length: 1* | | `type` | [`DestinationLabelType`](destination_label_type.md) | | ## Used By - [`DestinationRule`](destination_rule.md) --- ## DestinationRule ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `from_connector_id` | [`Id`](../../system/ref/id.md) | Identifies the point of physical connection on this segment before which the destination sign or marking is visible. | | `to_connector_id` | [`Id`](../../system/ref/id.md) | Identifies the point of physical connection on the segment identified by 'to_segment_id' to transition to for reaching the destination(s). | | `to_segment_id` | [`Id`](../../system/ref/id.md) | Identifies the segment to transition to reach the destination(s) labeled on the sign or marking. | | `final_heading` | [`Heading`](../../core/scoping/heading.md) | Direction of travel on the segment identified by 'to_segment_id' that leads to the destination. | | `labels[]` | `list<`[`DestinationLabels`](destination_labels.md)`>` (optional) | Labeled destinations that can be reached by following the segment.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `labels`, `symbols` must be set* | | `labels[].value` | [`StrippedString`](../../system/stripped_string.md) | Names the object that is reached | | `labels[].type` | [`DestinationLabelType`](destination_label_type.md) | | | `symbols` | `list<`[`DestinationSignSymbol`](destination_sign_symbol.md)`>` (optional) | A collection of symbols or icons present on the sign next to current destination label.*All items must be unique. (`UniqueItemsConstraint`)**At least one of `labels`, `symbols` must be set* | | `when` | [`DestinationRule.When`](destination_rule.when.md) (optional) | Scope for DestinationRule: | | `when.heading` | [`Heading`](../../core/scoping/heading.md) | The heading, either forward or backward, that the containing DestinationRule applies to. | ## Constraints - At least one of `labels`, `symbols` must be set ## Used By - [`Segment`](../segment.md) - [`Destinations`](destinations.md) --- ## DestinationRule.When Scope for DestinationRule: ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `heading` | [`Heading`](../../core/scoping/heading.md) | The heading, either forward or backward, that the containing DestinationRule applies to. | ## Used By - [`DestinationRule`](destination_rule.md) --- ## DestinationSignSymbol Indicates what special symbol/icon is present on a signpost, visible as road marking or similar. ## Values - `motorway` - `airport` - `hospital` - `center` - `industrial` - `parking` - `bus` - `train_station` - `rest_area` - `ferry` - `motorroad` - `fuel` - `viewpoint` - `fuel_diesel` - `food` - `lodging` - `info` - `camp_site` - `interchange` - `restrooms` ## Used By - [`DestinationRule`](destination_rule.md) --- ## Destinations Describes objects that can be reached by following a transportation segment in the same way those objects are described on signposts or ground writing that a traveller following the segment would observe in the real world. This allows navigation systems to refer to signs and observable writing that a traveller actually sees. Underlying type: `list<`[`DestinationRule`](destination_rule.md)`>` ## Used By - [`Segment`](../segment.md) --- ## LevelRule A single level rule defining the Z-order, i.e. stacking order, applicable within a given scope on the road segment. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`Level`](../../core/level.md) | Z-order of the feature where 0 is visual level | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing LevelRule applies to. | ## Used By - [`Segment`](../segment.md) - [`LevelRules`](level_rules.md) --- ## LevelRules Defines the Z-order, i.e. stacking order, of the road segment. Underlying type: `list<`[`LevelRule`](level_rule.md)`>` ## Used By - [`Segment`](../segment.md) --- ## ProhibitedTransitionRule ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `sequence[]` | `list<`[`SequenceEntry`](sequence_entry.md)`>` | Ordered sequence of connector/segment pairs that it is prohibited to follow from this segment.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `sequence[].connector_id` | [`Id`](../../system/ref/id.md) | Identifies the point of physical connection between the previous segment in the sequence and the segment in this sequence entry. | | `sequence[].segment_id` | [`Id`](../../system/ref/id.md) | Identifies the segment that the previous segment in the sequence is physically connected to via the sequence entry's connector. | | `final_heading` | [`Heading`](../../core/scoping/heading.md) | Direction of travel that is prohibited on the destination segment of the sequence. | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing ProhibitedTransitionRule applies to. | | `when` | [`ProhibitedTransitionRule.When`](prohibited_transition_rule.when.md) (optional) | Scopes for ProhibitedTransitionRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE | | `when.heading` | [`Heading`](../../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing ProhibitedTransitionRule applies to. | | `when.during` | [`OpeningHours`](../../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing ProhibitedTransitionRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification. | | `when.mode` | `list<`[`TravelMode`](../../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing ProhibitedTransitionRule applies to. | | `when.using` | `list<`[`PurposeOfUse`](../../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing ProhibitedTransitionRule applies to. | | `when.recognized` | `list<`[`RecognizedStatus`](../../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing ProhibitedTransitionRule applies to. | | `when.vehicle` | [`VehicleAxleCountSelector`](../../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing ProhibitedTransitionRule applies to. | ## Used By - [`Segment`](../segment.md) - [`ProhibitedTransitions`](prohibited_transitions.md) --- ## ProhibitedTransitionRule.When Scopes for ProhibitedTransitionRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `heading` | [`Heading`](../../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing ProhibitedTransitionRule applies to.*At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `during` | [`OpeningHours`](../../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing ProhibitedTransitionRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification.*At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `mode` | `list<`[`TravelMode`](../../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing ProhibitedTransitionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `using` | `list<`[`PurposeOfUse`](../../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing ProhibitedTransitionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `recognized` | `list<`[`RecognizedStatus`](../../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing ProhibitedTransitionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `vehicle` | [`VehicleAxleCountSelector`](../../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing ProhibitedTransitionRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | ## Constraints - At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set ## Used By - [`ProhibitedTransitionRule`](prohibited_transition_rule.md) --- ## ProhibitedTransitions Rules preventing transitions from this segment to another segment. Underlying type: `list<`[`ProhibitedTransitionRule`](prohibited_transition_rule.md)`>` ## Used By - [`Segment`](../segment.md) --- ## RailClass Captures the kind of rail segment. ## Values - `funicular` - `light_rail` - `monorail` - `narrow_gauge` - `standard_gauge` - `subway` - `tram` - `unknown` ## Used By - [`Segment`](../segment.md) --- ## RailFlag Simple flags that can be on or off for a railway segment. Specifies physical characteristics and can overlap. ## Values - `is_bridge` - `is_tunnel` - `is_under_construction` - `is_abandoned` - `is_covered` - `is_passenger` - `is_freight` - `is_disused` ## Used By - [`RailFlagRule`](rail_flag_rule.md) --- ## RailFlagRule Rail-specific flag rule with geometric scoping only. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `values` | `list<`[`RailFlag`](rail_flag.md)`>` | *Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing RailFlagRule applies to. | ## Used By - [`Segment`](../segment.md) - [`RailFlags`](rail_flags.md) --- ## RailFlags Set of boolean attributes applicable to railways. May be specified either as a single flag array of flag values, or as an array of flag rules. Underlying type: `list<`[`RailFlagRule`](rail_flag_rule.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Segment`](../segment.md) --- ## RoadClass Captures the kind of road and its position in the road network hierarchy. ## Values - `motorway` - `primary` - `secondary` - `tertiary` - `residential` - `living_street` - `trunk` - `unclassified` - `service` - `pedestrian` - `footway` - `steps` - `path` - `track` - `cycleway` - `bridleway` - `unknown` ## Used By - [`Segment`](../segment.md) --- ## RoadFlag Simple flags that can be on or off for a road segment. Specifies physical characteristics and can overlap. ## Values - `is_bridge` - `is_link` - `is_tunnel` - `is_under_construction` - `is_abandoned` - `is_covered` - `is_indoor` ## Used By - [`RoadFlagRule`](road_flag_rule.md) --- ## RoadFlagRule Road-specific flag rule with geometric scoping only. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `values` | `list<`[`RoadFlag`](road_flag.md)`>` | *Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)* | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing RoadFlagRule applies to. | ## Used By - [`Segment`](../segment.md) - [`RoadFlags`](road_flags.md) --- ## RoadFlags Set of boolean attributes applicable to roads. May be specified either as a single flag array of flag values, or as an array of flag rules. Underlying type: `list<`[`RoadFlagRule`](road_flag_rule.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Segment`](../segment.md) --- ## RoadSurface Physical surface of the road. ## Values - `unknown` - `paved` - `unpaved` - `gravel` - `dirt` - `paving_stones` - `metal` ## Used By - [`SurfaceRule`](surface_rule.md) --- ## RouteReference Route reference with linear referencing support. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `name` | [`StrippedString`](../../system/stripped_string.md) (optional) | Full name of the route*Minimum length: 1* | | `network` | [`StrippedString`](../../system/stripped_string.md) (optional) | Name of the highway system this route belongs to*Minimum length: 1* | | `ref` | [`StrippedString`](../../system/stripped_string.md) (optional) | Code or number used to reference the route*Minimum length: 1* | | `symbol` | [`StrippedString`](../../system/stripped_string.md) (optional) | URL or description of route signage*Minimum length: 1* | | `wikidata` | [`WikidataId`](../../system/wikidata_id.md) (optional) | A wikidata ID, as found on https://www.wikidata.org/ | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing RouteReference applies to. | ## Used By - [`Segment`](../segment.md) - [`Routes`](routes.md) --- ## Routes Routes this segment belongs to Underlying type: `list<`[`RouteReference`](route_reference.md)`>` ## Used By - [`Segment`](../segment.md) --- ## SequenceEntry A segment/connector pair in a prohibited transition sequence. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `connector_id` | [`Id`](../../system/ref/id.md) | Identifies the point of physical connection between the previous segment in the sequence and the segment in this sequence entry. | | `segment_id` | [`Id`](../../system/ref/id.md) | Identifies the segment that the previous segment in the sequence is physically connected to via the sequence entry's connector. | ## Used By - [`ProhibitedTransitionRule`](prohibited_transition_rule.md) --- ## Speed A speed value, i.e. a certain number of distance units travelled per unit time. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`SpeedValue`](speed_value.md) | Speed value | | `unit` | [`SpeedUnit`](../../core/speed_unit.md) | | ## Used By - [`SpeedLimitRule`](speed_limit_rule.md) --- ## SpeedLimitRule An individual speed limit rule. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `max_speed` | [`Speed`](speed.md) (optional) | *At least one of `max_speed`, `min_speed` must be set* | | `max_speed.value` | [`SpeedValue`](speed_value.md) | Speed value | | `max_speed.unit` | [`SpeedUnit`](../../core/speed_unit.md) | | | `min_speed` | [`Speed`](speed.md) (optional) | *At least one of `max_speed`, `min_speed` must be set* | | `min_speed.value` | [`SpeedValue`](speed_value.md) | Speed value | | `min_speed.unit` | [`SpeedUnit`](../../core/speed_unit.md) | | | `is_max_speed_variable` | `boolean` (optional) | Indicates a variable speed corridor*`strict=True`* | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SpeedLimitRule applies to. | | `when` | [`SpeedLimitRule.When`](speed_limit_rule.when.md) (optional) | Scopes for SpeedLimitRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE | | `when.heading` | [`Heading`](../../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing SpeedLimitRule applies to. | | `when.during` | [`OpeningHours`](../../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing SpeedLimitRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification. | | `when.mode` | `list<`[`TravelMode`](../../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing SpeedLimitRule applies to. | | `when.using` | `list<`[`PurposeOfUse`](../../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing SpeedLimitRule applies to. | | `when.recognized` | `list<`[`RecognizedStatus`](../../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing SpeedLimitRule applies to. | | `when.vehicle` | [`VehicleAxleCountSelector`](../../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing SpeedLimitRule applies to. | ## Constraints - At least one of `max_speed`, `min_speed` must be set ## Used By - [`Segment`](../segment.md) - [`SpeedLimits`](speed_limits.md) --- ## SpeedLimitRule.When Scopes for SpeedLimitRule: Scope.HEADING, Scope.TEMPORAL, Scope.TRAVEL MODE, Scope.PURPOSE OF USE, Scope.RECOGNIZED STATUS and Scope.VEHICLE ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `heading` | [`Heading`](../../core/scoping/heading.md) (optional) | The heading, either forward or backward, that the containing SpeedLimitRule applies to.*At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `during` | [`OpeningHours`](../../core/scoping/opening_hours.md) (optional) | The recurring time span, in the OpenStreetMap opening hours format, that the containing SpeedLimitRule applies to. For the OSM opening hours specification, see https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification.*At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `mode` | `list<`[`TravelMode`](../../core/scoping/travel_mode.md)`>` (optional) | A list of one or more travel modes, such as car, truck, or foot, that the containing SpeedLimitRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `using` | `list<`[`PurposeOfUse`](../../core/scoping/purpose_of_use.md)`>` (optional) | A list of one or more usage purposes, such as delivery or arrival at final destination, that the containing SpeedLimitRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `recognized` | `list<`[`RecognizedStatus`](../../core/scoping/recognized_status.md)`>` (optional) | A list of one or more recognized status values, such as employee or student, that the containing SpeedLimitRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | | `vehicle` | [`VehicleAxleCountSelector`](../../core/scoping/vehicle_axle_count_selector.md) \| [`VehicleHeightSelector`](../../core/scoping/vehicle_height_selector.md) \| [`VehicleLengthSelector`](../../core/scoping/vehicle_length_selector.md) \| [`VehicleWeightSelector`](../../core/scoping/vehicle_weight_selector.md) \| [`VehicleWidthSelector`](../../core/scoping/vehicle_width_selector.md) (list, optional) | A list of one or more vehicle parameters that limit the vehicles the containing SpeedLimitRule applies to.*Minimum length: 1**All items must be unique. (`UniqueItemsConstraint`)**At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set* | ## Constraints - At least one of `heading`, `during`, `mode`, `using`, `recognized`, `vehicle` must be set ## Used By - [`SpeedLimitRule`](speed_limit_rule.md) --- ## SpeedLimits Rules governing speed on this road segment Underlying type: `list<`[`SpeedLimitRule`](speed_limit_rule.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Segment`](../segment.md) --- ## SpeedValue Speed value Underlying type: `int32` ## Constraints - `≥ 1` - `≤ 350` - `≥ -2147483648` (from [`int32`](../../system/primitive/primitives.md)) - `≤ 2147483647` (from [`int32`](../../system/primitive/primitives.md)) ## Used By - [`Speed`](speed.md) --- ## Subclass Refines expected usage of the segment, must not overlap. ## Values - `link` - `sidewalk` - `crosswalk` - `parking_aisle` - `driveway` - `alley` - `cycle_crossing` ## Used By - [`Segment`](../segment.md) - [`SubclassRule`](subclass_rule.md) --- ## SubclassRule Set of subclasses scoped along segment. ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`Subclass`](subclass.md) | | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SubclassRule applies to. | ## Used By - [`Segment`](../segment.md) - [`SubclassRules`](subclass_rules.md) --- ## SubclassRules Set of subclasses scoped along segment Underlying type: `list<`[`SubclassRule`](subclass_rule.md)`>` ## Used By - [`Segment`](../segment.md) --- ## Subtype Transportation segment subtype classification. ## Values - `road` - `rail` - `water` ## Used By - [`Segment`](../segment.md) --- ## SurfaceRule ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`RoadSurface`](road_surface.md) | | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing SurfaceRule applies to. | ## Used By - [`Segment`](../segment.md) - [`Surfaces`](surfaces.md) --- ## Surfaces Physical surface of the road. May either be specified as a single global value for the segment, or as an array of surface rules. Underlying type: `list<`[`SurfaceRule`](surface_rule.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Segment`](../segment.md) --- ## Width Underlying type: `float64` ## Constraints - `> 0` ## Used By - [`WidthRule`](width_rule.md) --- ## WidthRule ## Fields | Name | Type | Description | | -----: | :----: | ------------- | | `value` | [`Width`](width.md) | | | `between` | [`LinearlyReferencedRange`](../../core/scoping/linearly_referenced_range.md) (list, optional) | The linearly-referenced sub-segment of the geometry, specified as a range (pair) of percentage displacements from the start of the geometry, that the containing WidthRule applies to. | ## Used By - [`Segment`](../segment.md) - [`WidthRules`](width_rules.md) --- ## WidthRules Edge-to-edge width of the road modeled by this segment, in meters. Examples: (1) If this segment models a carriageway without sidewalk, this value represents the edge-to-edge width of the carriageway, inclusive of any shoulder. (2) If this segment models a sidewalk by itself, this value represents the edge-to-edge width of the sidewalk. (3) If this segment models a combined sidewalk and carriageway, this value represents the edge-to-edge width inclusive of sidewalk. Underlying type: `list<`[`WidthRule`](width_rule.md)`>` ## Constraints - Minimum length: 1 - All items must be unique. (`UniqueItemsConstraint`) ## Used By - [`Segment`](../segment.md)