Get Map API Reference

Estimated reading time: 2 minutes

The Maps API allows you to retrieve vector or raster tiles generated by the app. You can use some libraries like Leaflet or MapLibre GL for JavaScript, Android or iOS to add a map to your website.

Endpoints

If you need tile URL, you should use this endpoint. We are supporting both raster png and vector pbf tiles.

https://tile.jawg.io/your-style-id/{z}/{x}/{y}{@2x}.{format}?access-token=your-jawg-access-token&lang={lang}&worldview={worldview}
\___/   \__________/\_____________/\_________/\___/  \____/               \____________________/      \____/           \_________/
  |          \         /              /           \       \                          |                   |                  |
scheme        domain  style ID  tiles coordinates  retina  tile format      authentication token      language          worldview
  • style ID: your style ID or one of our default styles for raster tiles or streets-v2, landcover-v1, hillshade-v1 for vector tiles.
  • retina: only for raster tiles, this generate 512x512 tiles instead of 256x256.
  • tile format: available formats are png and pbf.
  • authentication token: create your access token on the app.
  • language: for raster tiles (png) you will get tiles in your language, but you can force the desired one via query parameter. Valid values are de, en, es, fr, it, ja, ko, nl, ru, zh. You can use int for international map.
  • worldview (optional): Code ISO 3166-1 of your country perspective. You can add many countries, be aware of potential conflicts between some countries. Supported countries are MA, EG (e.g worldview=MA,EG).

If you want your style as json for MapLibre GL you will need this endpoint:

https://api.jawg.io/styles/your-style-id.json?access-token=your-jawg-access-token&lang={lang}&extrude={true|false}&worldview={worldview}
\___/   \_________/        \___________/                   \____________________/      \____/         \__________/           \_________/
  |          |                  |                                     |                  |                  |                     |
scheme     domain            style ID                        authentication token     language       extrude buildings        worldview
  • style ID: your style ID or one of our default styles or your custom style from the lab.
  • authentication token: create your access token on the app.
  • language (optional): for raster tiles (png) you will get tiles in your language, but you can force the desired one via query parameter. Valid values are de, en, es, fr, it, ja, ko, nl, ru, zh. You can use int for international map.
  • extrude (optional): extrude building for 3D view
  • worldview (optional): Code ISO 3166-1 of your country perspective. You can add many countries, be aware of potential conflicts between some countries. Supported countries are MA, EG (e.g worldview=MA,EG).

Map Request Counter

Default styles

We have some default styles which can be used by anyone with an access token. Here is our list (click on the image for a preview):

jawg-streets
jawg-streets
jawg-terrain
jawg-terrain
jawg-lagoon
jawg-lagoon
jawg-sunny
jawg-sunny
jawg-light
jawg-light
jawg-dark
jawg-dark