Open Basemap styles

Use the ArcGIS Basemap Styles service to display Open Basemap styles with ArcGIS SDKs and open source libraries.

Open Basemap styles

The Basemap Styles service supports styles in the Open Basemap style family. The styles reference data from Overture Maps and open source data providers such as

OpenStreetMap (OSM), Microsoft, Esri Community Maps, and other open data sources.

The styles are categorized into the following groups:

• Streets: Road networks, urban, and community features e.g. open/streets, open/osm-style/ open/navigation
• Satellite: Satellite imagery and labels e.g. open/hybrid
• Reference: Minimal geographic features such as boundaries and place labels e.g. open/light-gray, open/dark-gray
• Creative: Alternative cartographic designs e.g. arcgis/blueprint

See all of the styles below.

How to display an Open Basemaps style

The general steps to display an basemap style are:

1. Set the service URL, path and query parameters:
   • Service URL
     • https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/{style_response}/{style_family}/{style_name}?{parameters}&token=<ACCESS_TOKEN>.
   • Path parameters
     • Style response: styles or webmaps
     • Style family: open
     • Style name: For example osm-style, hybrid, and navigation. See all names below.
   • Query parameters
     • Style preferences: Not supported.
     • Access token: token
2. Set the access token either as authorization header or query parameter.
3. Display the style with a client API. See the Code examples.
4. Display Esri and data attribution.

To learn more about the service parameters, access tokens, and attribution requirements, go to the Introduction to the ArcGIS Basemap Styles service.

Styles

StreetsSatelliteReferenceCreative

Streets styles show road networks, urban, and community features. These styles are typically used for geocoding and routing applications.

Style family	Style name	Example	Data type	Data providers
open	osm-style		Vector tiles	Service API > Sources
open	osm-style-relief		Vector tiles, map tiles	Service API > Sources
open	osm-style-relief/base		Vector tiles	Service API > Sources
open	navigation		Vector tiles	Service API > Sources
open	navigation-dark		Vector tiles	Service API > Sources
open	streets		Vector tiles	Service API > Sources
open	streets-relief		Vector tiles	Service API > Sources
open	streets-relief/base		Vector tiles	Service API > Sources
open	streets-night		Vector tiles	Service API > Sources

OSM styles to Open styles

If your existing application uses a deprecated OSM style, use the table below to update the equivalent Open style.

Code examples

1
2
3
4
5
6
7
8
9
import { request } from '@esri/arcgis-rest-request';

const selfCallURL = "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/self";

request(selfCallURL, {httpMethod: "GET"})
  .then(results => {
    const openStyles = results.styles.filter(style.provider === 'open');
    console.log(openStyles);
  });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
      const openStyle = new Basemap({
          style: new BasemapStyle({
            id: "open/osm-style"
          })
        });

      const map = new Map({
        basemap: openStyle,
        constraints: {
          snapToZoom: false,
        },
      });