Skip to main content

Mapbox Streets v8

This tileset reference document includes information to help you use the data in the Mapbox Streets v8 tileset.

Overview

Mapbox Streets v8 is a Mapbox-provided vector tileset that includes geometries and metadata for roadways, terrain, administrative boundaries, building footprints, land use classifications, rail stations, points of interest, and more.

For full examples of using Mapbox Streets vector tiles to create a map style, see the default styles in Mapbox Studio.

Data sources and updates

Mapbox Streets v8 vector tiles are based on a combination of proprietary Mapbox data, Open Data projects such as OpenStreetMap, Microsoft Open Maps and Wikidata, as well as data vendors such as Zenrin in Japan.

LayerData sources
adminGlobally: Proprietary Mapbox data
aerowayGlobally: OpenStreetMap replication feed
Japan: OpenStreetMap replication feed, Zenrin
airport_labelGlobally: OpenStreetMap replication feed
Japan: OpenStreetMap replication feed, Zenrin
buildingGlobally: Proprietary Mapbox data, OpenStreetMap, Microsoft
Japan: Zenrin
housenum_labelGlobally: OpenStreetMap replication feed
Japan: Zenrin
landuse_overlayGlobally: OpenStreetMap replication feed
Japan: Zenrin
landuseGlobally: OpenStreetMap replication feed
Japan: Zenrin
motorway_junctionGlobally: OpenStreetMap replication feed
Japan: Zenrin
natural_label, types ocean and seaGlobally: Proprietary Mapbox data
natural_label, all other typesGlobally: OpenStreetMap replication feed
Japan: Zenrin
place_label, types country and stateGlobally: Proprietary Mapbox data
poi_labelGlobally: OpenStreetMap replication feed
Japan: Zenrin
roadGlobally: OpenStreetMap replication feed
Japan: Zenrin
structureGlobally: OpenStreetMap replication feed
Japan: Zenrin
transit_stop_labelGlobally: OpenStreetMap replication feed
Japan: Zenrin
water (ocean parts)Globally: OpenStreetMap
Japan: Zenrin
waterwayGlobally: OpenStreetMap replication feed
Japan: Zenrin

Data updates

The current supported version of the Mapbox Streets vector tiles receives regular data updates as new information becomes available and existing information is improved.

Data quality

Besides the daily efforts of contributors all over the globe, the OpenStreetMap community uses several other methods for identifying errors in the data, including multiple quality-assurance feedback tools and a flagging system that allows users to identify possible mistakes or areas that may need attention from someone with local knowledge.

Mapbox also has a dedicated data team that is committed to ensuring the quality of Mapbox maps and to adding and improving features all over the world. We also use an automated quarantine system that detects changes to the map that look like accidental editing mistakes or vandalism and stages them for manual review by our data team.

Attribution

When you publicly use styles or software that use Mapbox Streets vector tiles, you must display proper attribution.

A list of sources utilized in creating Mapbox Streets is available on the Mapbox website.

Multiple geometry types

Mapbox vector tiles support multiple geometry types in the same layer. Mapbox Streets v8 takes advantage of this in some layers.

A geometry in the vector tile can be one of three types:

polygon Polygon / multipolygon
polyline Linestring / multilinestring
marker Point

In Mapbox Studio, you can select one, two, or all the three types with the Geometry Type toggles in each layer's data selection tab.

IDs

Each feature in a vector tile contains an object ID. This ID is not available for styling via Mapbox Studio, but can be used to interact with features at runtime with Mapbox GL JS and other vector tile libraries.

The ID is derived from a unique ID assigned to each feature by the relevant data vendor or Open Data project.

Often, multiple objects from the same or multiple proprietary sources are combined into a single object in our vector tiles. For example, water polygons are unioned to avoid seams, and road lines are joined to save space. In these cases the ID is either 0 or one of the input IDs chosen at random.

Data stability

As we make ongoing data updates to reflect changes in the world or integrate new data vendors, we may also add new layers, fields, and values to Mapbox Streets v8 tiles. Our goal is to do this in a way that preserves compatibility with existing v8 styles. Here's what you need to know about how Mapbox Streets v8 may change in the future:

  • Layers
    • Existing layers will not be renamed or removed.
    • New layers may be added.
  • Fields
    • Existing fields will not be renamed or removed.
    • New fields may be added to any layer.
  • Field values
    • The meanings of existing values will not change.
    • Values of specific features may change to correct errors or reflect real-world changes.
    • New values may be added to any field unless otherwise noted in this documentation.
    • Fields that may contain null values are noted in this documentation, and null values will not be introduced to existing layers that do not already have them.

You should design your styles to account for the possibility of new field values. Be explicit in your filters where possible, and make sure to include appropriate default styles when using expressions.

Common fields

There are several fields that are used across several layers. These fields are detailed below instead of being duplicated for each relevant layer in the Layer reference section.

name text and name_<lang-code> text

Label names are available in many languages. The name_* value is null if no translation data is available for a given feature. When styling label layers, you are responsible for determining an appropriate fallback approach.

If the name field is null for a particular feature, then all the language-specific name_* fields is also null. This means that name should always be the final fallback value if you want to include it in your set of label languages.

If the name field contains text to be rendered on multiple lines (horizontally or vertically) the text is separated by zero-width space characters.

FieldDescription
nameThe name (or names) used locally for the place
name_arArabic
name_enEnglish
name_esSpanish
name_frFrench
name_deGerman
name_itItalian
name_ptPortuguese
name_ruRussian
name_zh-HansSimplified Chinese
name_zh-HantTraditional Chinese (if available, but may contain some Simplified Chinese)
name_jaJapanese
name_koKorean
name_viVietnamese

For languages that may have regional variations, the tileset gives no particular preference where place name spellings differ.

Considerations for Spanish, French, German, and Chinese
Spanish, French, and German: For the name_es, name_fr, and name_de labels, there are additional fallback conditions. Where the local name is in a non-Latin writing system and no Spanish, French, or German translation is available, these fields show an English or international version of the name if possible. Otherwise, they show the local name.Chinese: The name_zh-Hant field contains Mandarin using simplified Chinese characters for our custom label layers: #place_label and #natural_label. All other label layers are sourced from OpenStreetMap and may contain one of several dialects and either simplified or traditional Chinese characters in the name_zh-Hant field. The name_zh-Hans field is similar, except any traditional Chinese characters are automatically transformed to Simplified Chinese.

name_script text

Wherever there is a name field, there is also a name_script field that describes the primary script used in that text. This can be helpful for customizing fonts or language fallback conditions. Values include:

Arabic
Armenian
Bengali
Bopomofo
Canadian_Aboriginal
Common
Cyrillic
Devanagari
Ethiopic
Georgian
Glagolitic
Greek
Gujarati
Gurmukhi
Han
Hangul
Hebrew
Hiragana
Kannada
Katakana
Khmer
Lao
Latin
Malayalam
Mongolian
Myanmar
Nko
Sinhala
Syriac
Tamil
Telugu
Thaana
Thai
Tibetan
Tifinagh
Unknown

The value is null if name is also null.

sizerank number

The sizerank field is a value from 0-16 included in label layers where points or lines have been derived from polygons, such as poi_label, natural_label, airport_label. It lets you style and filter based on the size of a feature relative to the current zoom level. The tileset assigns the largest objects sizerank=0 and assigns points sizerank=16.

A single feature has a changing sizerank as you zoom in and the relative size of the feature increases. For example, a park might have a sizerank of 9 at z11, 6 at z12, and 2 at z13.

The value is never null and is always be within the range 0-16.

filterrank number

The filterrank field is a value from 0-5 used to customize label density. It's intended to be used in style layer filters (in the 'Select data' tab in Mapbox Studio). The value is relative to the current zoom level. For example, the same POI might have filterrank=5 at z10 while having filterrank=1 at z14, since zooming in changed the relative importance of the POI.

