docs.maptiler.com
Open in
urlscan Pro
2606:4700::6811:873c
Public Scan
Submitted URL: http://api.maptiler.com/
Effective URL: https://docs.maptiler.com/cloud/api/
Submission: On May 11 via manual from US — Scanned from DE
Effective URL: https://docs.maptiler.com/cloud/api/
Submission: On May 11 via manual from US — Scanned from DE
Form analysis
0 forms found in the DOMText Content
Products CLOUD Map hosting service DESKTOP Create zoomable maps ENGINE Fast automated map processing DATA Global geodata for self-hosting SERVER Map server for self-hosting MOBILE Phone & tablet mapping app Solutions By use-case Maps API Geocoding Map customize tool Data processing Geodata hosting Map self-hosting By industry Transportation Weather Business Intelligence News & Media Government Docs News Cloud Data Server Desktop Engine Mobile News Docs Team Press Jobs SOLUTIONS By use-case Maps API Geocoding Map customize tool Data processing Geodata hosting Map self-hosting By industry Transportation Weather Business Intelligence News & Media Government My Cloud My Cloud * Authentication * Maps * getEmbeddable HTML viewer * getStyle JSON of the map * getMap symbols (sprites) * getRaster XYZ tiles * getTileJSON * getWMTS Capabilities * Static maps * getCenter-based image * getBounds-based image * getAuto-fitted image * Tiles * getEmbeddable HTML viewer * getXYZ tiles * getTileJSON * getWMTS Capabilities * Data * getGeoJSON * Geocoding * getSearch by name (forward) * getSearch by coordinates (reverse) * Other * getFont glyphs Documentation Powered by ReDoc MAPTILER CLOUD API (1.0) Support: support@maptiler.com URL: https://support.maptiler.com Terms of Service API reference for the MapTiler Cloud services. Create a free account at https://cloud.maptiler.com/. You need an API key to use the services (passed as a query parameter). AUTHENTICATION KEY Your own API key from https://cloud.maptiler.com/ Security Scheme Type API Key Query parameter name: key MAPS EMBEDDABLE HTML VIEWER AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. RESPONSES 200 get/maps/{mapId}/ MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/ STYLE JSON OF THE MAP Style JSON describing the map cartography. Can be used with various libraries to display a vector map (e.g. Mapbox GL JS, OpenLayers, ...). AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. RESPONSES 200 get/maps/{mapId}/style.json MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/style.json RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { } MAP SYMBOLS (SPRITES) Map symbols (sprites) required to display the vector map. PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. scale required string Enum: "" "@2x" format required string Enum: "png" "json" RESPONSES 200 get/maps/{mapId}/sprite{scale}.{format} MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/sprite{scale}.{format} RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { } RASTER XYZ TILES Rasterized tiles (XYZ) of the map. Can be used with various libraries to display a raster map (e.g. Leaflet, OpenLayers, ...). It's usually better (if possible) to use the TileJSON rather than using the tile URL directly. AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. tileSize/ required string Enum: "" "256/" z required integer x required integer y required integer scale required string Enum: "" "@2x" Use "@2x" to get "retina"/HiDPI image. format required string Enum: "png" "jpg" "webp" The value depends on the Map settings. get/maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format} MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format} TILEJSON TileJSON describing the metadata of the map as well as link to the XYZ tiles. Can be used with various libraries to display a raster map (e.g. Leaflet, OpenLayers, ...). AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. tileSize/ required string Enum: "" "256/" RESPONSES 200 get/maps/{mapId}/{tileSize/}/tiles.json MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/{tileSize/}/tiles.json RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { } WMTS CAPABILITIES WMTS Capabilities XML document describing the metadata of the map as well as link to the XYZ tiles. Can be used with various GIS software (e.g. QGIS) to display the map. AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. RESPONSES 200 get/maps/{mapId}/WMTSCapabilities.xml MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/WMTSCapabilities.xml STATIC MAPS CENTER-BASED IMAGE Generates a raster image based on the specified center and zoom level. AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. lon required number Longitude of the center of the image. lat required number Latitude of the center of the image. zoom required integer Zoom level of the resulting image (integer). (In the tile pyramid based on 512x512 tiles.) width required integer Width of the image in pixels. height required integer Height of the image in pixels. scale required string Enum: "" "@2x" Use "@2x" to get "retina"/HiDPI image. format required string Enum: "png" "jpg" "webp" The value depends on the Map settings. QUERY PARAMETERS path string((fill|stroke|width)\:[^\|]+\|)*((enc:.+)|((-...Show pattern Define path(s) to be drawn on top of the map. Can be used multiple times. See https://support.maptiler.com/i26-static-maps-for-your-web. markers string((icon|anchor|scale)\:[^\|]+\|)*((-?\d+\.?\d*...Show pattern Define marker(s) to be drawn on top of the map. Can be used multiple times. See https://support.maptiler.com/i26-static-maps-for-your-web. latlng boolean Use [latitude, longitude] order for coordinates instead of [longitude, latitude]. attribution string Enum: "bottomright" "bottomleft" "topleft" "topright" "false" Changes the position of map attribution. If you disable the attribution make sure to display it in your application yourself (visibly). fill string Deprecated Color to use as a fill when drawing polygons. Deprecated, use "path" instead. stroke string Deprecated Color to use as a stroke when drawing polygons. Deprecated, use "path" instead. width number Deprecated Width of the stroke line when drawing polygons (in pixels). Deprecated, use "path" instead. encodedpath string Deprecated Path in Google Encoded Polyline Format. Deprecated, use "path" instead. RESPONSES 200 400 Out of bounds / Invalid format 403 Key is missing, invalid or restricted 404 The item does not exist 414 URI Too Long. Maximum allowed length is 8192 bytes. get/maps/{mapId}/static/{lon},{lat},{zoom}/{width}x{height}{scale}.{format} MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/static/{lon},{lat},{zoom}/{width}x{height}{scale}.{format} BOUNDS-BASED IMAGE Generates a raster image based on the given bounds. The resulting zoom level is chosen so that the whole bounds are always visible (the zoom level is integer, so a little more than the bounds is usually visible). AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. minx required number Longitude of the left (west) edge. miny required number Latitude of the bottom (south) edge. maxx required number Longitude of the right (east) edge. maxy required number Latitude of the top (north) edge. width required integer Width of the image in pixels. height required integer Height of the image in pixels. scale required string Enum: "" "@2x" Use "@2x" to get "retina"/HiDPI image. format required string Enum: "png" "jpg" "webp" The value depends on the Map settings. QUERY PARAMETERS padding number Ensures the autofitted bounds or features are comfortably visible in the resulting area. E.g. use 0.1 to add 10% margin (at least) of the size to each side. path string((fill|stroke|width)\:[^\|]+\|)*((enc:.+)|((-...Show pattern Define path(s) to be drawn on top of the map. Can be used multiple times. See https://support.maptiler.com/i26-static-maps-for-your-web. markers string((icon|anchor|scale)\:[^\|]+\|)*((-?\d+\.?\d*...Show pattern Define marker(s) to be drawn on top of the map. Can be used multiple times. See https://support.maptiler.com/i26-static-maps-for-your-web. latlng boolean Use [latitude, longitude] order for coordinates instead of [longitude, latitude]. attribution string Enum: "bottomright" "bottomleft" "topleft" "topright" "false" Changes the position of map attribution. If you disable the attribution make sure to display it in your application yourself (visibly). fill string Deprecated Color to use as a fill when drawing polygons. Deprecated, use "path" instead. stroke string Deprecated Color to use as a stroke when drawing polygons. Deprecated, use "path" instead. width number Deprecated Width of the stroke line when drawing polygons (in pixels). Deprecated, use "path" instead. encodedpath string Deprecated Path in Google Encoded Polyline Format. Deprecated, use "path" instead. RESPONSES 200 400 Out of bounds / Invalid format 403 Key is missing, invalid or restricted 404 The item does not exist 414 URI Too Long. Maximum allowed length is 8192 bytes. get/maps/{mapId}/static/{minx},{miny},{maxx},{maxy}/{width}x{height}{scale}.{format} MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/static/{minx},{miny},{maxx},{maxy}/{width}x{height}{scale}.{format} AUTO-FITTED IMAGE Generates a raster image based on the given features. The area is calculated so that all the paths and markers given in query are visible. AUTHORIZATIONS: key PATH PARAMETERS mapId required string Example: streets Identifier of the map. See MapTiler Cloud Maps. height required integer Height of the image in pixels. height required integer Height of the image in pixels. scale required string Enum: "" "@2x" Use "@2x" to get "retina"/HiDPI image. format required string Enum: "png" "jpg" "webp" The value depends on the Map settings. QUERY PARAMETERS padding number Ensures the autofitted bounds or features are comfortably visible in the resulting area. E.g. use 0.1 to add 10% margin (at least) of the size to each side. path string((fill|stroke|width)\:[^\|]+\|)*((enc:.+)|((-...Show pattern Define path(s) to be drawn on top of the map. Can be used multiple times. See https://support.maptiler.com/i26-static-maps-for-your-web. markers string((icon|anchor|scale)\:[^\|]+\|)*((-?\d+\.?\d*...Show pattern Define marker(s) to be drawn on top of the map. Can be used multiple times. See https://support.maptiler.com/i26-static-maps-for-your-web. latlng boolean Use [latitude, longitude] order for coordinates instead of [longitude, latitude]. attribution string Enum: "bottomright" "bottomleft" "topleft" "topright" "false" Changes the position of map attribution. If you disable the attribution make sure to display it in your application yourself (visibly). fill string Deprecated Color to use as a fill when drawing polygons. Deprecated, use "path" instead. stroke string Deprecated Color to use as a stroke when drawing polygons. Deprecated, use "path" instead. width number Deprecated Width of the stroke line when drawing polygons (in pixels). Deprecated, use "path" instead. encodedpath string Deprecated Path in Google Encoded Polyline Format. Deprecated, use "path" instead. RESPONSES 200 400 Out of bounds / Invalid format 403 Key is missing, invalid or restricted 404 The item does not exist 414 URI Too Long. Maximum allowed length is 8192 bytes. get/maps/{mapId}/static/auto/{width}x{height}{scale}.{format} MapTiler Cloud API https://api.maptiler.com/maps/{mapId}/static/auto/{width}x{height}{scale}.{format} TILES EMBEDDABLE HTML VIEWER AUTHORIZATIONS: key PATH PARAMETERS tilesId required string Example: satellite Identifier of the tiles. See MapTiler Cloud Tiles. RESPONSES 200 get/tiles/{tilesId}/ MapTiler Cloud API https://api.maptiler.com/tiles/{tilesId}/ XYZ TILES The individual tiles. Can be used with various libraries to display the tiles (e.g. Leaflet, OpenLayers, ...). It's usually better (if possible) to use the TileJSON rather than using the tile URL directly. AUTHORIZATIONS: key PATH PARAMETERS tilesId required string Example: satellite Identifier of the tiles. See MapTiler Cloud Tiles. z required integer x required integer y required integer format required string RESPONSES 200 204 Tile not present -- presumed empty (empty response) 400 Out of bounds / Invalid format 403 Key is missing, invalid or restricted 404 The item does not exist get/tiles/{tilesId}/{z}/{x}/{y}.{format} MapTiler Cloud API https://api.maptiler.com/tiles/{tilesId}/{z}/{x}/{y}.{format} TILEJSON TileJSON describing the metadata of the tiles as well as link to the XYZ tiles. Can be used with various libraries to display the tiles (e.g. Leaflet, OpenLayers, ...). AUTHORIZATIONS: key PATH PARAMETERS tilesId required string Example: satellite Identifier of the tiles. See MapTiler Cloud Tiles. RESPONSES 200 get/tiles/{tilesId}/tiles.json MapTiler Cloud API https://api.maptiler.com/tiles/{tilesId}/tiles.json RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { } WMTS CAPABILITIES WMTS Capabilities XML document describing the metadata of the tiles as well as link to the XYZ tiles. Can be used with various GIS software (e.g. QGIS) to display the tiles. AUTHORIZATIONS: key PATH PARAMETERS tilesId required string Example: satellite Identifier of the tiles. See MapTiler Cloud Tiles. RESPONSES 200 get/tiles/{tilesId}/WMTSCapabilities.xml MapTiler Cloud API https://api.maptiler.com/tiles/{tilesId}/WMTSCapabilities.xml DATA GEOJSON GeoJSON containing the vector features. AUTHORIZATIONS: key PATH PARAMETERS dataId required string Identifier of the data. See MapTiler Cloud Datasets. RESPONSES 200 get/data/{dataId}/features.json MapTiler Cloud API https://api.maptiler.com/data/{dataId}/features.json RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { } GEOCODING SEARCH BY NAME (FORWARD) Forward geocoding (search by place name). AUTHORIZATIONS: key PATH PARAMETERS query required string Example: Zurich Place name to search for. QUERY PARAMETERS bbox string Example: bbox=5.9559,45.818,10.4921,47.8084 Only search for results in the specified area. Specified as "minx,miny,maxx,maxy". proximity string Example: proximity=8.528509,47.3774434 Prefer results close to a specific location. Specified as "longitude,latitude". language string Example: language=de,en Prefer results in specific language. It's possible to specify multiple values. RESPONSES 200 400 Query too long / Invalid parameters 403 Key is missing, invalid or restricted get/geocoding/{query}.json MapTiler Cloud API https://api.maptiler.com/geocoding/{query}.json RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { } SEARCH BY COORDINATES (REVERSE) Reverse geocoding (search by coordinates). AUTHORIZATIONS: key PATH PARAMETERS longitude required number Example: 8.528509 latitude required number Example: 47.3774434 QUERY PARAMETERS bbox string Example: bbox=5.9559,45.818,10.4921,47.8084 Only search for results in the specified area. Specified as "minx,miny,maxx,maxy". proximity string Example: proximity=8.528509,47.3774434 Prefer results close to a specific location. Specified as "longitude,latitude". language string Example: language=de,en Prefer results in specific language. It's possible to specify multiple values. RESPONSES 200 400 Query too long / Invalid parameters 403 Key is missing, invalid or restricted get/geocoding/{longitude},{latitude}.json MapTiler Cloud API https://api.maptiler.com/geocoding/{longitude},{latitude}.json RESPONSE SAMPLES * 200 Content type application/json Copy Expand all Collapse all { } OTHER FONT GLYPHS Generates the glyphs for the requested fonts. Used when displaying vector maps. AUTHORIZATIONS: key PATH PARAMETERS fontstack required string Font name, or more comma-separated names. start required integer multiple of 256 Start of the glyph range. end required integer End of the glyph range (last glyph index). RESPONSES 200 400 Invalid glyph range get/fonts/{fontstack}/{start}-{end}.pbf MapTiler Cloud API https://api.maptiler.com/fonts/{fontstack}/{start}-{end}.pbf