Get started | ArcGIS API for Python v2.3

There are a number of ways to install and configure ArcGIS API for PythonArcGIS API for Python is a pythonic library for performing GIS visualization, analysis, data management, and GIS system administration tasks.Learn more. 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.

To use the ArcGIS API for PythonArcGIS API for Python is a pythonic library for performing GIS visualization, analysis, data management, and GIS system administration tasks.Learn more to access contentContent is a collection of items in a portal that belong to a user, group, or organization.Learn more, servicesA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more, or an organzation, you need an ArcGIS Developer accountAn ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription.Learn more, 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, or ArcGIS Enterprise accountAn ArcGIS Enterprise account is an identity for an instance of ArcGIS Enterprise. It can be used to access ArcGIS Enterprise tools, applications, and services, and to develop applications.Learn more. 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 a free account for ArcGIS Location Platform

Get an account for ArcGIS Online

2. Install the API

Install conda

To install conda, go to the installation guide.
In the guide, select your operating system and then follow the installation instructions.

Install the ArcGIS API for PythonArcGIS API for Python is a pythonic library for performing GIS visualization, analysis, data management, and GIS system administration tasks.Learn more

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

3. Run Jupyter Notebook

Start the Jupyter Notebook server with the following steps:

Open a terminal window.
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.

In Jupyter Notebook, click New > Python 3.
In the top cell, import the GIS, geocode and Geocoder modules and set your API key:

To access secure ArcGIS services and resources in ArcGIS PlatformArcGIS Location Platform, formerly known as ArcGIS Platform, is a Platform as a Service (PaaS) product that gives developers access to location services, APIs, and tools to build mapping and spatial analysis applications. It is subscription-based and requires an ArcGIS Location Platform account.Learn more, you need to use an 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. The easiest way to get started is to create 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. Learn more about access tokens and authentication in Security and authentication.

Get an API key

Use dark colors for code blocksCopy
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

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

In Jupyter Notebook, click New > Python 3.
In the top cell, import the GIS and geocode modules.
Provide the credentials you created from step 1 on this page to log in.

Use dark colors for code blocksCopy
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

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

In Jupyter Notebook, click New > Python 3.
In the top cell, import the GIS and geocode modules.
Provide your ArcGIS Enterprise Organization URL and the credentials from Step 1 to log in.

Use dark colors for code blocksCopy
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