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:

Get started for free with ArcGIS Platform Get a free trial for ArcGIS Online

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. Get an access token

To access secure ArcGIS services and resources, you need to use an access token. The easiest way to get started is to create an API key. Learn more about access tokens and authentication in Security and authentication.

Get an API key Implement OAuth 2.0

5. Create your first script

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

1. In Jupyter Notebook, click New > Python 3.

2. In the top cell, import the GIS and geocode module and set your API key:

   Use dark colors for code blocksCopy

           

   1
   2
   3
   4
   5
   6
   7
   8
   from arcgis.gis import GIS
   from arcgis.geocoding import geocode
   
   gis = GIS(api_key="<YOUR_API_KEY>")
   
   geocode_result = geocode(address="380 New York Street, Redlands, CA")
   
   geocode_result

3. In the toolbar, click Run to execute the code. You should see geocoded address results.

6. Follow the tutorials

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

7. Explore the samples

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