You could set filterrank<=1 to only show the most prominent labels, filterrank<=3 to produce moderate density, and filterrank<=5 to see as many labels as possible.

The value is never null and is always in the range of 0-5.

maki text

Some layers have a maki field designed to make it easier to assign icons using the Maki icon project or other icons that follow the same naming scheme. Each layer uses a different subset of the names, but the full list of values used in Mapbox Streets is compiled here so you can make sure your style has all the icons needed across different layers.

Not all icons from the Maki project are used in Mapbox Streets, and different types of related features can sometimes have the same maki value (for example universities and colleges, or art supply shops and art galleries). Nameless POIs always have a Maki value of marker, the generic default.

The possible values for the maki field for all layers are listed below. Icon names that were not part of any layer in v7 are marked with 🆕. No further values will be added in Mapbox Streets v8.

airport_label:

airport
airfield
heliport
rocket

natural_label:

marker
mountain
volcano
waterfall 🆕

poi_label:

alcohol-shop
american-football 🆕
amusement-park
aquarium
art-gallery
attraction
bakery
bank
bar
basketball 🆕
beach 🆕
beer
bicycle
bowling-alley 🆕
bridge 🆕
cafe
campsite
car
car-rental 🆕
car-repair 🆕
casino 🆕
castle
cemetery
charging-station 🆕
cinema
clothing-store
college
communications-tower 🆕
confectionery 🆕
convenience 🆕
dentist
doctor
dog-park
drinking-water
embassy
farm 🆕
fast-food
fire-station
fitness-centre 🆕
fuel
furniture 🆕
garden
globe 🆕
golf
grocery
harbor
hardware 🆕
horse-riding 🆕
hospital
ice-cream
information
jewelry-store 🆕
laundry
library
lodging
marker
mobile-phone 🆕
monument
museum
music
optician 🆕
park
parking 🆕
parking-garage 🆕
pharmacy
picnic-site
pitch 🆕
place-of-worship
playground
police
post
prison
ranger-station 🆕
religious-buddhist 🆕
religious-christian
religious-jewish
religious-muslim
restaurant
restaurant-noodle 🆕
restaurant-pizza 🆕
restaurant-seafood 🆕
school
shoe 🆕
shop
skateboard 🆕
slipway 🆕
stadium
suitcase 🆕
swimming
table-tennis 🆕
tennis 🆕
theatre
toilet
town-hall
veterinary
viewpoint 🆕
volleyball 🆕
watch 🆕
watermill 🆕
windmill 🆕
zoo

transit_stop_label:

bicycle-share
bus
ferry
rail
rail-metro
rail-light
entrance

maki_beta text

Maki icons that might be supported in future versions of Mapbox Streets are in maki_beta field. Possible values include, but not limited to:

poi_label:

baseball
lighthouse
landmark
industry
highway-services
highway-rest-area
racetrack-cycling
racetrack-horse
racetrack-boat
racetrack
religious-shinto
observation-tower
restaurant-bbq
tunnel

natural_label:

hot-spring

motorway_junction:

interchange
junction

worldview text

Mapbox Streets v8 introduces the notion of worldviews to the admin, airport_label, natural_label, and place_label data layers. The vector tiles contain multiple versions of some features, each with a worldview value indicating the intended audience. When the worldview filter is applied, it must include both all and one of the region-specific values. Additionally, for all worldviews except for US worldview, there are classes in respective layers, prefixed with disputed_ which user must select in conjunction with the worldview filter; classes in respective layers in US worldview do not have the disputed_ prefix.

A worldview filter must be applied to style layers that use the admin data layer. It is highly recommended to also use a worldview filter with airport_label, natural_label, and place_label data layers to communicate intent, but if no worldview is applied to those layers, the labels displayed on the map will reflect the US worldview.

Note
In ongoing updates to Mapbox Streets v8, use of the worldview field may be expanded. Changes may include both:- Introducing the current concept of worldview to new or existing layers.- Adding new values to the list of possible worldview values to represent other worldviews (see Data stability).
Note
No map display generated by any worldview value listed here (or any combination of values) necessarily reflects the official policy of any government or is approved by any government.
ValueDescription
allAppropriate for all worldviews (most features)
CNFeatures for a mainland Chinese audience/worldview, but not officially approved for use in the PRC.
INFeatures conforming to cartographic requirements for use in India.
JPFeatures for a Japanese audience, but which do not necessarily reflect official Japanese policy.
USFeatures for an American audience, but which do not necessarily reflect official US foreign policy.

