Available endpoints¶
If you visit the server on the configured port (default 8080) you can see your maps appearing in the browser.
Styles¶
Styles are served at
/styles/{id}/style.json
(+ array at/styles.json
)Sprites at
/styles/{id}/sprite[@2x].{format}
Fonts at
/fonts/{fontstack}/{start}-{end}.pbf
Rendered tiles¶
Rendered tiles are served at
/styles/{id}/{z}/{x}/{y}[@2x].{format}
The optional
@2x
(or@3x
,@4x
) part can be used to render HiDPI (retina) tilesAvailable formats:
png
,jpg
(jpeg
),webp
TileJSON at
/styles/{id}.json
The rendered tiles are not available in the
tileserver-gl-light
version.
WMTS Capabilities¶
WMTS Capabilities are served at
/styles/{id}/wmts.xml
Static images¶
Several endpoints:
/styles/{id}/static/{lon},{lat},{zoom}[@{bearing}[,{pitch}]]/{width}x{height}[@2x].{format}
(center-based)/styles/{id}/static/{minx},{miny},{maxx},{maxy}/{width}x{height}[@2x].{format}
(area-based)/styles/{id}/static/auto/{width}x{height}[@2x].{format}
(autofit path – see below)
All the static image endpoints additionally support following query parameters:
path
- comma-separatedlng,lat
, pipe-separated pairse.g.
5.9,45.8|5.9,47.8|10.5,47.8|10.5,45.8|5.9,45.8
can be provided multiple times
or pass the path as per [Maptiler Cloud API](https://docs.maptiler.com/cloud/api/static-maps/)
Match pattern: ((fill|stroke|width):[^|]+|)*((enc:.+)|((-?d+.?d*,-?d+.?d*|)+(-?d+.?d*,-?d+.?d*)))
latlng
- indicates coordinates are inlat,lng
order rather than the usuallng,lat
fill
- color to use as the fill (e.g.red
,rgba(255,255,255,0.5)
,#0000ff
)stroke
- color of the path strokewidth
- width of the strokelinecap
- rendering style for the start and end points of the pathlinejoin
- rendering style for overlapping segments of the path with differing directionsborder
- color of the optional border path strokeborderwidth
- width of the border stroke (default 10% of width)marker
- Marker in formatlng,lat|iconPath|option|option|...
Will be rendered with the bottom center at the provided location
lng,lat
andiconPath
are mandatory and icons won’t be rendered without themiconPath
is either a link to an image served via http(s) or a path to a file relative to the configured icon pathoption
must adhere to the formatoptionName:optionValue
and supports the following namesscale
- Factor to scale image bye.g.
0.5
- Scales the image to half it’s original size
offset
- Image offset as positive or negative pixel value in format[offsetX],[offsetY]
scales with
scale
parameter since image placement is relative to it’s sizee.g.
2,-4
- Image will be moved 2 pixel to the right and 4 pixel in the upwards direction from the provided location
e.g.
5.9,45.8|marker-start.svg|scale:0.5|offset:2,-4
can be provided multiple times
padding
- “percentage” padding for fitted endpoints (area-based and path autofit)value of
0.1
means “add 10% size to each side to make sure the area of interest is nicely visible”
maxzoom
- Maximum zoom level (only for auto endpoint where zoom level is calculated and not provided)
You can also use (experimental)
/styles/{id}/static/raw/...
endpoints with raw spherical mercator coordinates (EPSG:3857) instead of WGS84.The static images are not available in the
tileserver-gl-light
version.
Source data¶
Source data are served at
/data/{mbtiles}/{z}/{x}/{y}.{format}
Format depends on the source file (usually
png
orpbf
)geojson
is also available (useful for inspecting the tiles) in case the original format ispbf
TileJSON at
/data/{mbtiles}.json
TileJSON arrays¶
Array of all TileJSONs is at /index.json
(/rendered.json
; /data.json
)
List of available fonts¶
Array of names of the available fonts is at /fonts.json
Health check¶
Endpoint reporting health status is at /health
and currently returns:
503
Starting - for a short period before everything is initialized
200
OK - when the server is running