--- title: "MapTiler Server API Reference" description: "Comprehensive technical documentation for the MapTiler Server REST API." --- > 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 - WMTS Capabilities for all layers HTTP Method:  GET - WMS Capabilities HTTP Method:  GET - WMS Capabilities for all layers 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 - 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 - Other Close Group - Font glyphs HTTP Method:  GET - OGC API conformance classes HTTP Method:  GET [Powered by Scalar](https://www.scalar.com) v4.8.0 OpenAPI 3.1.0 # MapTiler Server API [Support](mailto:support@maptiler.com) [](https://support.maptiler.com) [Terms of Service](https://www.maptiler.com/server/license/) Download OpenAPI Document json Download OpenAPI Document yaml API reference for the MapTiler Server. The MapTiler Server API allows you to programmatically access all the data, maps, and resources in the MapTiler Server. Through the API, you can add a map directly to your website, request map tiles, create an image with a location map for your business, and more. Server Server:http://localhost:3650/api MapTiler Server API 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 - get/WMTSCapabilities.xml - get/maps/{mapId}/wms?service=WMS&request=GetCapabilities - get/maps/wms?service=WMS&request=GetCapabilities ### Embeddable HTML viewer ​Copy link Path Parameters - mapIdCopy link to mapId Type: string required Example streets Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. Responses - 200 OK text/html - 404 The item does not exist Request Example for get/maps/_{mapId}_/ Shell Curl ```curl curl http://localhost:3650/api/maps/streets/ ``` Copy Copy Status: 200Status: 404 No Body OK ### Style JSON of the map ​Copy link 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 Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/maps/_{mapId}_/style.json Shell Curl ```curl curl http://localhost:3650/api/maps/streets/style.json ``` Copy Copy Status: 200Status: 404 Show Schema ```json {} ``` Copy Copy OK ### Map symbols (sprites) ​Copy link Map symbols (sprites) required to display the vector map. Path Parameters - mapIdCopy link to mapId Type: string required Example streets Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. - 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 - json Responses - 200 OK Selected Content Type: application/json - 404 The item does not exist Request Example for get/maps/_{mapId}_/sprite_{scale}_._{format}_ Shell Curl ```curl curl http://localhost:3650/api/maps/streets/sprite@2x.png ``` Copy Copy Status: 200Status: 404 No Body OK ### Raster XYZ tiles ​Copy link 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 - tileSizeCopy 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 The value depends on the Map settings. values - png - jpg - webp - mapIdCopy link to mapId Responses - 200 OK image/\* - 400 Out of bounds / Invalid format - 404 The item does not exist Request Example for get/maps/_{mapId}_/_{tileSize}_/_{z}_/_{x}_/_{y}__{scale}_._{format}_ Shell Curl ```curl curl 'http://localhost:3650/api/maps/{mapId}/256/1/1/1@2x.png' ``` Copy Copy Status: 200Status: 400Status: 404 Show Schema ```json @filename ``` Copy Copy OK ### TileJSON ​Copy link 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 Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. - tileSizeCopy link to tileSize enum const:   256 Integer numbers. values - 256 Responses - 200 OK application/json - 404 The item does not exist Request Example for get/maps/_{mapId}_/_{tileSize}_/tiles.json Shell Curl ```curl curl http://localhost:3650/api/maps/streets/256/tiles.json ``` Copy Copy Status: 200Status: 404 Show Schema ```json {} ``` Copy Copy OK ### OGC API - Tiles ​Copy link 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 Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/maps/_{mapId}_/tiles Shell Curl ```curl curl http://localhost:3650/api/maps/streets/tiles ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### OGC API TileMatrixSets ​Copy link 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 Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/maps/_{mapId}_/tileMatrixSet Shell Curl ```curl curl http://localhost:3650/api/maps/streets/tileMatrixSet ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### WMTS Capabilities ​Copy link 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 Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. Responses - 200 OK text/xml - 404 The item does not exist Request Example for get/maps/_{mapId}_/WMTSCapabilities.xml Shell Curl ```curl curl http://localhost:3650/api/maps/streets/WMTSCapabilities.xml ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### WMTS Capabilities for all layers ​Copy link WMTS Capabilities XML document describing the metadata of all map layers as well as link to the XYZ tiles. Can be used with various GIS software (e.g. QGIS) to display the map. Responses - 200 OK text/xml - 404 The item does not exist Request Example for get/WMTSCapabilities.xml Shell Curl ```curl curl http://localhost:3650/api/WMTSCapabilities.xml ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### WMS Capabilities ​Copy link WMS Capabilities XML document describing the metadata of the map. 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 Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. Responses - 200 OK text/xml - 404 The item does not exist Request Example for get/maps/_{mapId}_/wms?service=WMS&request=GetCapabilities Shell Curl ```curl curl 'http://localhost:3650/api/maps/streets/wms?service=WMS&request=GetCapabilities' ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### WMS Capabilities for all layers ​Copy link WMS capabilities XML document describing the metadata of all map layers. Can be used with various GIS software (e.g. QGIS) to display the map. Responses - 200 OK text/xml - 404 The item does not exist Request Example for get/maps/wms?service=WMS&request=GetCapabilities Shell Curl ```curl curl 'http://localhost:3650/api/maps/wms?service=WMS&request=GetCapabilities' ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ## 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 Generates a raster image based on the specified center and zoom level. Path Parameters - mapIdCopy link to mapId Type: string required Example streets Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. - 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 required Width of the image in pixels. - heightCopy link to height Type: integer 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 The value depends on the Map settings. 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 maps in MapTiler Server](https://docs.maptiler.com/guides/self-hosting/map-server/static-maps-in-maptiler-server). - 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 maps in MapTiler Server](https://docs.maptiler.com/guides/self-hosting/map-server/static-maps-in-maptiler-server). - 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 - shortestCopy link to shortest Type: boolean Draw the shortest paths, allow to cross the dateline. Responses - 200 OK image/\* - 400 Out of bounds / Invalid format - 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 http://localhost:3650/api/maps/streets/static/1,1,1/1x1@2x.png ``` Copy Copy Status: 200Status: 400Status: 404Status: 414 Show Schema ```json @filename ``` Copy Copy OK ### Bounds-based image ​Copy link Generates a raster image based on the given bounds. Path Parameters - mapIdCopy link to mapId Type: string required Example streets Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. - 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 required Width of the image in pixels. - heightCopy link to height Type: integer 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 The value depends on the Map settings. 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 maps in MapTiler Server](https://docs.maptiler.com/guides/self-hosting/map-server/static-maps-in-maptiler-server). - 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 maps in MapTiler Server](https://docs.maptiler.com/guides/self-hosting/map-server/static-maps-in-maptiler-server). - 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 - shortestCopy link to shortest Type: boolean Draw the shortest paths, allow to cross the dateline. Responses - 200 OK image/\* - 400 Out of bounds / Invalid format - 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 http://localhost:3650/api/maps/streets/static/1,1,1,1/1x1@2x.png ``` Copy Copy Status: 200Status: 400Status: 404Status: 414 Show Schema ```json @filename ``` Copy Copy OK ### Auto-fitted image ​Copy link 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 Identifier of the map. See MapTiler Server Maps `http://localhost:3650/admin/`. - widthCopy link to width Type: integer required Width of the image in pixels. - heightCopy link to height Type: integer 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 The value depends on the Map settings. 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 maps in MapTiler Server](https://docs.maptiler.com/guides/self-hosting/map-server/static-maps-in-maptiler-server). - 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 maps in MapTiler Server](https://docs.maptiler.com/guides/self-hosting/map-server/static-maps-in-maptiler-server). - 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 - shortestCopy link to shortest Type: boolean Draw the shortest paths, allow to cross the dateline. Responses - 200 OK image/\* - 400 Out of bounds / Invalid format - 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 http://localhost:3650/api/maps/streets/static/auto/1x1@2x.png ``` Copy Copy Status: 200Status: 400Status: 404Status: 414 Show Schema ```json @filename ``` Copy Copy OK ## 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 Path Parameters - tilesIdCopy link to tilesId Type: string required Example maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK text/html - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/ Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/ ``` Copy Copy Status: 200Status: 404 No Body OK ### XYZ tiles ​Copy link 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 maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/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 OK \* - 204 Tile not present -- presumed empty (empty response) - 400 Out of bounds - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/_{z}_/_{x}_/_{y}_ Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/1/1/1 ``` Copy Copy Status: 200Status: 204Status: 400Status: 404 No Body OK ### TileJSON ​Copy link 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 maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/tiles.json Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/tiles.json ``` Copy Copy Status: 200Status: 404 Show Schema ```json {} ``` Copy Copy OK ### OGC API - Tiles ​Copy link 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 maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/tiles Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/tiles ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### OGC API TileMatrixSets ​Copy link 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 maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/tileMatrixSet Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/tileMatrixSet ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### WMTS Capabilities ​Copy link 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 maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK text/xml - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/WMTSCapabilities.xml Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/WMTSCapabilities.xml ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ## 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 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 Default 5 Maximum number of results to return. For reverse geocoding with multiple types this must not be set or must be set to 1. - 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/guides/location-services/geocoding-search/place-types-values/) 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. - 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 Request Example for get/geocoding/_{query}_.json Shell Curl ```curl curl http://localhost:3650/api/geocoding/Zurich.json ``` Copy Copy Status: 200Status: 400 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 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 Default 5 Maximum number of results to return. For reverse geocoding with multiple types this must not be set or must be set to 1. - 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/guides/location-services/geocoding-search/place-types-values/) 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. - 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 Request Example for get/geocoding/_{longitude}_,_{latitude}_.json Shell Curl ```curl curl http://localhost:3650/api/geocoding/8.528509,47.3774434.json ``` Copy Copy Status: 200Status: 400 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 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 Request Example for get/geocoding/_{id}_.json Shell Curl ```curl curl http://localhost:3650/api/geocoding/country.26561650.json ``` Copy Copy Status: 200Status: 400 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 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 Default 5 Maximum number of results to return. For reverse geocoding with multiple types this must not be set or must be set to 1. - 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/guides/location-services/geocoding-search/place-types-values/) 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. - 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 Request Example for get/geocoding/_{queries}_.json Shell Curl ```curl curl 'http://localhost:3650/api/geocoding/Paris;Berlin.json' ``` Copy Copy Status: 200Status: 400 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 ## Other ​Copy link Other Operations - get/fonts/{fontstack}/{start}-{end}.pbf - get/ogc/conformance ### Font glyphs ​Copy link Generates the glyphs for the requested fonts. Used when displaying vector maps. Path Parameters - fontstackCopy link to fontstack Type: string required Font name, or more comma-separated names. - startCopy link to start Type: integer multiple of:   256 required Start of the glyph range. - endCopy link to end Type: integer required End of the glyph range (last glyph index). Responses - 200 OK application/x-protobuf - 400 Invalid glyph range Request Example for get/fonts/_{fontstack}_/_{start}_\-_{end}_.pbf Shell Curl ```curl curl 'http://localhost:3650/api/fonts/{fontstack}/1-1.pbf' ``` Copy Copy Status: 200Status: 400 No Body OK ### OGC API conformance classes ​Copy link Declaration of the implemented conformance classes. Responses - 200 OK application/json Request Example for get/ogc/conformance Shell Curl ```curl curl http://localhost:3650/api/ogc/conformance ``` Copy Copy Status: 200 Show Schema ```json string ``` Copy Copy OK