GuidesAPI Reference
Guides

transit

Content: default, Japan - core map
Geometry: line, polygon
Zoom: 6–17

📘

Note

The transit layer as a part of default content is deprecated in favour of a new transit layer.

The transit, v2 layer contains changes to the data model which is not compatible with the transit layer data model:

  • transit puts everything in one feature with parallel semicolon arrays;
  • transit, v2 emits multiple explicit features that are easier to render individually.
📘

Note

The transit layer features are currently available only for the Japan region as part of the core map parameter.

The transit layer provides information about public transportation systems, such as buses, trains, subways, and other modes of public transit. The features of this layer enable developers to integrate public transit data into applications or services, allowing users to plan routes, view schedules, and obtain real-time information about public transportation options.

Sample transit layer features in Tokyo

Transit line features become visible from zoom level 7 onwards, while platform polygons are added at zoom level 14 and higher. To optimize efficiency, features with the same line geometry, kind, and kind_detail are consolidated. This consolidation allows the storage of transit routes, colors, and color names in properties like all_ref, all_colour, and all_text_colour

Every feature in the transit layer includes a set of properties that define it, regardless of the specific transit type it represents.

Consider the following sample parameters for a transit feature in Japan:

...
"kind": "train",
"kind_detail": "intercity",
"min_zoom": 8,
"sort_rank": 436,
"all_ref": "東北本線;宇都宮線",
"all_ref:en": "Tohoku Line;Utsunomiya Line",
"all_ref:zh": "東北本線;宇都宮線",
"all_ref:ko": "도호쿠 본선;우쓰노미야 선",
"all_ref:ja": "東北本線;宇都宮線",
"all_colour": "#00BB85;#FF871C",
"all_direction": ";F",
"all_text_colour": "#00BB85;#FF871C",
"all_operator": "Main Line;Main Line",
...

Properties

kind | kind_detail | all_colour | all_direction | all_operator | all_ref | all_ref:{language_code} | height

Common properties

sort_rank | min_zoom

Common properties specific to Japan - core map

source


kind

Type: string
Always present

The general type of transit feature.

ValueGeometryZoomDescription
aerialline10–17A transportation system that operates above ground level, such as an aerial tramway or gondola.
funicularline10–17A transportation system that uses cable-operated cars on steep inclines.
light_railline10–17A type of urban rail transit that operates with light capacity and shares tracks with other vehicles. The actual sort_rank value depends on the specific kind_detail for this feature instance.
monorailline10–17A railway system where the trains run on a single rail.
subwayline10–17An underground or elevated railway system typically found in urban areas.
subway_station_platformpolygon14–17(sort_rank: 385) - Platform of a subway station.
trainline6–17A general term referring to a mode of transportation that runs on tracks, typically used for intercity or regional travel. The actual sort_rank value depends on the specific kind_detail for this feature instance.

kind_detail

Type: string
Present when kind is: aerial, funicular, light_rail, monorail, subway, train

This property provides additional details about the kind of transit feature. This parameter is relevant only within the context of the line geometry type.

ValueDescriptionAssociated kind
aerialDenotes aerial cable car or gondola lines for the aerial kind.aerial
funicularIndicates funicular lines for the funicular kind.funicular
high_speedIndicates high-speed railroad lines with the train kind.train
intercityRepresents intercity railroad lines with the train kind.train
monorailDenotes monorail lines for the monorail kind.monorail
regionalDenotes regional railroad lines with the train kind.train
suburbanIndicates suburban rail lines for the light_rail kind.light_rail
subwayRepresents subway lines for the subway kind.subway
tramRepresents tram lines for the light_rail kind.light_rail

all_colour

Type: string
Array
Optional

A semicolon-separated list of hex values representing the colors for the routes valid on this line. For example, all_colour=\"#00BB85;#FF871C\". The first color #00BB85 corresponds to the 東北本線 (Tohoku Line) route, and the second color #FF871C corresponds to the 宇都宮線 (Utsunomiya Line) route.


all_direction

Type: string
Array
Present when kind is: aerial, funicular, light_rail, monorail, subway, train

The parameter all_direction specifies all the directions of the routes that are valid on a particular line. The values are provided as semicolon-separated values. The following conventions are used:


all_operator

Type: string
Array
Optional

A semicolon-separated list of operator IDs for the routes valid on this line. For example, all_operator=\"Main Line;Main Line\". The first operator ID corresponds to the operator of the 東北本線 (Tohoku Line) route, and the second operator ID corresponds to the operator of the 宇都宮線 (Utsunomiya Line) route.


all_ref

Type: string
Array
Optional

A semicolon-separated list of all the routes valid on this transit feature. In the example, the train line has two routes: \"東北本線\" and \"宇都宮線\". This parameter is relevant only within the context of the line geometry type.


all_ref:{language_code}

Type: string
Optional


height

Type: float
Present when kind is: subway_station_platform · Present when zoom is: 14, 15, 16

Example values: 12.400000, 12.000000, 24.800000, 13.400000, 17.800000

Common properties


sort_rank

Type: int
Always present

The ordering of features, which determines which features are rendered "on top of" other features, can be an important issue when rendering maps. To assist map rendering, there is a sort_rank property on some features that suggests in what order the features should appear.

A feature with a higher sort_rank value is displayed on top of feature with a lower sort_rank value.


min_zoom

See min_zoom.

Common properties specific to Japan - core map


source

See source.