Tutorial: Display a map | ArcGIS API for Python v2.3

Learn how to use the ArcGIS API for Python and the basemap styles serviceThe ArcGIS Basemap Styles service, also referred to as the Basemap Styles service, is a location service that provides basemap styles and data for the world. It returns styles as Mapbox styles and web maps, and data as vector tiles and/or map tiles. It supports all of the styles in the ArcGIS Basemap style and Open Basemap style family. An ArcGIS Location Platform or ArcGIS Online account is required to use the service.Learn more to display a mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more.

Python mapping widget displaying a map of Malibu, CA

A map contains layersA layer is a reference to a collection of geographic data that is used to access and display data. The data for layers are typically provided by the basemap layer service and data services.Learn more of geographic data. A map contains a basemap layerA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service.Learn more and, optionally, one or more data layersA data layer is a layer that references geographic data from a file or a service and is used to visualize the data in a map or scene.Learn more. You can display a specific area of a map using a map view and setting the location and zoom level.

This tutorial shows you how to create and display a map of the Santa Monica Mountains in California using the topographic basemap layer.

Prerequisites

The ArcGIS API for Python tutorials use Jupyter Notebooks to execute Python code. If you are new to this environment, please see the guide to install the API and use notebooks locally.

Steps

Get an API key

To access location services, you need an API keyAn API key is a long-lived access token created using API key credentials. They are valid for up to one year and are typically embedded directly into client applications.Learn more, OAuth 2.0 access tokenAn access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication.Learn more, or ArcGIS Online accountAn ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization.Learn more. To learn how to create and scope your key, visit the Create an API key tutorial.

Go to your developer dashboard to get an API key.
Copy the key as it will be used in a following step.

Import modules and log in

Import the arcgis.gis module. This module is the entry point into the GIS and provides the functionality to manage GIS contentContent is a collection of items in a portal that belong to a user, group, or organization.Learn more, users, and groups.
Use dark colors for code blocks
```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

from arcgis.gis import GIS
```
Use the GIS class to log in. Replace YOUR_API_KEY with the API key you previously copied from the developer dashboard as a value to the api_key parameter.
Use dark colors for code blocks
```
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

from arcgis.gis import GIS


gis = GIS(api_key="YOUR_API_KEY")
```

Display the map

Create an instance of the map widget and set the basemap.

Use dark colors for code blocks

gis = GIS(api_key="YOUR_API_KEY")

map = gis.map()
map.basemap = "topo-vector"

Set the map center and zoom level.

Use dark colors for code blocks

map = gis.map()
map.basemap = "topo-vector"


map.center = [34.027, -118.805]
map.zoom = 13

map  # display the map

Optional: Use the export_to_html method to export the current state of the map widget to a static HTML file which can be viewed in any web browser.

Use dark colors for code blocks

from os import path, getcwd

export_dir = path.join(getcwd(), "home")
if not path.isdir(export_dir):
    os.mkdir(export_dir)

export_path = path.join(export_dir, "display-a-map.html")

map.export_to_html(export_path, title="Display a map")