--- title: "MapTiler API Reference" description: "Reference documentation for the core MapTiler Cloud API services." --- > For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL. Scalar API Reference - Introduction - Maps Close Group - Embeddable HTML viewer HTTP Method:  GET - Style JSON of the map HTTP Method:  GET - Map symbols (sprites) HTTP Method:  GET - Raster XYZ tiles HTTP Method:  GET - TileJSON HTTP Method:  GET - OGC API \- Tiles HTTP Method:  GET - OGC API TileMatrixSets HTTP Method:  GET - WMTS Capabilities HTTP Method:  GET - Static maps Close Group - Center\-based image HTTP Method:  GET - Bounds\-based image HTTP Method:  GET - Auto\-fitted image HTTP Method:  GET - Tiles Close Group - Embeddable HTML viewer HTTP Method:  GET - XYZ tiles HTTP Method:  GET - TileJSON HTTP Method:  GET - OGC API \- Tiles HTTP Method:  GET - OGC API TileMatrixSets HTTP Method:  GET - WMTS Capabilities HTTP Method:  GET - Data Close Group - GeoJSON HTTP Method:  GET - Images Close Group - ImageJSON HTTP Method:  GET - XYZ tiles HTTP Method:  GET - Geocoding Close Group - Search by name (forward) HTTP Method:  GET - Search by coordinates (reverse) HTTP Method:  GET - Search by feature ID HTTP Method:  GET - Batch geocoding API HTTP Method:  GET - Geolocation Close Group - IP Geolocation HTTP Method:  GET - Coordinates Close Group - Search coordinate systems HTTP Method:  GET - Transform coordinates HTTP Method:  GET - Elevation Close Group - Get elevation HTTP Method:  GET - Weather Close Group - Weather catalog HTTP Method:  GET - Other Close Group - Sprites (icon sets) HTTP Method:  GET - Fonts (glyphs) HTTP Method:  GET - OGC API conformance classes HTTP Method:  GET [Powered by Scalar](https://www.scalar.com) v1.0 OpenAPI 3.1.0 # MapTiler API [Support](mailto:support@maptiler.com) [](https://docs.maptiler.com/support/requests/) [Terms of Service](https://www.maptiler.com/terms/) Download OpenAPI Document json Download OpenAPI Document yaml MapTiler API allows you to programmatically access all the data, maps, services, and resources available in your MapTiler account. Access to your resources via MapTiler API is read-only, and therefore safe and well suited for public end-user applications. You can use it to add a map directly to your website, request map tiles, create an image with a location map for your business, search for addresses, and more. The universal public API request format is: ```ini https://api.maptiler.com/{METHOD}/{QUERY}.json?{PARAMS}&key=YOUR_MAPTILER_API_KEY_HERE ``` 🔑 You need a **MapTiler API key** to use this service. [Get it here](https://cloud.maptiler.com/account/keys/) and [learn how to protect it](https://docs.maptiler.com/guides/maps-apis/maps-platform/how-to-protect-your-map-key/). Server Server:https://api.maptiler.com MapTiler API ## AuthenticationRequired Selected Auth Type: key Client Libraries Shell Ruby Node.js PHP Python MoreSelect from all clients Shell Curl ## Maps ​Copy link Maps Operations - get/maps/{mapId}/ - get/maps/{mapId}/style.json - get/maps/{mapId}/sprite{scale}.{format} - get/maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format} - get/maps/{mapId}/{tileSize/}/tiles.json - get/maps/{mapId}/tiles - get/maps/{mapId}/tileMatrixSet - get/maps/{mapId}/WMTSCapabilities.xml ### Embeddable HTML viewer ​Copy link Auth Required Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 text/html Request Example for get/maps/_{mapId}_/ Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/) Status: 200 No Body ### Style JSON of the map ​Copy link Auth Required Style JSON describing the map cartography. Can be used with various libraries to display a vector map (e.g. Mapbox GL JS, OpenLayers, ...). Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 application/json Request Example for get/maps/_{mapId}_/style.json Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/style.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/style.json) Status: 200 Show Schema ```json {} ``` Copy Copy deprecated ### Map symbols (sprites) ​Copy link Map symbols (sprites) required to display the vector map. **Deprecated:** use [Sprites API](https://docs.maptiler.com/cloud/api/other/GET/sprites/{spriteId}/sprite{scale}.{format}). Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - scaleCopy link to scale enum const:   @2x values - @2x - formatCopy link to format Type: string enum required values - png - json Responses - 200 Selected Content Type: application/json Request Example for get/maps/_{mapId}_/sprite_{scale}_._{format}_ Shell Curl ```curl curl https://api.maptiler.com/maps/streets-v4/sprite@2x.png ``` Copy Copy Test Request(get /maps/{mapId}/sprite{scale}.{format}) Status: 200 No Body ### Raster XYZ tiles ​Copy link Auth Required 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. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - tileSize/Copy link to tileSize/ enum const:   256 Integer numbers. values - 256 - zCopy link to z Type: integer required Zoom level. Specifies the tile's zoom level. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - xCopy link to x Type: integer required Column. Specifies the tile's column. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - yCopy link to y Type: integer required Row. Specifies the tile's row. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - scaleCopy link to scale enum const:   @2x Use "@2x" to get "retina"/HiDPI image. values - @2x - formatCopy link to format Type: string enum required values - png - jpg - webp - basis Responses - 200 image/\* - 400 Out of bounds / Invalid format Request Example for get/maps/_{mapId}_/_{tileSize/}_/_{z}_/_{x}_/_{y}__{scale}_._{format}_ Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/256/1/1/1@2x.png?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format}) Status: 200Status: 400 Show Schema ```json @filename ``` Copy Copy ### TileJSON ​Copy link Auth Required 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, ...). Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - tileSize/Copy link to tileSize/ enum const:   256 Integer numbers. values - 256 Responses - 200 application/json Request Example for get/maps/_{mapId}_/_{tileSize/}_/tiles.json Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/256/tiles.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/{tileSize/}/tiles.json) Status: 200 Show Schema ```json {} ``` Copy Copy ### OGC API - Tiles ​Copy link Auth Required Tileset landing page of the rasterized tiles. Can be used in software supporting the OGC API - Tiles v1.0 specification. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 application/json Request Example for get/maps/_{mapId}_/tiles Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/tiles?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/tiles) Status: 200 Show Schema ```json string ``` Copy Copy ### OGC API TileMatrixSets ​Copy link Auth Required Description of the tileset tile matrix sets according to the OGC Web API. This resource is linked from the OGC API - Tiles endpoint. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 application/json Request Example for get/maps/_{mapId}_/tileMatrixSet Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/tileMatrixSet?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/tileMatrixSet) Status: 200 Show Schema ```json string ``` Copy Copy ### WMTS Capabilities ​Copy link Auth Required 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. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 text/xml Request Example for get/maps/_{mapId}_/WMTSCapabilities.xml Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/WMTSCapabilities.xml?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/WMTSCapabilities.xml) Status: 200 Show Schema ```json string ``` Copy Copy ## Static maps ​Copy link Static maps Operations - get/maps/{mapId}/static/{lon},{lat},{zoom}/{width}x{height}{scale}.{format} - get/maps/{mapId}/static/{minx},{miny},{maxx},{maxy}/{width}x{height}{scale}.{format} - get/maps/{mapId}/static/auto/{width}x{height}{scale}.{format} ### Center-based image ​Copy link Auth Required Generates a raster image based on the specified center and zoom level. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - lonCopy link to lon Type: number required Longitude of the center of the image. - latCopy link to lat Type: number required Latitude of the center of the image. - zoomCopy link to zoom Type: number required Zoom level of the resulting image (can be fractional). (In the tile pyramid based on 512x512 tiles.) - widthCopy link to width Type: integer min:   1 max:   2048 required Width of the image in pixels. - heightCopy link to height Type: integer min:   1 max:   2048 required Height of the image in pixels. - scaleCopy link to scale enum const:   @2x Use "@2x" to get "retina"/HiDPI image. values - @2x - formatCopy link to format Type: string enum required values - png - jpg - webp Query Parameters - pathCopy link to path Type: string `[`Pattern: ((fill|stroke|width|shortest)\\:\[^\\|\]+\\|)\*((enc:.+)|((-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*\\|)+(-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*))) Define path(s) to be drawn on top of the map. Can be used multiple times. See [Static map with lines or polygons](https://docs.maptiler.com/guides/maps-apis/static-maps/static-map-with-lines/). - markersCopy link to markers Type: string `[`Pattern: ((icon|anchor|scale)\\:\[^\\|\]+\\|)\*((-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*(,\[^\\|\]+)?\\|)\*(-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*(,\[^\\|\]+)?)) Define marker(s) to be drawn on top of the map. Can be used multiple times. See [Static map with markers](https://docs.maptiler.com/guides/maps-apis/static-maps/static-map-with-markers/). - latlngCopy link to latlng Type: boolean Use \[latitude, longitude\] order for coordinates instead of \[longitude, latitude\]. - attributionCopy link to attribution Type: string enum Changes the position of map attribution. If you disable the attribution make sure to display it in your application yourself (visibly). values - bottomright - bottomleft - topleft - topright - false - fillCopy link to fill Type: string deprecated Color to use as a fill when drawing polygons. Deprecated, use "path" instead. - strokeCopy link to stroke Type: string deprecated Color to use as a stroke when drawing polygons. Deprecated, use "path" instead. - widthCopy link to width Type: number deprecated Width of the stroke line when drawing polygons (in pixels). Deprecated, use "path" instead. - encodedpathCopy link to encodedpath Type: string deprecated Path in [Google Encoded Polyline Format](https://developers.google.com/maps/documentation/utilities/polylinealgorithm). Deprecated, use "path" instead. - shortestCopy link to shortest Type: boolean Draw the shortest paths, allow to cross the dateline. Responses - 200 image/\* - 400 Out of bounds / Invalid format / Invalid image size - 403 Key is missing, invalid or restricted - 404 The item does not exist - 414 URI Too Long. Maximum allowed length is 8192 bytes. Request Example for get/maps/_{mapId}_/static/_{lon}_,_{lat}_,_{zoom}_/_{width}_x_{height}__{scale}_._{format}_ Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/static/1,1,1/1x1@2x.png?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/static/{lon},{lat},{zoom}/{width}x{height}{scale}.{format}) Status: 200Status: 400Status: 403Status: 404Status: 414 Show Schema ```json @filename ``` Copy Copy ### Bounds-based image ​Copy link Auth Required Generates a raster image based on the given bounds. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - minxCopy link to minx Type: number required Longitude of the left (west) edge. - minyCopy link to miny Type: number required Latitude of the bottom (south) edge. - maxxCopy link to maxx Type: number required Longitude of the right (east) edge. - maxyCopy link to maxy Type: number required Latitude of the top (north) edge. - widthCopy link to width Type: integer min:   1 max:   2048 required Width of the image in pixels. - heightCopy link to height Type: integer min:   1 max:   2048 required Height of the image in pixels. - scaleCopy link to scale enum const:   @2x Use "@2x" to get "retina"/HiDPI image. values - @2x - formatCopy link to format Type: string enum required values - png - jpg - webp Query Parameters - paddingCopy link to padding Type: 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. - pathCopy link to path Type: string `[`Pattern: ((fill|stroke|width|shortest)\\:\[^\\|\]+\\|)\*((enc:.+)|((-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*\\|)+(-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*))) Define path(s) to be drawn on top of the map. Can be used multiple times. See [Static map with lines or polygons](https://docs.maptiler.com/guides/maps-apis/static-maps/static-map-with-lines/). - markersCopy link to markers Type: string `[`Pattern: ((icon|anchor|scale)\\:\[^\\|\]+\\|)\*((-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*(,\[^\\|\]+)?\\|)\*(-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*(,\[^\\|\]+)?)) Define marker(s) to be drawn on top of the map. Can be used multiple times. See [Static map with markers](https://docs.maptiler.com/guides/maps-apis/static-maps/static-map-with-markers/). - latlngCopy link to latlng Type: boolean Use \[latitude, longitude\] order for coordinates instead of \[longitude, latitude\]. - attributionCopy link to attribution Type: string enum Changes the position of map attribution. If you disable the attribution make sure to display it in your application yourself (visibly). values - bottomright - bottomleft - topleft - topright - false - fillCopy link to fill Type: string deprecated Color to use as a fill when drawing polygons. Deprecated, use "path" instead. - strokeCopy link to stroke Type: string deprecated Color to use as a stroke when drawing polygons. Deprecated, use "path" instead. - widthCopy link to width Type: number deprecated Width of the stroke line when drawing polygons (in pixels). Deprecated, use "path" instead. - encodedpathCopy link to encodedpath Type: string deprecated Path in [Google Encoded Polyline Format](https://developers.google.com/maps/documentation/utilities/polylinealgorithm). Deprecated, use "path" instead. - shortestCopy link to shortest Type: boolean Draw the shortest paths, allow to cross the dateline. Responses - 200 image/\* - 400 Out of bounds / Invalid format / Invalid image size - 403 Key is missing, invalid or restricted - 404 The item does not exist - 414 URI Too Long. Maximum allowed length is 8192 bytes. Request Example for get/maps/_{mapId}_/static/_{minx}_,_{miny}_,_{maxx}_,_{maxy}_/_{width}_x_{height}__{scale}_._{format}_ Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/static/1,1,1,1/1x1@2x.png?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/static/{minx},{miny},{maxx},{maxy}/{width}x{height}{scale}.{format}) Status: 200Status: 400Status: 403Status: 404Status: 414 Show Schema ```json @filename ``` Copy Copy ### Auto-fitted image ​Copy link Auth Required 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. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - widthCopy link to width Type: integer min:   1 max:   2048 required Width of the image in pixels. - heightCopy link to height Type: integer min:   1 max:   2048 required Height of the image in pixels. - scaleCopy link to scale enum const:   @2x Use "@2x" to get "retina"/HiDPI image. values - @2x - formatCopy link to format Type: string enum required values - png - jpg - webp Query Parameters - paddingCopy link to padding Type: 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. - pathCopy link to path Type: string `[`Pattern: ((fill|stroke|width|shortest)\\:\[^\\|\]+\\|)\*((enc:.+)|((-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*\\|)+(-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*))) Define path(s) to be drawn on top of the map. Can be used multiple times. See [Static map with lines or polygons](https://docs.maptiler.com/guides/maps-apis/static-maps/static-map-with-lines/). - markersCopy link to markers Type: string `[`Pattern: ((icon|anchor|scale)\\:\[^\\|\]+\\|)\*((-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*(,\[^\\|\]+)?\\|)\*(-?\\d+\\.?\\d\*,-?\\d+\\.?\\d\*(,\[^\\|\]+)?)) Define marker(s) to be drawn on top of the map. Can be used multiple times. See [Static map with markers](https://docs.maptiler.com/guides/maps-apis/static-maps/static-map-with-markers/). - latlngCopy link to latlng Type: boolean Use \[latitude, longitude\] order for coordinates instead of \[longitude, latitude\]. - attributionCopy link to attribution Type: string enum Changes the position of map attribution. If you disable the attribution make sure to display it in your application yourself (visibly). values - bottomright - bottomleft - topleft - topright - false - fillCopy link to fill Type: string deprecated Color to use as a fill when drawing polygons. Deprecated, use "path" instead. - strokeCopy link to stroke Type: string deprecated Color to use as a stroke when drawing polygons. Deprecated, use "path" instead. - widthCopy link to width Type: number deprecated Width of the stroke line when drawing polygons (in pixels). Deprecated, use "path" instead. - encodedpathCopy link to encodedpath Type: string deprecated Path in [Google Encoded Polyline Format](https://developers.google.com/maps/documentation/utilities/polylinealgorithm). Deprecated, use "path" instead. - shortestCopy link to shortest Type: boolean Draw the shortest paths, allow to cross the dateline. Responses - 200 image/\* - 400 Out of bounds / Invalid format / Invalid image size - 403 Key is missing, invalid or restricted - 404 The item does not exist - 414 URI Too Long. Maximum allowed length is 8192 bytes. Request Example for get/maps/_{mapId}_/static/auto/_{width}_x_{height}__{scale}_._{format}_ Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/static/auto/1x1@2x.png?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/static/auto/{width}x{height}{scale}.{format}) Status: 200Status: 400Status: 403Status: 404Status: 414 Show Schema ```json @filename ``` Copy Copy ## Tiles ​Copy link Tiles Operations - get/tiles/{tilesId}/ - get/tiles/{tilesId}/{z}/{x}/{y} - get/tiles/{tilesId}/tiles.json - get/tiles/{tilesId}/tiles - get/tiles/{tilesId}/tileMatrixSet - get/tiles/{tilesId}/WMTSCapabilities.xml ### Embeddable HTML viewer ​Copy link Auth Required Path Parameters - tilesIdCopy link to tilesId Type: string required Example satellite-v4 Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/). Responses - 200 text/html Request Example for get/tiles/_{tilesId}_/ Shell Curl ```curl curl 'https://api.maptiler.com/tiles/satellite-v4/?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /tiles/{tilesId}/) Status: 200 No Body ### XYZ tiles ​Copy link Auth Required 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. Path Parameters - tilesIdCopy link to tilesId Type: string required Example satellite-v4 Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/). - zCopy link to z Type: integer required Zoom level. Specifies the tile's zoom level. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - xCopy link to x Type: integer required Column. Specifies the tile's column. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - yCopy link to y Type: integer required Row. Specifies the tile's row. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) Responses - 200 \* - 204 Tile not present -- presumed empty (empty response) - 400 Out of bounds - 403 Key is missing, invalid or restricted - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/_{z}_/_{x}_/_{y}_ Shell Curl ```curl curl 'https://api.maptiler.com/tiles/satellite-v4/1/1/1?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /tiles/{tilesId}/{z}/{x}/{y}) Status: 200Status: 204Status: 400Status: 403Status: 404 No Body ### TileJSON ​Copy link Auth Required 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, ...). Path Parameters - tilesIdCopy link to tilesId Type: string required Example satellite-v4 Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/). Responses - 200 application/json Request Example for get/tiles/_{tilesId}_/tiles.json Shell Curl ```curl curl 'https://api.maptiler.com/tiles/satellite-v4/tiles.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /tiles/{tilesId}/tiles.json) Status: 200 Show Schema ```json {} ``` Copy Copy ### OGC API - Tiles ​Copy link Auth Required Tileset landing page of the tiles. Can be used in software supporting the OGC API - Tiles v1.0 specification. Path Parameters - tilesIdCopy link to tilesId Type: string required Example satellite-v4 Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/). Responses - 200 application/json Request Example for get/tiles/_{tilesId}_/tiles Shell Curl ```curl curl 'https://api.maptiler.com/tiles/satellite-v4/tiles?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /tiles/{tilesId}/tiles) Status: 200 Show Schema ```json string ``` Copy Copy ### OGC API TileMatrixSets ​Copy link Auth Required Description of the tileset tile matrix sets according to the OGC Web API. This resource is linked from the OGC API - Tiles endpoint. Path Parameters - tilesIdCopy link to tilesId Type: string required Example satellite-v4 Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/). Responses - 200 application/json Request Example for get/tiles/_{tilesId}_/tileMatrixSet Shell Curl ```curl curl 'https://api.maptiler.com/tiles/satellite-v4/tileMatrixSet?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /tiles/{tilesId}/tileMatrixSet) Status: 200 Show Schema ```json string ``` Copy Copy ### WMTS Capabilities ​Copy link Auth Required 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. Path Parameters - tilesIdCopy link to tilesId Type: string required Example satellite-v4 Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/). Responses - 200 text/xml Request Example for get/tiles/_{tilesId}_/WMTSCapabilities.xml Shell Curl ```curl curl 'https://api.maptiler.com/tiles/satellite-v4/WMTSCapabilities.xml?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /tiles/{tilesId}/WMTSCapabilities.xml) Status: 200 Show Schema ```json string ``` Copy Copy ## Data ​Copy link Data Operations - get/data/{dataId}/features.json ### GeoJSON ​Copy link Auth Required GeoJSON containing the vector features. Path Parameters - dataIdCopy link to dataId Type: string required Identifier of the data. See [MapTiler Datasets](https://cloud.maptiler.com/data/). Responses - 200 application/json Request Example for get/data/_{dataId}_/features.json Shell Curl ```curl curl 'https://api.maptiler.com/data/{dataId}/features.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /data/{dataId}/features.json) Status: 200 Show Schema ```json {} ``` Copy Copy ## Images ​Copy link Images Operations - get/images/{imageId}/image.json - get/images/{imageId}/{z}/{x}/{y} ### ImageJSON ​Copy link Auth Required JSON describing the metadata of the image. Can be used with MapTiler SDK to display the image. Path Parameters - imageIdCopy link to imageId Type: string required Identifier of the image. Responses - 200 application/json Request Example for get/images/_{imageId}_/image.json Shell Curl ```curl curl 'https://api.maptiler.com/images/{imageId}/image.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /images/{imageId}/image.json) Status: 200 Show Schema ```json { "id": "string", "description": "string", "attribution": "string", "width": 1, "height": 1, "minzoom": 1, "maxzoom": 1, "tileSize": 1 } ``` JSONCopy JSONCopy ### XYZ tiles ​Copy link Auth Required The individual tiles. Can be used with various libraries to display the image. It's better to use the ImageJSON with MapTiler SDK rather than using the tile URL directly. Path Parameters - imageIdCopy link to imageId Type: string required Identifier of the image. - zCopy link to z Type: integer required Zoom level. Specifies the tile's zoom level. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - xCopy link to x Type: integer required Column. Specifies the tile's column. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - yCopy link to y Type: integer required Row. Specifies the tile's row. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) Responses - 200 \* - 204 Tile not present -- presumed empty (empty response) - 400 Out of bounds - 403 Key is missing, invalid or restricted - 404 The item does not exist Request Example for get/images/_{imageId}_/_{z}_/_{x}_/_{y}_ Shell Curl ```curl curl 'https://api.maptiler.com/images/{imageId}/1/1/1?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /images/{imageId}/{z}/{x}/{y}) Status: 200Status: 204Status: 400Status: 403Status: 404 No Body ## Geocoding ​Copy link Geocoding Operations - get/geocoding/{query}.json - get/geocoding/{longitude},{latitude}.json - get/geocoding/{id}.json - get/geocoding/{queries}.json ### Search by name (forward) ​Copy link Auth Required Forward [geocoding (search by place name)](https://www.maptiler.com/cloud/geocoding/). Path Parameters - queryCopy link to query Type: string required Examples Zurichrestaurant mediterranean Place name to search. You can also use bare [POI category](https://docs.maptiler.com/guides/location-services/geocoding-search/poi-category/) or mix it with a name to search for POIs of desired category, unless `poi` index is excluded. Query Parameters - bboxCopy link to bbox Type: array · bbox Example \[5.9559, 45.818, 10.4921, 47.8084\] Example 5.9559,45.818,10.4921,47.8084 A `[w, s, e, n]` bounding box array to use for limiting search results. Only features inside the provided bounding box will be included. - proximityCopy link to proximity A `[lon, lat]` array to use for biasing search results or the string `ip` to do server-side IP based geolocation. Specify to prefer results close to a specific location - features closer to the proximity value will be given priority over those further from the proximity value. Any ofCoordinates - Type: array · Coordinates Example \[8.528509, 47.3774434\] Example 8.528509,47.3774434 - languageCopy link to language Type: array string\[\] …20 unique!enum Example de,en Example de,en Prefer results in specific language specified as ISO 639-1 code. Only the first language code is used when prioritizing forward geocode results to be matched. If this query parameter is omited then Accept-Language HTTP header will be analyzed. If the parameter is provided but is empty then no language preference is made. values - aa - ab - ae - af - ak - Show all values - countryCopy link to country Type: array string\[\] unique! Example sk,cz Example sk,cz Limit search to specific country/countries. - limitCopy link to limit Type: integer min:   1 max:   10 Maximum number of results. Default: 5 for forward geocoding, 1 for reverse geocoding. For reverse geocoding, limit > 1 requires exactly one `types` value and switches to a nearest-neighbour search (N closest features of that type within 1 km). Without limit, reverse geocoding returns a single best match per layer at the queried point - typesCopy link to types Type: array string\[\] · PlaceType\[\] unique!enum Filter types of which features to return. If not specified, default configuration of API is used (see [PlaceTypeValues](https://docs.maptiler.com/cloud/api/geocoding/#PlaceTypeValues) for the list). In case of reverse geocoding if just a single type is specified, then multiple nearby features of the single `type` can be returned, otherwise single feature for every specified type (or default types) can be returned - see also the [limit](#limit) parameter. - Type: string · PlaceTypeenum Check out the [descriptions and default values](https://docs.maptiler.com/guides/location-services/geocoding-search/place-types-values/) of each of the PlaceType values values - continental\_marine - country - major\_landform - region - subregion - Show all values - excludeTypesCopy link to excludeTypes Type: boolean Default false Set to `true` to use all available feature types except those specified in `types`. - fuzzyMatchCopy link to fuzzyMatch Type: boolean Default true Set to `false` to disable fuzzy search. - autocompleteCopy link to autocomplete Type: boolean Set to `true` to use autocomplete, `false` to disable autocomplete. - worldviewCopy link to worldview Type: string enum Example ch Example ch Some of the geographical boundaries and names are disputed. When `worldview` option is selected, the Geocoding API responses will be aligned with the borders and names recognized by the selected country (e.g., US or Switzerland). This affects filtering by country, the context returned with the given feature and also some of the labels (e.g., Gulf of Mexico vs. Gulf of America). Special values include: `auto` - the worldview is determined by the location of the client, `default` - disputed areas are returned without country information, countries with disputed borders are returned without full geometry. values - default - auto - ae - ch - jp - kr - us Responses - 200 Search result represented as FeatureCollection where every item is represented as a GeoJSON Feature application/json - 400 Query too long / Invalid parameters - 403 Key is missing, invalid or restricted Request Example for get/geocoding/_{query}_.json Shell Curl ```curl curl 'https://api.maptiler.com/geocoding/Zurich.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /geocoding/{query}.json) Status: 200Status: 400Status: 403 Show Schema ```json { "type": "FeatureCollection", "features": [ { "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string", "additionalProperty": "anything", "type": "Feature", "properties": { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything" }, "geometry": { "type": "Point", "coordinates": [ 8.528509, 47.3774434 ] }, "bbox": [ 5.9559, 45.818, 10.4921, 47.8084 ], "center": "[Circular]", "place_name": "string", "matching_place_name": "string", "matching_text": "string", "place_type": [ "continental_marine" ], "place_type_name": [ "string" ], "relevance": 1, "context": [ { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything", "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string" } ], "address": "string", "^place_name_(\\w\\w)": "string" } ], "query": [ "string" ], "attribution": "© MapTiler © OpenStreetMap contributors" } ``` JSONCopy JSONCopy Search result represented as FeatureCollection where every item is represented as a GeoJSON Feature ### Search by coordinates (reverse) ​Copy link Auth Required Reverse geocoding (search by coordinates). Path Parameters - longitudeCopy link to longitude Type: number min:   \-180 max:   180 required Example 8.528509 - latitudeCopy link to latitude Type: number min:   \-90 max:   90 required Example 47.3774434 Query Parameters - languageCopy link to language Type: array string\[\] …20 unique!enum Example de,en Example de,en Prefer results in specific language specified as ISO 639-1 code. Only the first language code is used when prioritizing forward geocode results to be matched. If this query parameter is omited then Accept-Language HTTP header will be analyzed. If the parameter is provided but is empty then no language preference is made. values - aa - ab - ae - af - ak - Show all values - limitCopy link to limit Type: integer min:   1 max:   10 Maximum number of results. Default: 5 for forward geocoding, 1 for reverse geocoding. For reverse geocoding, limit > 1 requires exactly one `types` value and switches to a nearest-neighbour search (N closest features of that type within 1 km). Without limit, reverse geocoding returns a single best match per layer at the queried point - typesCopy link to types Type: array string\[\] · PlaceType\[\] unique!enum Filter types of which features to return. If not specified, default configuration of API is used (see [PlaceTypeValues](https://docs.maptiler.com/cloud/api/geocoding/#PlaceTypeValues) for the list). In case of reverse geocoding if just a single type is specified, then multiple nearby features of the single `type` can be returned, otherwise single feature for every specified type (or default types) can be returned - see also the [limit](#limit) parameter. - Type: string · PlaceTypeenum Check out the [descriptions and default values](https://docs.maptiler.com/guides/location-services/geocoding-search/place-types-values/) of each of the PlaceType values values - continental\_marine - country - major\_landform - region - subregion - Show all values - excludeTypesCopy link to excludeTypes Type: boolean Default false Set to `true` to use all available feature types except those specified in `types`. - worldviewCopy link to worldview Type: string enum Example ch Example ch Some of the geographical boundaries and names are disputed. When `worldview` option is selected, the Geocoding API responses will be aligned with the borders and names recognized by the selected country (e.g., US or Switzerland). This affects filtering by country, the context returned with the given feature and also some of the labels (e.g., Gulf of Mexico vs. Gulf of America). Special values include: `auto` - the worldview is determined by the location of the client, `default` - disputed areas are returned without country information, countries with disputed borders are returned without full geometry. values - default - auto - ae - ch - jp - kr - us Responses - 200 Search result represented as FeatureCollection where every item is represented as a GeoJSON Feature application/json - 400 Query too long / Invalid parameters - 403 Key is missing, invalid or restricted Request Example for get/geocoding/_{longitude}_,_{latitude}_.json Shell Curl ```curl curl 'https://api.maptiler.com/geocoding/8.528509,47.3774434.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /geocoding/{longitude},{latitude}.json) Status: 200Status: 400Status: 403 Show Schema ```json { "type": "FeatureCollection", "features": [ { "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string", "additionalProperty": "anything", "type": "Feature", "properties": { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything" }, "geometry": { "type": "Point", "coordinates": [ 8.528509, 47.3774434 ] }, "bbox": [ 5.9559, 45.818, 10.4921, 47.8084 ], "center": "[Circular]", "place_name": "string", "matching_place_name": "string", "matching_text": "string", "place_type": [ "continental_marine" ], "place_type_name": [ "string" ], "relevance": 1, "context": [ { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything", "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string" } ], "address": "string", "^place_name_(\\w\\w)": "string" } ], "query": [ "string" ], "attribution": "© MapTiler © OpenStreetMap contributors" } ``` JSONCopy JSONCopy Search result represented as FeatureCollection where every item is represented as a GeoJSON Feature ### Search by feature ID ​Copy link Auth Required Search feature by its ID (`id`) as returned in forward or reverse geocoding response and return its full geometry. Note that the feature ID is not stable and it changes when the database is re-indexed. Path Parameters - idCopy link to id Type: string `[`Pattern: ^(\\S+)\\.(\[0-9\]+)$ required Example country.26561650 Feature ID (found in response of forward or reverse geocoding) Query Parameters - languageCopy link to language Type: array string\[\] …20 unique!enum Example de,en Example de,en Prefer results in specific language specified as ISO 639-1 code. Only the first language code is used when prioritizing forward geocode results to be matched. If this query parameter is omited then Accept-Language HTTP header will be analyzed. If the parameter is provided but is empty then no language preference is made. values - aa - ab - ae - af - ak - Show all values - worldviewCopy link to worldview Type: string enum Example ch Example ch Some of the geographical boundaries and names are disputed. When `worldview` option is selected, the Geocoding API responses will be aligned with the borders and names recognized by the selected country (e.g., US or Switzerland). This affects filtering by country, the context returned with the given feature and also some of the labels (e.g., Gulf of Mexico vs. Gulf of America). Special values include: `auto` - the worldview is determined by the location of the client, `default` - disputed areas are returned without country information, countries with disputed borders are returned without full geometry. values - default - auto - ae - ch - jp - kr - us Responses - 200 Search result represented as FeatureCollection where every item is represented as a GeoJSON Feature application/json - 400 Query too long / Invalid parameters - 403 Key is missing, invalid or restricted Request Example for get/geocoding/_{id}_.json Shell Curl ```curl curl 'https://api.maptiler.com/geocoding/country.26561650.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /geocoding/{id}.json) Status: 200Status: 400Status: 403 Show Schema ```json { "type": "FeatureCollection", "features": [ { "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string", "additionalProperty": "anything", "type": "Feature", "properties": { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything" }, "geometry": { "type": "Point", "coordinates": [ 8.528509, 47.3774434 ] }, "bbox": [ 5.9559, 45.818, 10.4921, 47.8084 ], "center": "[Circular]", "place_name": "string", "matching_place_name": "string", "matching_text": "string", "place_type": [ "continental_marine" ], "place_type_name": [ "string" ], "relevance": 1, "context": [ { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything", "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string" } ], "address": "string", "^place_name_(\\w\\w)": "string" } ], "query": [ "string" ], "attribution": "© MapTiler © OpenStreetMap contributors" } ``` JSONCopy JSONCopy Search result represented as FeatureCollection where every item is represented as a GeoJSON Feature ### Batch geocoding API ​Copy link Auth Required Perform geocoding of more than one request in a single API call. Check out the [Batch Geocoding guide](https://docs.maptiler.com/guides/geocoding/batch-geocoding-api/) for an example. Path Parameters - queriesCopy link to queries Type: string required Example Paris;Berlin Semicolon-separated list of queries. Semicolon `;` must be provided verbatim and not be URL-encoded. Each query may be forward, reverse or by feature ID. Maximum of 50 queries are supported. Query Parameters - bboxCopy link to bbox Type: array · bbox Example \[5.9559, 45.818, 10.4921, 47.8084\] Example 5.9559,45.818,10.4921,47.8084 A `[w, s, e, n]` bounding box array to use for limiting search results. Only features inside the provided bounding box will be included. - proximityCopy link to proximity A `[lon, lat]` array to use for biasing search results or the string `ip` to do server-side IP based geolocation. Specify to prefer results close to a specific location - features closer to the proximity value will be given priority over those further from the proximity value. Any ofCoordinates - Type: array · Coordinates Example \[8.528509, 47.3774434\] Example 8.528509,47.3774434 - languageCopy link to language Type: array string\[\] …20 unique!enum Example de,en Example de,en Prefer results in specific language specified as ISO 639-1 code. Only the first language code is used when prioritizing forward geocode results to be matched. If this query parameter is omited then Accept-Language HTTP header will be analyzed. If the parameter is provided but is empty then no language preference is made. values - aa - ab - ae - af - ak - Show all values - countryCopy link to country Type: array string\[\] unique! Example sk,cz Example sk,cz Limit search to specific country/countries. - limitCopy link to limit Type: integer min:   1 max:   10 Maximum number of results. Default: 5 for forward geocoding, 1 for reverse geocoding. For reverse geocoding, limit > 1 requires exactly one `types` value and switches to a nearest-neighbour search (N closest features of that type within 1 km). Without limit, reverse geocoding returns a single best match per layer at the queried point - typesCopy link to types Type: array string\[\] · PlaceType\[\] unique!enum Filter types of which features to return. If not specified, default configuration of API is used (see [PlaceTypeValues](https://docs.maptiler.com/cloud/api/geocoding/#PlaceTypeValues) for the list). In case of reverse geocoding if just a single type is specified, then multiple nearby features of the single `type` can be returned, otherwise single feature for every specified type (or default types) can be returned - see also the [limit](#limit) parameter. - Type: string · PlaceTypeenum Check out the [descriptions and default values](https://docs.maptiler.com/guides/location-services/geocoding-search/place-types-values/) of each of the PlaceType values values - continental\_marine - country - major\_landform - region - subregion - Show all values - excludeTypesCopy link to excludeTypes Type: boolean Default false Set to `true` to use all available feature types except those specified in `types`. - fuzzyMatchCopy link to fuzzyMatch Type: boolean Default true Set to `false` to disable fuzzy search. - autocompleteCopy link to autocomplete Type: boolean Set to `true` to use autocomplete, `false` to disable autocomplete. - worldviewCopy link to worldview Type: string enum Example ch Example ch Some of the geographical boundaries and names are disputed. When `worldview` option is selected, the Geocoding API responses will be aligned with the borders and names recognized by the selected country (e.g., US or Switzerland). This affects filtering by country, the context returned with the given feature and also some of the labels (e.g., Gulf of Mexico vs. Gulf of America). Special values include: `auto` - the worldview is determined by the location of the client, `default` - disputed areas are returned without country information, countries with disputed borders are returned without full geometry. values - default - auto - ae - ch - jp - kr - us Responses - 200 Array of geocoding results where items are matching order of queries in the request. Every result is represented as FeatureCollection where every item is represented as a GeoJSON Feature application/json - 400 Query too long / Invalid parameters - 403 Key is missing, invalid or restricted Request Example for get/geocoding/_{queries}_.json Shell Curl ```curl curl 'https://api.maptiler.com/geocoding/Paris;Berlin.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /geocoding/{queries}.json) Status: 200Status: 400Status: 403 Show Schema ```json [ { "type": "FeatureCollection", "features": [ { "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string", "additionalProperty": "anything", "type": "Feature", "properties": { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything" }, "geometry": { "type": "Point", "coordinates": [ 8.528509, 47.3774434 ] }, "bbox": [ 5.9559, 45.818, 10.4921, 47.8084 ], "center": "[Circular]", "place_name": "string", "matching_place_name": "string", "matching_text": "string", "place_type": [ "continental_marine" ], "place_type_name": [ "string" ], "relevance": 1, "context": [ { "ref": "osm:r71525", "country_code": "fr", "kind": "road", "categories": [ "restaurant" ], "feature_tags": { "additionalProperty": "string" }, "place_designation": "city", "additionalProperty": "anything", "id": "municipality.46425", "text": "Paris", "language": "en", "^text_(\\w\\w)": "string", "^language_(\\w\\w)": "string" } ], "address": "string", "^place_name_(\\w\\w)": "string" } ], "query": [ "string" ], "attribution": "© MapTiler © OpenStreetMap contributors" } ] ``` JSONCopy JSONCopy Array of geocoding results where items are matching order of queries in the request. Every result is represented as FeatureCollection where every item is represented as a GeoJSON Feature ## Geolocation ​Copy link Geolocation Operations - get/geolocation/ip.json ### IP Geolocation ​Copy link Auth Required Obtain information about visitor's location based on IP address of the incoming request. Query Parameters - elevationCopy link to elevation Type: boolean Include elevation (in meters) in the results. Responses - 200 application/json - 403 Key is missing, invalid or restricted Request Example for get/geolocation/ip.json Shell Curl ```curl curl 'https://api.maptiler.com/geolocation/ip.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /geolocation/ip.json) Status: 200Status: 403 Show Schema ```json { "country": "Switzerland", "country_code": "CH", "country_bounds": [ 5.95538, 45.818852, 10.490936, 47.809357 ], "country_languages": [ "de", "fr", "it" ], "continent": "Europe", "continent_code": "EU", "eu": false, "city": "Zurich", "latitude": 47.36667, "longitude": 8.55, "postal": "8000", "region": "Zurich", "region_code": "ZH", "timezone": "Europe/Zurich", "elevation": 433 } ``` JSONCopy JSONCopy ## Coordinates ​Copy link Coordinates Operations - get/coordinates/search/{query}.json - get/coordinates/transform/{coordinates}.json ### Search coordinate systems ​Copy link Auth Required Path Parameters - queryCopy link to query Type: string required Examples finland deprecated:\* kind:\*United Kingdommercator deprecated:1Finland kind:DATUMcode:4326 Query string used to search the catalog. It accepts plain terms such as names of locations and key:value pairs for filtering. Following parameter values can be used: - kind - \* (All kinds) - CRS (All coordinate reference systems - default) - CRS-PROJCRS (Projected coordinate systems) - CRS-GEOGCRS (Geodetic coordinate systems) - CRS-GEOG3DCRS (Geodetic 3D coordinate systems) - CRS-GCENCRS (Geocentric coordinate systems) - CRS-VERTCRS (Vertical coordinate systems) - CRS-ENGCRS (Engineering coordinate systems) - CRS-COMPOUNDCRS (Compound coordinate systems) - CRS-DRVDCRS (Derived coordinate systems) - COORDOP (All operations) - COORDOP-COPTRAN (Transformations) - COORDOP-COPCONO (Compound operations) - COORDOP-POIMOTO (Point motion operations) - COORDOP-COPCON (Conversions) - DATUM (All datums) - DATUM-VERTDAT (Vertical datums) - DATUM-ENGDAT (Engineering datums) - DATUM-GEODDAT (Geodetic datums) - DATUM-DYNGEODDA (Dynamic geodetic datums) - DATUM-ENSEMDAT (Ensemble datum) - ELLIPSOID (Ellipsoid) - PRIMEM (Prime meridian) - METHOD (Method / Projection) - CS (Coordinate systems) - CS-VERTCS (Vertical coordinate system) - CS-SPHERCS (Spherical coordinate system) - CS-CARTESCS (Cartesian coordinate system) - CS-ELLIPCS (Ellipsoidal coordinate system) - CS-AFFINE (Affine coordinate system) - CS-ORDINAL (Ordinal coordinate system) - AXIS (Axis) - AREA (Area) - UNIT (Unit) - UNIT-ANGUNIT (Angle unit) - UNIT-SCALEUNIT (Scale unit) - UNIT-LENUNIT (Length unit) - UNIT-TIMEUNIT (Time unit) - code - Full code of the resource - trans - Code of the transformation - deprecated - \* (Both active and deprecated) - 0 (active only - default) - 1 (deprecated only) Query Parameters - limitCopy link to limit Type: integer min:   1 max:   50 Default 10 Maximum number of results returned - offsetCopy link to offset Type: integer min:   0 Default 0 The starting position of returned list of results - transformationsCopy link to transformations Type: boolean Default false Show detailed transformations for each CRS - exportsCopy link to exports Type: boolean Default false Show exports in WKT and Proj4 notations Responses - 200 application/json Request Example for get/coordinates/search/_{query}_.json Shell Curl ```curl curl 'https://api.maptiler.com/coordinates/search/finland deprecated:* kind:*.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /coordinates/search/{query}.json) Status: 200 Show Schema ```json { "results": [ { "accuracy": 1, "area": "string", "bbox": [ 1 ], "default_transformation": { "authority": "string", "code": 1 }, "deprecated": true, "exports": { "proj4": "string", "wkt": "string" }, "id": { "authority": "string", "code": 1 }, "kind": "string", "name": "string", "transformations": [ { "accuracy": 1, "area": "string", "bbox": [ 1 ], "deprecated": true, "exports": { "proj4": "string", "wkt": "string" }, "grids": [ { "path": "string" } ], "id": { "authority": "string", "code": 1 }, "name": "string", "reversible": true, "target_crs": { "authority": "string", "code": 1 }, "unit": "string", "usable": true } ], "unit": "string" } ], "total": 1 } ``` JSONCopy JSONCopy ### Transform coordinates ​Copy link Auth Required Path Parameters - coordinatesCopy link to coordinates Type: string required Example 17,50;17,50,300 List of coordinate pairs seperated by `;` delimeter (Max 50 pairs). Query Parameters - s\_srsCopy link to s\_srs Type: integer Default 4326 Source CRS - t\_srsCopy link to t\_srs Type: integer Default 4326 Target CRS - opsCopy link to ops Type: string Example 1623 List of codes of operations seperated by a | (pipe) operator Responses - 200 application/json Request Example for get/coordinates/transform/_{coordinates}_.json Shell Curl ```curl curl 'https://api.maptiler.com/coordinates/transform/17,50;17,50,300.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /coordinates/transform/{coordinates}.json) Status: 200 Show Schema ```json { "results": [ { "x": 1, "y": 1, "z": 1 } ], "transformer_selection_strategy": "string" } ``` JSONCopy JSONCopy ## Elevation ​Copy link Elevation Operations - get/elevation/{locations}.json ### Get elevation ​Copy link Auth Required Get the elevation at given locations. If _unit_ is omitted, elevation values are in meters. Path Parameters - locationsCopy link to locations Type: string required Example 17,50;-133.5,58.39 List of `lng,lat` WGS 84 positions seperated by `;` delimeter (Max 50 positions). Longitude values must be `> -180 < 180`. Latitudes must be `>= -85 <= 85`. Query Parameters - unitCopy link to unit Type: string enum Default meters Unit of the elevation. values - meters - feet Responses - 200 application/json - 400 Out of bounds Request Example for get/elevation/_{locations}_.json Shell Curl ```curl curl 'https://api.maptiler.com/elevation/17,50;-133.5,58.39.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /elevation/{locations}.json) Status: 200Status: 400 Show Schema ```json [ [ 17, 50, 364.20001220703125 ], [ -133.5, 58.39, 1323.800048828125 ] ] ``` JSONCopy JSONCopy ## Weather ​Copy link Weather Operations - get/weather/latest.json ### Weather catalog ​Copy link Auth Required List current weather-related variables, their metadata and individual keyframes Responses - 200 application/json - 403 Key is missing, invalid or restricted Request Example for get/weather/latest.json Shell Curl ```curl curl 'https://api.maptiler.com/weather/latest.json?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /weather/latest.json) Status: 200Status: 403 Show Schema ```json { "variables": [ { "spatial_ref_sys": { "auth_name": "EPSG", "auth_srid": "3857", "wkt": "PROJCRS[\"WGS 84 / Pseudo-Mercator\",BASEGEOGCRS[\"WGS 84\",ENSEMBLE[\"World Geodetic System 1984 ensemble\",MEMBER[\"World Geodetic System 1984 (Transit)\"],MEMBER[\"World Geodetic System 1984 (G730)\"],MEMBER[\"World Geodetic System 1984 (G873)\"],MEMBER[\"World Geodetic System 1984 (G1150)\"],MEMBER[\"World Geodetic System 1984 (G1674)\"],MEMBER[\"World Geodetic System 1984 (G1762)\"],MEMBER[\"World Geodetic System 1984 (G2139)\"],ELLIPSOID[\"WGS 84\",6378137,298.257223563,LENGTHUNIT[\"metre\",1]],ENSEMBLEACCURACY[2.0]],PRIMEM[\"Greenwich\",0,ANGLEUNIT[\"degree\",0.0174532925199433]],ID[\"EPSG\",4326]],CONVERSION[\"Popular Visualisation Pseudo-Mercator\",METHOD[\"Popular Visualisation Pseudo Mercator\",ID[\"EPSG\",1024]],PARAMETER[\"Latitude of natural origin\",0,ANGLEUNIT[\"degree\",0.0174532925199433],ID[\"EPSG\",8801]],PARAMETER[\"Longitude of natural origin\",0,ANGLEUNIT[\"degree\",0.0174532925199433],ID[\"EPSG\",8802]],PARAMETER[\"False easting\",0,LENGTHUNIT[\"metre\",1],ID[\"EPSG\",8806]],PARAMETER[\"False northing\",0,LENGTHUNIT[\"metre\",1],ID[\"EPSG\",8807]]],CS[Cartesian,2],AXIS[\"easting (X)\",east,ORDER[1],LENGTHUNIT[\"metre\",1]],AXIS[\"northing (Y)\",north,ORDER[2],LENGTHUNIT[\"metre\",1]],USAGE[SCOPE[\"Web mapping and visualisation.\"],AREA[\"World between 85.06°S and 85.06°N.\"],BBOX[-85.06,-180,85.06,180]],ID[\"EPSG\",3857]]" }, "bounds": [ -20037481.18083349, -20037508.342789244, 20008180.55502281, 20037508.342789244 ], "tile_format": "png", "tile_matrix_set": { "bounds": [ -20037481.18083349, -20037508.342789244, 20008180.55502281, 20037508.342789244 ], "items": [ { "zoom_level": 1, "matrix_width": 1, "matrix_height": 1, "tile_width": 1, "tile_height": 1, "pixel_x_size": 1, "pixel_y_size": 1 } ] }, "metadata": { "weather_variable": { "name": "Wind", "description": "Wind at 10 m above ground [m/s]", "attribution": "GFS", "variable_id": "wind-10m:gfs", "decoding": { "channels": "rg", "min": -75, "max": 75 }, "unit": "ms", "release_timestamp": "2023-03-01T06:00:00+00:00", "timestamp": "2023-03-01T11:00:00+00:00" } }, "keyframes": [ { "id": "string", "timestamp": "string" } ] } ] } ``` JSONCopy JSONCopy ## Other ​Copy link Other Operations - get/sprites/{spriteId}/sprite{scale}.{format} - get/fonts/{fontstack}/{start}-{end}.pbf - get/ogc/conformance ### Sprites (icon sets) ​Copy link Map icons (sprites) used to display the vector map. Path Parameters - spriteIdCopy link to spriteId Type: string required Identifier of the sprite. - scaleCopy link to scale enum const:   @2x values - @2x - formatCopy link to format Type: string enum required values - png - json Responses - 200 Selected Content Type: application/json Request Example for get/sprites/_{spriteId}_/sprite_{scale}_._{format}_ Shell Curl ```curl curl 'https://api.maptiler.com/sprites/{spriteId}/sprite@2x.png' ``` Copy Copy Test Request(get /sprites/{spriteId}/sprite{scale}.{format}) Status: 200 No Body ### Fonts (glyphs) ​Copy link Auth Required Generates the glyphs for the requested fonts. Used when displaying vector maps. Path Parameters - fontstackCopy link to fontstack Type: string required Example Roboto Medium,Noto Sans Regular Font name, or more comma-separated names. - startCopy link to start Type: integer multiple of:   256 required Example 0 Start of the glyph range. - endCopy link to end Type: integer required Example 255 End of the glyph range (last glyph index). Responses - 200 application/x-protobuf - 400 Invalid glyph range Request Example for get/fonts/_{fontstack}_/_{start}_\-_{end}_.pbf Shell Curl ```curl curl 'https://api.maptiler.com/fonts/Roboto Medium,Noto Sans Regular/1-255.pbf?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /fonts/{fontstack}/{start}-{end}.pbf) Status: 200Status: 400 No Body ### OGC API conformance classes ​Copy link Auth Required Declaration of the implemented conformance classes. Responses - 200 application/json Request Example for get/ogc/conformance Shell Curl ```curl curl 'https://api.maptiler.com/ogc/conformance?key=YOUR_API_KEY' ``` Copy Copy Test Request(get /ogc/conformance) Status: 200 Show Schema ```json string ``` Copy Copy