disputed_ class text {#disputed_-class-text}

Many layers have a class field. These classes are often used to filter out or style features based on their purpose or characteristics. The available values for the class field vary by layer and are detailed in the Layer Reference below.

In layers that have both a class field and a worldview field, the value for the class field can be any value listed in the Layer Reference for that layer or any of those values prefixed with disputed_. When a feature is marked as disputed, it falls under the disputed_{class} class. For example, a disputed bay feature belongs to disputed_bay class instead of bay class.

disputed text {#disputed-text}

While no single map will reflect all global perspectives, acknowledging disputes where they exist is an important aspect of cartography and can lead to more universally usable maps. The dispute value will always be either true or false (never null). Any feature with a disputed_{class} class will also have set disputed to true.

Layer Reference

The Mapbox Streets v8 tileset contains the following layers. For reference, the current minimum-available zoom level for each layer is mentioned, but note that this is subject to change as we roll out updates and improvements. It also does not apply to all features within a layer - only the most prominent features are available at lower-numbered zoom levels, and more features are available as you zoom in. Labels for physically-large features also have a maximum zoom level based on their size.

admin

markerpolylinepolygonmin zoom level: 0buffer: 4

This layer contains boundary lines for national and subnational administrative units. The data source & shapes match polygons from the Mapbox Boundaries product.

admin_level number {#admin_level-number}

The admin_level field separates different levels of boundaries.

ValueDescription
0Countries
1First-level administrative divisions
2Second-level administrative divisions

disputed text {#disputed-text-1}

While no single map will reflect all global perspectives, acknowledging disputes where they exist is an important aspect of cartography and can lead to more universally usable maps. The disputed value will always be either true or false (never null). You should style boundary lines with a disputed value of true using a dashed or otherwise distinct style from non-disputed lines.

maritime text {#maritime-text}

Mapbox Streets v8 includes a minimal set of maritime boundaries. These have a maritime value of true to use for distinct styling or filtering. The value is always either true or false (never null).

iso_3166_1 text {#iso_3166_1-text}

The iso_3166_1 field contains the ISO 3166-1 alpha-2 code or codes that apply to a boundary. For subnational boundaries this is a single code of the parent country. For international boundaries between two countries, the value is the codes of both countries in alphabetical order, separated by a dash (-).

aeroway

markerpolylinepolygonmin zoom level: 9buffer: 4

The aeroway layer includes both lines and polygons representing runways, helipads, and more.

type text {#aeroway-type-text}

The type field separates different types of aeroways for styling.

ValueDescription
runwayWhere planes take off and land
taxiwayWhere planes move between runways, gates, and hangars
apronWhere planes park, refuel, load
helipadWhere helicopters take off and land

ref text {#aeroway-ref-text}

The ref field contains runway and taxiway identifiers. The value may be null.

airport_label

markerpolylinepolygonmin zoom level: 8buffer: 64

This layer contains point geometries that are one of: airport, airfield, heliport, and rocket.

See names and name_script for information about names and translations available for label text.

See sizerank for information about that field.

ref text {#airport_label-ref-text}

The ref field contains short identifier codes for many airports. These are pulled from the OpenStreetMap tags iata, ref, icao, or faa (in order of preference). The value may be null.

maki text {#airport_label-maki-text}

The maki field lets you assign different icons to different types of airports. See the maki part of the Common Fields section for more details.

ValueDescription
airportMost commercial airports
airfieldSmaller airports and private airfields
heliportFor helicopters
rocketSpaceflight facilities

class text {#airport_label-class-text}

The class field identifies airports by their primary type of use.

ValueDescription
civilAirports used for primarily civilian purposes
militaryAirports used for primarily military purposes

building

markerpolylinepolygonmin zoom level: 13buffer: 2

Large buildings appear at zoom level 13, and all buildings are included in zoom level 16 and up.

underground text {#building-underground-text}

The underground field is true for buildings that are underground (for example, some subway stations). This value is always either true or false (never null).

type text {#building-type-text}

The type field lets you style buildings based on their function (for example, stadium) and differentiate building parts from building outlines. How a building feature's type is assigned depends on a few factors:

  • If a feature is one of several parts of a building intended primarily for 3D rendering, it will have a value of building:part.
  • For full buildings from OpenStreetMap:
    • The value will match the building tag from OpenStreetMap (see TagInfo for common values) for all tags except yes.
    • If the feature is tagged building=yes, it will have a value of building.
  • For full buildings from Zenrin:
    • The value will match the textual representation of the Zenrin annotation target code (blcode).
    • If the feature has an uncategorized building type in Zenrin, it will have a value of building.
  • For full buildings from all other data sources, the value will match the textual representation of a data source owner's building type code.

Possible type values for OpenStreetMap building data:

apartments
farm
hotel
house
detached
residential
dormitory
terrace
houseboat
bungalow
cabin
commercial
office
industrial
retail
supermarket
warehouse
kiosk
religious
cathedral
temple
chapel
church
mosque
synagogue
shrine
civic
government
hospital
school
transportation
stadium
train_station
university
grandstand
public
barn
bridge
bunker
carport
conservatory
construction
garage
garages
farm_auxiliary
garbage_shed
greenhouse
hangar
hut
pavilion
parking
roof
sports_hall
shed
stable
service
ruins
transformer_tower
water_tower

Possible type values for Zenrin building data:

Zenrin blcodeZenrin textMapbox Streets type
00hotelhotel
01commercialcommercial
02schoolschool
03leisureleisure
04landmarklandmark
05civic, governmentcivic
06hospitalhospital
07train stationtrain_station
08otherbuilding
elsebuildingbuilding

Zenrin textual representations of the Zenrin elcodes like general building/5F-10F are normalized to type building with the height inferred from the textual representation (for example, a height of 15m can be inferred from 5F-10F)

height number {#building-height-number}

The height field contains the height of a building or building part in meters (rounded to the nearest integer). Often this value is derived from the building:levels tag on OpenStreetMap. We estimate 3 meters per level if no exact height is specified. This value may be null where extrude is false.

min_height number {#building-min_height-number}

The min_height field contains the height in meters from the ground to the bottom of a building part, for cases where the bottom of the part is not on the ground. This allows for proper extrusion rendering of things such as sky bridges and cantilevered building parts. This value may be null where extrude is false.

extrude text {#building-extrude-text}

The extrude field indicates whether the object should be included in 3D extrusion renderings. For example a complex building might have various building:part objects mapped with different heights and a building object representing the footprint of the entire building. Only the building:part objects are needed for 3D rendering, so the full footprint outlines have an extrude value of false. The extrude value is always either true or false (never null).

housenum_label

markerpolylinepolygonmin zoom level: 16buffer: 64

This layer contains points used to label the street number parts of specific addresses.

house_num text {#housenum_label-house_num-text}

The house_num field contains house and building numbers. These are commonly integers but may include letters or be only letters, for example "1600", "31B", "D". If an address has no number tag but has a house name or building name, the house_num field is the name instead.

landuse_overlay

markerpolylinepolygonmin zoom level: 5buffer: 8

This layer is for landuse and landcover polygons that your style should draw above the #water layer.

class text {#landuse_overlay-class-text}

The main field used for styling the landuse_overlay layer is class.

ValueDescription
national_parkRelatively large area of land set aside by a government for human recreation and environmental protection
wetlandWetlands that may include vegetation (marsh, swamp, bog)
wetland_novegWetlands that probably don't contain vegetation (mud, tidal flat)

type text {#landuse_overlay-type-text}

The type field is pulled from the primary OpenStreetMap tags for that class.

landuse

markerpolylinepolygonmin zoom level: 5buffer: 4

This layer includes polygons representing both landuse and landcover.

It's common for many different types of landuse and landcover to be overlapping, so the polygons in this layer are ordered by the area of their geometries to make sure smaller objects is not be obscured by larger ones. Pay attention to use of transparency when styling – the overlapping shapes can cause muddied or unexpected colors.

class text {#landuse-class-text}

The main field used for styling the landuse layer is class.

ValueDescription
aboriginal_landsThe boundary of aboriginal lands
agricultureVarious types of crop and farmland
airportAirport grounds
cemeteryCemeteries and graveyards
commercial_areaArea of high commercial activity
facilityOther facility grounds
glacierGlaciers or permanent ice/snow
grassGrasslands, meadows, fields, lawns, etc.
hospitalHospital grounds
industrialIndustrial areas
parkCity parks, village greens, playgrounds, national parks, nature reserves, etc.
parkingParking areas for automobiles
pisteArea used for skiing, snowboarding, and other snow/mountain sports
pitchSports fields and courts of all types
residentialResidential areas
rockBare rock, scree, quarries
sandSand, beaches, dunes
schoolPrimary, secondary, post-secondary school grounds
scrubBushes, scrub, heaths
woodWoods and forestry areas

type text {#landuse-type-text}

The type field is pulled from the primary OpenStreetMap tags for that class.

motorway_junction

markerpolylinepolygonmin zoom level: 11buffer: 8

This layer contains point geometries for labeling motorway junctions (highway exits). Classes and types match the types in the road layer.

ref text, reflen number, and name text {#motorway_junction-ref-text-reflen-number-and-name-text}

The motorway junction layer has a ref field and a name field for styling labels. The reflen field tells you how long the ref value is in case you want to style this layer with shields. All these fields may be null.

class text and type text {#motorway_junction-class-text-and-type-text}

The class and type fields tell you what kind of road the junction is on. See the #road layer for possible values.

filterrank number {#motorway_junction-filterrank-number}

See filterrank for information on using this field.

maki_beta text {#motorway_junction-maki_beta-text}

Future Maki values. See #maki_beta.

natural_label

markerpolylinepolygonmin zoom level: 0buffer: 64

The natural_label layer contains points and lines for styling natural features such as bodies of water, mountain peaks, valleys, deserts, and so on.

See names and name_script for information about names and translations available for label text.

See sizerank and filterrank for information on using those fields to style text size and label density.

class text and maki text {#natural_label-class-text-and-maki-text}

The natural_label layer is organized into many different classes for styling and filtering. Within each class, several maki values are available for assigning icons to features. See the maki part of the Common Fields section for more details about that field.

ClassMaki valuesFeature types
baymarkerInlet in a large body of water
canalmarkerCanals
continentmarkerContinents
dockmarkerEnclosed area of water for ships
glaciermarkerGlaciers
landformmountain , volcano , markerPeaks, meadows, cave entrances, archipelago, island, islet, saddle, fell, desert, valley, etc.
oceanmarkerOceans
reservoirmarkerHuman water containment areas
rivermarkerRivers
seamarkerSeas and other large water features including some gulfs, straits, bays, etc.
streammarkerStreams
water_featurewaterfall , markerWaterfalls
watermarkerLakes, ponds, etc.
wetlandmarkerWetland, marsh

See the additional disputed class.

elevation_m number and elevation_ft number {#natural_label-elevation_m-number-and-elevation_ft-number}

The elevation_m and elevation_ft fields hold the feature elevation in meters and feet, respectively. Values are rounded to the nearest whole number and do not include units. Use a text field such as {elevation_ft} feet or {elevation_m}m in Mapbox Studio to display the units. These fields may be null.

place_label

markerpolylinepolygonmin zoom level: 0buffer: 128

This layer contains points for labeling places including countries, states, cities, towns, and neighborhoods.

See names and name_script for information about names and translations available for label text.

See filterrank for information on using that field.

class text {#place_label-class-text}

The class field provides a broad distinction between place types and is the main attribute that should be used for styling different place labels. The possible values are:

ClassEncompasses Types
countrycountry, territory, sar, disputed
statestate
settlementcity, town, village, hamlet
settlement_subdivisionsuburb, quarter, neighbourhood

See the additional disputed class.

type text {#place_label-type-text}

The type field provides a finer-grain distinction between different kinds of places than class.

Unlike the class field, not all type values are available for each country. New type values may be added in the future. See Data stability.

ValueDescription
countrySovereign or partially-recognized states.
sarSpecial Administrative Region.
territorySemi-autonomous or other subnational entities with ISO 3166-1 codes.
disputed_territoryDisputed territories with ISO 3166-1 codes.
stateFirst-level administrative divisions or similar. Only a small subset of these are included to reduce clutter and put focus on cities, towns, etc.
citySettlement of about 100,000 or more people.
townUrban or rural settlement of about 10,000-100,000 people.
villageUsually rural settlement of less than about 10,000.
hamletRural settlement with a population of about 200 or fewer.
suburbA distinct section of an urban settlement such as an annexed town, historical district, or large and important neighborhood.
quarterA large neighborhood or section of a larger city or town.
neighbourhoodA smaller neighborhood or part of a larger settlement.
blockA numbered block.

symbolrank number

The symbolrank value is intended to simplify styling of the label size and symbol prominence of place features. It ranges from 1 to 19 and is consistently assigned across zoom levels. For example, a place with a symbolrank of 6 at z7 has the same symbolrank value of 6 as you zoom in and out to any other level.

The value is never null and is always in the range of 1-19.

iso_3166_1 text {#place_label-iso_3166_1-text}

The iso_3166_1 field contains the ISO 3166-1 alpha-2 code of the country the place is in. The value may be null, either due to location match errors or for features that are in international waters.

iso_3166_2 text {#place_label-iso_3166_2-text}

The iso_3166_2 field contains the ISO 3166-2 alpha-2 which uniquely identifies a country's subdivision in a global context. The value may be null, either due to location match errors or for features that are in international waters.

capital number {#place_label-capital-number}

The capital field allows distinct styling of labels or icons for the capitals of countries, regions, or states and provinces. The value of this field may be 2, 3, 4, 5, or 6. National capitals are 2, and 3 through 6 represent capitals of various sub-national administrative entities. These levels come from OpenStreetMap and have different meanings in different countries - see the OpenStreetMap wiki for specific details.

The value is null for any place that is not a capital.

abbr text {#place_label-abbr-text}

This abbr field is available for type=state and provides the local abbreviation of the state.

text_anchor text {#place_label-text_anchor-text}

The text_anchor field can be used as a hint for label placement. Possible values match the Mapbox Style Spec for text anchor. The value may be null.

ValueMeaning
centerThe center of the text is placed closest to the anchor.
leftThe left side of the text is placed closest to the anchor.
rightThe right side of the text is placed closest to the anchor.
topThe top of the text is placed closest to the anchor.
bottomThe bottom of the text is placed closest to the anchor.
top-leftThe top left corner of the text is placed closest to the anchor.
top-rightThe top right corner of the text is placed closest to the anchor.
bottom-leftThe bottom left corner of the text is placed closest to the anchor.
bottom-rightThe bottom right corner of the text is placed closest to the anchor.

poi_label

markerpolylinepolygonmin zoom level: 5buffer: 64

This layer is used to place icons and labels for various points of interest (POIs).

See names and name_script for information about names and translations available for label text.

See sizerank and filterrank for information on using those fields to style text size and label density.

See maki for more information about using this field for assigning icons.

maki_modifier text

Localized Maki icons are enabled with the maki_modifier field. The value of maki_modifer corresponds to an ISO country code. If it's present on a feature, you can use it to swap out a default Maki icon with a country-specific one.

For example, the widely recognized symbol for banks in Japan is different than that for the US. In the poi_label layer, all features that represent banks have a Maki field with value bank. Of those features, the ones located in Japan also have a maki_modifer field with a value of JP. This allows you to specify the bank-JP Maki icon rather than the bank icon when styling your map.

maki_beta text {#poi_label-maki_beta-text}

Future Maki values. See maki_beta.

class text {#poi_label-class-text}

The class field groups points of interest into broad categories for styling purposes. The values are useful for designing icon color schemes, for example.

arts_and_entertainment
building
commercial_services
education
food_and_drink
food_and_drink_stores
general
historic
industrial
landmark
lodging
medical
motorist
park_like
place_like
public_facilities
religion
sport_and_leisure
store_like
visitor_amenities

brand text

The brand field is one of the standardized brand names listed below. Like maki, the brand string is the base name of a SVG icon image. While maki is for a general noun (for example: bank), the brand field is for a specific noun (for example: juroku-bank). The value for the field is either null or a string.

The list of possible brand values will expand with future updates. Possible values include, but not limited to:

114-bank
21rentacar
2nd-street
31-ice-cream
7-eleven
77bank
access-honda
advanced-area
aen
aeon
aiya
akita-bank
alfa-romeo
alpen
alpine-marketing
ampm
aoki
aomori-bank
aoyama
asahi-bank
asakuma
asakuma-gogo-cafe
ashikaga-bank
atom
atom-boy
audi
autobacs
autohelloes
autotech
aw
awa-bank
b-kids
bamiyan
barneys-newyork
becks-coffee
bentley
benz
best-denki
big-boy
bikkuri-donkey
bldy
bmw
bmw-motorrad
bon-belta
book-off
bronco-billy
budget
burger-king
cafe-colorado
cafe-de-crie
caffe-veloce
carenex
carlife-stadium-rentacar
casa
chiba-bank
chrysler
circle-k
citroen
cockpit
coco-ichibanya
coco-store
cocos
cocostorecoco
community-store
cosmo-oil
costco
dai-ichi-kangyo-bank
daiei
daihatsu
daily-store
daimaru
daisan-bank
daishi-bank
daiwa
daiwa-bank
dennys
deodeo
dio
domdom-hamburger
doutor-coffee
dramatic-area
duo
ehime-bank
eki-rent-a-car
eneos
esso-oil
eunos
excelsior-caffe
expasa
f-rent-a-car
fahren
family-yusa
familymart
ferrari
fiat
first-kitchen
food-style-98
ford
forus
fracasso
freshness-burger
fuji-bank
fukudaya-department-store
fukui-bank
fukuoka-bank
fukuya
futata
garage-off
gare
general-motors
general-oil
gindaco
gmdat
grache-gardens
gulliver
gusto
haagen-dazs-shop
hachijuni-bank
half-dime
hamacho
hamazushi
hamburg-restaurant-bell
hankyu-department-store
hanshin
hard-off
haruyama
heisei-car
heiwado
higo-bank
hihirose
hino
hiroshima-bank
hitokuchi-chaya
hobby-off
hokkaido-bank
hokkaido-oil
hokkoku-bank
hokuren
hokuriku-bank
hokuto-bank
honda
honda-bike
honda-cars
honda-clio
honda-hisuko
honda-primo
honda-verno
hoshino-coffee
hot-spar
hyakugo-bank
hyundai
ichibata-department-store
idemitsu-oil
ikinari-steak
inageya
isetan
isuzu
italian-tomato-cafe-jr
ito-yokado
itsumo-rent-a-car
iwataya
iwate-bank
izumi
izumiya
izutsuya
j-net-rentcar
ja
ja-ss
jaf
jaguar
japan-energy
japan-post-bank
japan-post-insurance
japan-rent-a-car
jolly-ox
jolly-pasta
jomo
jonathans
joyful-city
joyfull
joyo-bank
jujiya
jumble-store
juroku-bank
jusco
jvc-kenwood
kagoshima-bank
kaisen-misakiko
kaiten-atom-sushi
kasumi
kawasaki
kawatoku
keihan-department-store
keio-department-store
kfc
kintetsu-department-store
kitakyushu-bank
kohikan
komedas-coffee
kozosushi
kygnus-oil
kyoto-bank
kyubeiya
kyushu-oil
laforet-harajuku
lamborghini
lamu
landrover
lawson
lexus
life
lotteria
lotus
lumine
maruei
maruetsu
maruetsupetit
marugame-seimen
maruhiro-department-store
maruhoncowboy
marui
marunen-me
maserati
matsubishi
matsuya
matsuya-department-store
matsuyadenki
matsuzakaya
mazda
mazda-autozam
mazda-enfini
mazda-rent-lease
mcdonalds
meitetsu-pare-department-store
melsa
meshiya-miyamoto-munashi
meshiyadon
michi-no-eki
michinoku-bank
milky-way
mini
mini-piago
ministop
mister-donut
mitsubishi-car-plaza
mitsubishi-corporation-energy
mitsubishi-fuso
mitsubishi-motors
mitsubishi-oil
mitsui-oil
mitsukoshi
mizuho-bank
mizuho-corporate-bank
mmc-rent-a-car
mobil-oil
mode-off
momiji-bank
montecarlo
mos-burger
motenasu
ms-dining
mt-fuji
mufg-bank
my-basket
nagasakiya
nakago
nakasan
nakau
natural-lawson
navi
neopasa
netz-toyota
niconicorentacar
nippo-rent-a-car-system
nippon-oil
nippon-rent-a-car
nippon-rental-car
nissan
nissan-cherry
nissan-forklift
nissan-motor
nissan-parts
nissan-prince
nissan-rent-a-car
nissan-satio
north-pacific-bank
north-wing-rent-a-car
ntt
odakyu-department-store
off-house
ohsho
oita-bank
oita-rental
ok
okadaya
okajima
okuno
okuwa
olympic
onuma
orix-rent-a-car
osaka-ohsho
ots-rentacar
palty-fuji
parco
pasar
pavarie
pepper-lunch
petras
peugeot
plaka
platpark
poplar
popolo
poppo
pork-cutlet-hamakatsu
porsche
pronto
ralse
recycle-mart
red-cabbage
red-lobster
renault
renoir
rent-a-car-japaren
resona-bank
ringer-hut
robinsons-department-store
rolls-royce
rover
royal-host
saga-bank
saga-rent-lease
saijo-department-store
saikaya
saint-marc
saitama-resona-bank
saizeriya
sakura-bank
san-in-goto-bank
sanbangai
sanei
santa-no-souko
sanwa-bank
sato
saty
save-on
sawayaka
seattles-best-coffee
seibu
seicomart
seiyu
shabushabu-dontei
shiga-bank
shikoku-bank
shinkin-bank
shinwa-bank
shizuoka-bank
showa-shell-oil
sizzler
sky-rentallease
skylark
smile-santa
sogo
sokoseikatsukan
solato
spar
starbucks-coffee
steak-hamburg-ken
steak-miya
steak-miya-libero
steak-no-don
stefan-grill
stern
store100
subaru
subway
suehiro
sukiya
sumitomo-bank
sumitomo-mitsui-banking-corporation
sun-every
sundays-sun
sunkus
sunpiazza
suruga-bank
sushihan
suzuki
suzuki-bike
suzuran-department-store
syabu-yo
tachiya
tacti-toyota
taiyakan
takarajima
takashimaya
tamaya
tempura-tendon-tenya
tenmaya
the-chugoku-bank
the-eighteenth-bank
the-iyo-bank
the-nishi-nippon-city-bank
the-toho-bank
three-f
times-car-rental
tobu-department-store
tokai-bank
tokiwa
tokyo-mitsubishi-bank
tokyu-department-store
tokyu-store
tomato-onion
tonden
topos
toyopet
toyota
toyota-corolla
toyota-diesel
toyota-forklift
toyota-parts
toyota-rent-a-car
toyota-vista
tsuruya-department-store
tullys-coffee
ud-trucks
ueshima-coffee-house
ufj-bank
uny
uobei
victoria
victoria-station
vivre
volks
volkswagen
volvo
welcome-gate
wendys
x-rent-a-car
yakiniku-king
yamaguchi-bank
yamaha
yamaha-bike
yamakataya
yamazaki-shop
yanagen
yanase
yao-department-store
yaohan
yasmocca
yayoiken
yellow-hat
yokohama-bank
york-benimaru
yoshinoya
you-me-mart
yumean
yuzuan
zenrin

type text {#poi_label-type-text}

The type field contains a more specific classification intended for display (for example, 'Cafe', 'Hotel', or 'Laundry'). These values come from either the original OpenStreetMap tags or Zenrin and are not a limited set.

Resort
Library
Parking
Bank
Aquarium
Food
Cemetery
Station
Christian
Course
Office
School
Supermarket
Military
Castle
Beach
Buddhist
Cream
Shop
Centre
Stadium
Police
Hotel
Raceway
Hospital
Restaurant
Zoo
Museum
Park
Greengrocer
Marina
Ruins
Garden
Viewpoint
Convenience
Cafe
Area
Site
University
Fuel
Townhall
Ice rink
Sports centre
Department store

category_en text and category_zh-Hans text {#poi_label-category_en-text-and-category_zh-hans-text}

The category_en and category_zh-Hans fields contain translated category descriptions for POIs. These can be used as a fallback or as supplemental information where English or simplified Chinese translations may not exist. These values may be null for OpenStreetMap data and are always null for Zenrin data in Japan.

Language coverage may be expanded in a future v8 update.

road

markerpolylinepolygonmin zoom level: 3buffer: 4

The roads layer contains lines, points, and polygons needed for drawing features such as roads, railways, paths and their labels.

See names and name_script for information about names and translations available for label text.

class text {#road-class-text}

The main field used for styling the road layer is class.

ValueDescription
motorwayHigh-speed, grade-separated highways.
motorway_linkLink roads/lanes/ramps connecting to motorways.
trunkImportant roads that are not motorways.
trunk_linkLink roads/lanes/ramps connecting to trunk roads.
primaryA major highway linking large towns.
primary_linkLink roads/lanes connecting to primary roads.
secondaryA highway linking large towns.
secondary_linkLink roads/lanes connecting to secondary roads.
tertiaryA road linking small settlements, or the local centers of a large town or city.
tertiary_linkLink roads/lanes connecting to tertiary roads.
streetStandard unclassified, residential, road, and living_street road types.
street_limitedStreets that may have limited or no access for motor vehicles.
pedestrianIncludes pedestrian streets, plazas, and public transportation platforms.
constructionIncludes motor roads under construction (but not service roads, paths, etc.).
trackRoads mostly for agricultural and forestry use.
serviceAccess roads, alleys, agricultural tracks, and other services roads. Also includes parking lot aisles, and public and private driveways.
ferryA boat that may take passengers on foot, in motor vehicles, or both.
pathFoot paths, cycle paths, ski trails.
major_railRailways, including mainline, commuter rail, and rapid transit.
minor_railIncludes light rail and tram lines.
service_railYard and service railways.
aerialwaySki lifts, gondolas, and other types of aerialway.
golfThe approximate center line of a golf course hole.
junction(point) Road junction.
roundabout(point) Circular continuous-flow intersection.
mini_roundabout(point) Smaller variation of a roundabout with no center island or obstacle.
turning_circle(point) Widened section at the end of a cul-de-sac for turning around a vehicle.
turning_loop(point) Like a turning circle but with an island or other obstruction at the centerpoint.
traffic_signals(point) Lights or other signal controlling traffic flow at an intersection.
level_crossing(point) Where a road crosses a railway on the same level (not a bridge).
intersection(point) Indicating the class and type of roads meeting at an intersection. Intersections are only available in Japan.

oneway text {#road-oneway-text}

The oneway field indicates whether the motor traffic on the road is one-way or not. If the road is one-way, traffic travels in the same direction as the linestring. The value is always either true or false (never null).

structure text {#road-structure-text}

The structure field describes whether the road segment is a bridge, tunnel, ford, or none of those. No further values will be added in Mapbox Streets v8.

bike_lane text {#road-bike_lane-text}

The bike_lane field indicates if there is a bike lane that is part of the road itself. This is different from separated cycle tracks, which are mapped as their own object in the roads layer, and receive class=path, type=cycleway.

This value may be null where explicit bike lane details are unknown.

ValueDescription
yesBike lane present, side of road not specified.
leftBike lane present on the left side of the road.
rightBike lane present on the right side of the road.
bothBike lane present on both sides of the road.
noRoad has no bike lane.

iso_3166_1 text {#road-iso_3166_1-text}

The iso_3166_1 field contains the ISO 3166-1 alpha-2 code of the country the road is in. The value may be null, either due to location match errors or for features that are in international waters.

iso_3166_2 text {#road-iso_3166_2-text}

The ISO 3166-2 code of the state/province/region the road is in. Not all areas are covered by this standard and the value may be null.

toll text

The toll field is true for toll roads and not present / null for all other roads.

ref text and reflen number {#road-ref-text-and-reflen-number}

Besides the standard name fields, there is also a ref field that holds any reference codes or route numbers a road may have.

The reflen value indicates how many characters are in the corresponding ref to help choose an appropriate size of shield graphic. The valid range is 2-6 but more detailed ranges for specific shield designs are noted below. Note that ref values with a single character are assigned a reflen value of 2 to reduce the number of required shield graphics.

From zoom levels 6 through 10, ref values are attached to separate points rather than lines to optimize symbol placement.

Both ref and reflen may be null.

shield text {#road-shield-text}

The shield values help to assign highway shield graphics. They should be combined with ref for the text on the shield and reflen to determine the width of shield image needed. The shield-text-color field can be used for styling the shield text.

Routes that can be symbolized with shields of a common shape and color have generic shared shield values:

Valuereflen rangeDescription
default2-6No specific shield design suggested.
rectangle-white2-6
rectangle-red2-6
rectangle-orange2-6
rectangle-yellow2-6
rectangle-green2-6
rectangle-blue2-6
circle-white2-6

Other highways with more specific shield design requirements are captured individually:

Valuereflen rangeDescription
ae-national3-4United Arab Emirates national routes
ae-d-route3-4UAE Dubai D-routes
ae-f-route3UAE Fujairah F-routes
ae-s-route4UAE Sharjah S-routes
au-national-highway2-3Australia national highways
au-national-route2-6Australia national routes
au-state2-6Australia state roads
au-tourist2-3Australia tourist routes
br-federal3Brazil federal highways
br-state2-3Brazil state highways
ch-motorway2-3Switzerland motorways
cn-nths-expy3-5China national expressway
cn-provincial-expy3-5China provincial/regional expressway
de-motorway2-3Germany motorways (Autobahnen)
gr-motorway2-4Greece motorways
hk-strategic-route2Hong Kong strategic routes
hr-motorway3-4Croatia motorways
hu-motorway2-3Hungary motorways
hu-main2-5Hungary main roads
in-national2-4India national highways and expressways
in-state2-3India state highways
kr-natl-expy2-3South Korea national expressways
kr-natl-hwy2South Korea national highways
kr-metro-expy2-3South Korea metropolitan expressways
kr-metropolitan2-6South Korea metropolitan routes
kr-local2-6South Korea local routes
mx-federal2-4Mexico federal highways
mx-state2-4Mexico state highways
nz-state2-3New Zealand state highways
pe-national2-3Peru national highways
pe-regional3-4Peru departmental / regional highways
ro-national2-3Romania national roads
ro-county3-4Romania county roads
ro-communal2-4Romania communal roads
si-motorway2Slovenia motorways
tw-national2Taiwan national routes
tw-provincial-expy2Taiwan provincial expressways
tw-provincial2Taiwan provincial routes
tw-county-township2-6Taiwan county / township routes
us-interstate2-4US Interstates
us-interstate-duplex4-5US Interstates - segment shared by 2 route numbers
us-interstate-business2-3US Interstates - business routes
us-interstate-truck2-3US Interstates - truck routes
us-highway2-4US highways
us-highway-duplex3-5US highways - segment shared by 2 route numbers
us-highway-alternate2-3US highways - alternate routes
us-highway-business2-3US highways - business routes
us-highway-bypass2-3US highways - bypasses
us-highway-truck2-3US highways - truck routes
us-bia2-4US BIA Indian routes
za-national2-3South Africa national routes
za-provincial2South Africa provincial routes

The shield value is null where ref is also null. No further shield values will be added in Mapbox Streets v8.

shield_text_color text

Used to style the text on the highway shield icon.

Possible values:

black
blue
white
yellow
orange

type text {#road-type-text}

The type field is the value of the road's "primary" OpenStreetMap tag. For most roads this is the highway tag, but for aerialways it is the aerialway tag, and for golf holes it is the golf tag. See TagInfo for a list of used tag values. Several classes pull in additional detail when it is available from OpenStreetMap.

Possible construction class type values:

construction:motorway
construction:motorway_link
construction:trunk
construction:trunk_link
construction:primary
construction:primary_link
construction:secondary
construction:secondary_link
construction:tertiary
construction:tertiary_link
construction:unclassifed
construction:residential
construction:road
construction:living_street
construction:pedestrian
construction

Possible track class type values:

track:grade1
track:grade2
track:grade3
track:grade4
track:grade5
track

Possible service class type values:

service:alley
service:emergency_access
service:drive_through
service:driveway
service:parking
service:parking_aisle
service

For the path class, the tileset made custom type assignments based on insight from various categorical, physical, and access tags from OpenStreetMap.

ValueDescription
stepsStairs
corridorAn indoors passageway
sidewalkAlso called pavement in many places outside North America
crossingUsually connects sidewalk lines across a road
pisteSki and snowboard trails, both downhill and cross-country
mountain_bikeTrails used primarily or only for mountain biking
hikingHiking trails or otherwise rough pedestrian paths
trailMay be suitable for either hiking or mountain biking
cyclewayPaths primarily or only for cyclists
footwayPaths primarily or only for pedestrians
pathUnspecified or mixed-use paths
bridlewayEquestrian trails

Possible ferry class type values:

ValueDescription
ferry_autoFerry serves automobiles
ferryNo or unspecified automobile service

Possible aerialway class type values:

ValueDescription
aerialway:cablecarOne or two large cars. The cable forms a loop, but the cars do not loop around, they move up and down on their own side.
aerialway:gondolaMany cars on a looped cable.
aerialway:mixed_liftMix of chair lifts and gondolas on the same line; may change seasonally.
aerialway:chair_liftLooped cable with a series of single chairs and exposed to the open air.
aerialway:drag_liftIncludes t-bars, j-bars, platter/button lifts, and tow ropes.
aerialway:magic_carpetConveyor belt installed at the level of the snow, some include a canopy or tunnel.
aerialwayOther or unspecified type of aerialway.

class and type mapping for Zenrin data in Japan:

Zenrin elcode digit 2Zenrin elcode digit 4Mapbox classMapbox type
Urban ExpresswayMain Line (Divided) Linkmotorwayurban_expressway
ExpresswayMain Line (Divided) Linkmotorwayexpressway
National RouteMain Line (Divided) Linkmotorwaynational_route
Crossingpathcrossing
Main Local RoadMain Line (Divided) Linkprimarymain_local_road
Main Local RoadMain Line (Undivided) Linkprimarymain_local_road
Main Local RoadSide road with same route with main lineprimarymain_local_road
Main Local RoadOthersprimarymain_local_road
Main Local RoadRamp Linkprimary_linkmain_local_road
General StreetRamp Linkresidential_linkgeneral_street
General prefectural RoadMain Line (Undivided) Linksecondarygeneral_prefectural_road
General prefectural RoadOtherssecondarygeneral_prefectural_road
General prefectural RoadMain Line (Divided) Linksecondarygeneral_prefectural_road
General prefectural RoadRamp Linksecondary_linkgeneral_prefectural_road
National RouteService road, for example SA linkservicenational_route
Urban ExpresswayService road, for example SA linkserviceurban_expressway
Thin RoadOthersstreetthin_road
General StreetMain Line (Divided) Linkstreetgeneral_street
General StreetMain Line (Undivided) Linkstreetgeneral_street
General StreetOthersstreetgeneral_street
General StreetRoundaboutstreetgeneral_street
Thin RoadMain Line (Undivided) Linkstreet_limitedthin_road
Major general streetMain Line (Undivided) Linktertiarymajor_general_street
Major general streetMain Line (Divided) Linktertiarymajor_general_street
Major general streetOtherstertiarymajor_general_street
Major general streetRamp Linktertiary_linkmajor_general_street
National RouteOtherstrunknational_route
National RouteMain Line (Undivided) Linktrunknational_route
National RouteSide road with same route with main linetrunknational_route
National RouteJunction Link (between Main Line)trunk_linknational_route
Urban ExpresswayRamp Linktrunk_linkurban_expressway
ExpresswayJunction Link (between Main Line)trunk_linkexpressway
ExpresswayRamp Linktrunk_linkexpressway
Urban ExpresswayJunction Link (between Main Line)trunk_linkurban_expressway
National RouteRamp Linktrunk_linknational_route

layer number

The layer field is used to determine drawing order of overlapping road segments in the tunnel and bridge layers. The value may be any integer number, but 95% of values are -1, 1, or 0, and 99.9999% of values are between -5 and 5.

len number {#road-len-number}

The len field stores the length of the road segment in projected meters, rounded to the nearest whole number. This can be useful for limiting some label styles to longer roads. The value may be null where the geometry is not a line.

lane_count number {#road-lane_count-number}

The lane_count field stores the count of lanes present in the road. These values are available only in Japan between zoom 12 and zoom 14. The value may be null.

structure

markerpolylinepolygonmin zoom level: 13buffer: 4

This layer includes points, lines and polygons for structures which are not buildings. This includes both natural and human features, like cliffs, walls, piers, gates, steps, and towers.

Cliff data is designed such that the left-hand side of the line is the top of the cliff, and the right-hand side is the bottom.

Steps and tower data is only available in Japan.

class text {#structure-class-text}

ValueDescription
cliffThe precipice of a vertical or steep drop, gullies are included
crosswalkPedestrian crossings that are points
entranceBuilding entrances and entrances to enclosed areas
fenceInclude various types of fence and wall barriers
gateGates that are points, lines or areas are included
hedgeA line of closely spaced shrubs and tree species, which form a barrier or mark the boundary of an area
landIncludes breakwaters and piers
stepsLineStrings representing outline of steps
towerLineStrings representing outline of manufactured non-buildings such as power towers

type text {#structure-type-text}

The type field contains the original value of the feature's primary tag from OpenStreetMap.

transit_stop_label

markerpolylinepolygonmin zoom level: 11buffer: 64

The transit_stop_label contains points for symbolizing transit stops, stations, and associated features such as entrances.

See names and name_script for information about names and translations available for label text.

stop_type text {#transit_stop_label-stop_type-text}

ValueDescription
stationUsed as the standard stop type for most rail and ferry modes. For buses and trams, stations represent centralized hubs.
stopUsed for bus and tram modes as the standard stop type. They are generally more frequently-spaced than stations and may need smaller symbols/text.
entranceSpecific entry points to a station.

mode text {#transit_stop_label-mode-text}

ValueDescription
railNational, regional, or commuter rail systems.
metro_railUrban rapid transit systems with dedicated rights of way, sometimes partially or fully underground.
light_railLess capacity than heavy/metro rail. Often on tracks separated from motor traffic but may share grade at intersections.
tramLighter rail with 1 or 2 carriages, often on a tracks shared with motor vehicle traffic.
monorailOften medium-low capacity and with localized or private use such as in theme parks or airports.
funicularCable-driven inclined railways. Often touristic and low-capacity.
bicycleFor bicycle rental docks/stations.
busFor bus stops or stations.
ferryA boat that may take passengers on foot, in motor vehicles, or both.

maki text {#transit_stop_label-maki-text}

The maki field lets you assign icons to the rail station based on a few basic station types. See maki in the Common Fields section for more information.

ValueDescription
bicycle-shareFor bicycle rental docks/stations
busBus stop or station
ferryFerry terminal
railDefault rail station
rail-metroStation for a subway, metro, or other rapid-transit system
rail-lightLight rail station
entranceSpecific station entrance points (for example stairs, escalators, elevators)

network text

The network field lets you assign more specific icons for rail stations that are part of specific local or regional transit systems. They don't necessarily correspond to a specific network - for example de-u-bahn applies to any U-Bahn network in Germany since these can all use the same icon in a map style. Some stations serve multiple networks. in these cases, multiple network names are joined with a dot in alphabetical order.

If none of the specific networks below apply to a station, the network value is the same as the maki value (see previous section).

ValueDescription
barcelona-metroBarcelona, Spain
boston-tBoston, Massachusetts
chongqing-rail-transitChongqing, China
de-s-bahnGermany
de-s-bahn.de-u-bahnGermany
de-u-bahnGermany
delhi-metroDelhi, India
gb-national-railLondon, United Kingdom
gb-national-rail.london-dlrLondon, United Kingdom
gb-national-rail.london-dlr.london-overground.london-tfl-rail.london-undergroundLondon, United Kingdom
gb-national-rail.london-dlr.london-overground.london-undergroundLondon, United Kingdom
gb-national-rail.london-dlr.london-undergroundLondon, United Kingdom
gb-national-rail.london-overgroundLondon, United Kingdom
gb-national-rail.london-overground.london-tfl-rail.london-undergroundLondon, United Kingdom
gb-national-rail.london-overground.london-undergroundLondon, United Kingdom
gb-national-rail.london-tfl-railLondon, United Kingdom
gb-national-rail.london-tfl-rail.london-overgroundLondon, United Kingdom
gb-national-rail.london-tfl-rail.london-undergroundLondon, United Kingdom
gb-national-rail.london-undergroundLondon, United Kingdom
hong-kong-mtrHong Kong
kiev-metroKiev, Ukraine
london-dlrDocklands Light Rail, London, United Kingdom
london-dlr.london-tfl-railLondon, United Kingdom
london-dlr.london-tfl-rail.london-undergroundLondon, United Kingdom
london-dlr.london-undergroundLondon, United Kingdom
london-overgroundLondon Overground, United Kingdom
london-overground.london-tfl-railLondon Overground, United Kingdom
london-overground.london-tfl-rail.london-undergroundLondon Overground, United Kingdom
london-overground.london-undergroundLondon, United Kingdom
london-tfl-railLondon, United Kingdom
london-tfl-rail.london-undergroundLondon, United Kingdom
london-undergroundLondon Underground, United Kingdom
madrid-metroMadrid, Spain
mexico-city-metroMexico City, Mexico
milan-metroMilan, Italy
moscow-metroMoscow Metro, Russia
new-york-subwayNew York City, New York
osaka-subwayOsaka, Japan
oslo-metroOslo, Norway
paris-metroParis Metro, France
paris-rerParis regional commuter rail, France
paris-metro.paris-rerParis, France
paris-rer.paris-transilienParis, France
paris-transilienParis suburban rail, France
philadelphia-septaPhiladelphia, Pennsylvania
san-francisco-bartSan Francisco, California
singapore-mrtSingapore
stockholm-metroStockholm, Sweden
taipei-metroTaipei, Taiwan
tokyo-metroTokyo, Japan
vienna-u-bahnVienna, Austria
washington-metroWashington DC Metro

No further network values will be added in Mapbox Streets v8.

network_beta text {#transit_stop_label-network_beta-text}

network values that might be supported in future versions of Mapbox Streets. Possible values include, but not limited to:

jp-shinkansen
jp-shinkansen.jp-jr
jp-shinkansen.tokyo-metro
jp-shinkansen.osaka-subway
jp-shinkansen.jp-jr.tokyo-metro
jp-shinkansen.jp-jr.osaka-subway
jp-jr
jp-jr.tokyo-metro
jp-jr.osaka-subway

filterrank text {#transit_stop_label-filterrank-text}

See filterrank for information on using this field.

water

markerpolylinepolygonmin zoom level: 0buffer: 8

This layer includes all types of bodies of water, including oceans, rivers, lakes, ponds, reservoirs, fountains, and more.

It is a polygon layer with no differentiating types or classes, and consists of a single merged shape per tile. This allows for seamless stroke and transparency styling, but means there is no way to filter out or highlight specific water bodies or a partial subset of them.

Each zoom level includes a set of water bodies that has been filtered and simplified according to scale. The tileset shows only oceans, seas, and large lakes at the lowest zoom levels, while smaller lakes and ponds appear when zoomed in.

waterway

markerpolylinepolygonmin zoom level: 7buffer: 4

The waterway layer contains classes for rivers, streams, canals, etc. represented as lines. These classes can represent a wide variety of possible widths. Since larger rivers and canals are usually also represented by polygons in the water layer, line styling should be biased toward the smaller end of the scales. The waterway layer should also be under the water layer.

class text and type text {#waterway-class-text-and-type-text}

The waterway layer has two fields for styling, class and type, each with similar values.

ValueDescription
riverAll rivers, from the Amazon to small creeks a few meters wide.
canalMedium to large artificial waterway.
streamSmall waterway, usually no wider than 1-2 meters.
stream_intermittentClass only. A stream that does not always have water flowing through it.
drainMedium to small artificial channel for rainwater drainage, often concrete lined.
ditchSmall artificial channel dug in the ground for rainwater drainage.

Changelog

Migration guide
For more detailed guidance on migrating an existing style from Mapbox Streets v7 to Streets v8, see the Migrate from Mapbox Streets v7 to v8 guide.

Japan update

Mapbox extended the v8 schema to support new data sources in Japan, USA, Canada, Australia, UAE, Uganda, and Tanzania.

As part of the update, the schema contains new values that allow you to tailor your map better to new geographies such as Japan.

  • New field for multiple layers:
    • worldview - provides the option to tailor features to preferences of audiences in different locales. Now included for the following layers: admin, airport_label, natural_label, place_label.

airport_label layer:

  • New field: class

building layer:

  • The type field is bounded to only the most common type values and contains additional types as translated from Zenrin.

landuse layer:

  • The class and type fields contain additional values as translated from Zenrin.

poi_label layer:

  • The type field contains additional types as translated from Zenrin annotation codes.
  • New field maki_modifier can be used to switch localization of Maki.
  • New field maki_beta that stores Maki values that might be supported in future Mapbox Streets versions.
  • New field brand can be used to assign more specific icons to POIs.

road layer:

  • The type field contains additional types specific to Japan.
  • New field: toll

place_label layer:

  • New field: iso_3166_2

motorway_junction layer:

  • New field: maki_beta that stores Maki values that might be supported in the future.
  • New field: filterrank

transit_stop_label layer:

  • New field: network_beta that stores network values that might be supported in the future.
  • New field: filterrank

Changes between v7 and v8

The layers and properties in Mapbox Streets v8 have undergone a major reorganization to optimize for styling with the latest features in Mapbox Studio such as expressions. We've also expanded coverage of feature types and properties for styling, with a particular emphasis on labels and icons.

  • 3 new layer names:
  • 9 removed layer names. The data from these layers have moved into other layers as noted here:
  • New ranking fields for label layers:
  • Name fields:
    • Translated name fields (name_en, name_fr, etc.) now contains null values where no translation is available, rather than falling back to name. This allows you to customize fallback preferences using Mapbox GL expressions.
    • name_zh field removed and replaced by name_zh-Hant (traditional Chinese)
    • New field: name_script indicates the primary script used in the name field (Latin, Cyrillic, etc)
  • admin layer:
    • Data source has changed to match Mapbox Enterprise Boundaries
    • The admin_level now has a range of 0 through 2 with slightly different division definitions compared to v7 - see boundaries section below for details.
    • The disputed and maritime fields now have text values of true or false rather than numeric 1 and 0
  • aeroway layer:
    • New field: ref indicates the runway or taxiway identifier
  • place_label layer:
    • New fields:
      • iso_3166_1: indicates the 2-letter country/territory code of the place or the country that the place is within.
      • class: useful for grouping places. One of: country, state, settlement (includes type=city, town, village, hamlet), or settlement_subdivision (includes type=suburb, quarter, neighbourhood).
      • symbolrank and filterrank: see description in table
      • text_anchor: replaces ldir
      • abbr: provides the abbreviation for places with type state
    • Added support for OpenStreetMap place=quarter
    • Several feature types have moved to either poi_label or natural_label
  • poi_label layer:
    • New fields:
      • category_en / category_zh-Hans: contains POI category description for text display in English / simplified Chinese
      • class: contains broad categories useful for filtering and symbol styling
      • filterrank: see description in table
    • Many new maki values
    • Many new feature types added
  • road layer:
    • New fields:
      • Fields from former road_label layer: names, ref, reflen, len, shield, iso_3166_2
      • iso_3166_1: indicates the ISO 3166-1 2-letter country code of the road.
      • shield-text-color: indicates the color to use for the highway shield text.
      • toll: true for toll roads and not present / null for all other roads.
      • surface: indicates either paved or unpaved where this data is available from OpenStreetMap.
      • bike_lane: indicates presence and location of a bike lane that is part of the road itself (as opposed to a separated bike lane).
    • New class values:
      • service_rail - includes service tracks such as sidings or yard rails. These were included in the minor_rail class.
      • link has been removed and broken out into trunk_link, primary_link, secondary_link, tertiary_link
    • Previous road_label layer is now merged into road layer, with all label fields included: len, ref, reflen, and shield.
  • transit_stop_label layer:
    • Replaces the railway_station_label layer from v7 and includes some new features such as bus stops (new), ferry terminals, and bikeshare stations (originally in the poi_label layer).
    • New fields:
      • mode: provides more detail about the particular mode of transport served by a stop/station
      • stop_type: value is one of: stop, station, entrance
Was this page helpful?