Get started

There are a number of ways to install and configure ArcGIS API for Python. If you are new, follow the steps below to get started with conda and Jupyter Notebooks. For additional installation configurations, go to ArcGIS Pro, Docker, Google Colaboratory, or Offline.

1. Sign up for an account

To use the ArcGIS API for Python to access content, services, or an organzation, you need an ArcGIS Developer account, ArcGIS Online account, or ArcGIS Enterprise account. The type of account, user type, and role you need depends on the resource you need to access and the operations you wish to undertake.

If you do not have an account, select one of the options below:

2. Install the API

To use the ArcGIS API for Python you need to install conda.

Install conda

1. To install conda, go to the installation guide.

2. In the guide, select your operating system and then follow the installation instructions.

Install the ArcGIS API for Python

1. Open a terminal window.
2. In the terminal, navigate to your working directory.
3. Run the following command to activate your environment: conda activate <YOUR_ENVINRONMENT>
4. Install the ArcGIS API for Python: conda install -c esri arcgis

3. Run Jupyter Notebook

Start the Jupyter Notebook server with the following steps:

1. Open a terminal window.
2. In the terminal, run the command: jupyter notebook

The command starts Jupyter Notebook and opens it in your default web browser.

4. Create your first script

Create a Notebook to geocode a text string to find an address.

1
2
3
4
5
6
7
8
9
10
11
12
from arcgis.gis import GIS
from arcgis.geocoding import geocode, Geocoder

gis = GIS(api_key="<YOUR_API_KEY>")

# Location services standard endpoint URL
# https://developers.arcgis.com/documentation/mapping-apis-and-services/geocoding/services/geocoding-service/#service-urls
geocode_url = Geocoder("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer/",gis=gis)

geocode_result = geocode(address="380 New York Street, Redlands, CA", geocoder=geocode_url)

geocode_result

1
2
3
4
5
6
7
8
from arcgis.gis import GIS
from arcgis.geocoding import geocode

gis = GIS(url="https://wwww.arcgis.com", username="<YOUR_USERNAME>", password="<YOUR_PASSWORD>")

geocode_result = geocode(address="380 New York Street, Redlands, CA")

geocode_result

1
2
3
4
5
6
7
8
9
from arcgis.gis import GIS
from arcgis.geocoding import geocode, Geocoder

# an example Organization URL https://pythonapi.playground.esri.com/portal/home/
gis = GIS(url="https://{YOUR_ORGANIZATION.DOMAIN.COM}/{CONTEXT}/home", username="{YOUR_USERNAME}", password="{YOUR_PASSWORD}")

geocode_result = geocode(address="380 New York Street, Redlands, CA")

geocode_result

5. Follow the tutorials

Go to the tutorials to create and run notebooks to perform different operations.

Display a map

Learn how to create and display a map with a basemap layer.

Add a point, line, and polygon

Learn how to display point, line, and polygon graphics in a map.

Display a web map

Search ArcGIS Online for an existing web map and display it.

Add a layer from a portal item

Learn how to use a portal item to access and display point features from a feature service.

6. Explore the samples

Go to the samples to learn how to perform more tasks with the API.

Inventory organization content

Crime analysis and clustering using geoanalytics and pyspark.ml

Safe Streets to Schools

Automate building footprint extraction using deep learning

Next steps

• Overview

  Learn about the API and developer resources.

• Key features

  Discover the capabilities of the API.

• Get started

  Get started using the API.