Get started

Get started with the ArcGIS Runtime API for Android:

  1. Review system requirements
  2. Install and set up
  3. Get an API key (to access services)
  4. Complete the Display a map tutorial

1. System requirements

Ensure your development environment meets the system requirements.

For an overview of this release, including enhancements, deprecations, and known issues, see the Release notes.

2. Install and set up

We recommend installing with Gradle, which will install the needed dependencies and SDK binaries from Esri's Maven repository. If you are unable to make use of Gradle, you can instead download the SDK and then add dependencies to your project manually by including the AAR library and dependency artifacts.

Get the API with Gradle

Perform the following set up steps in an existing Android Studio project, or create a new project.

  1. In your project-level build.gradle file, within the repositories block, add Esri's Maven repository URL to your project. Esri's repository is not open source and therefore not available in the default repository in the script, so you must specify this URL.

               
    allprojects {
      repositories {
        google()
        jcenter()
    
        // Add the Esri public Maven repository
        maven {
            url 'https://esri.jfrog.io/artifactory/arcgis'
        }
      }
    }
    
  2. In your module-level build.gradle file, within the dependencies block, add the ArcGIS Runtime SDK for Android dependency to your app.

        
    dependencies {
      implementation 'com.esri.arcgisruntime:arcgis-android:100.10.0'
      ...
    }
    
  3. Android Studio supports a subset of Java 8 language features. These features are used throughout the ArcGIS Runtime API for Android documentation and samples. To ensure code examples compile if used in your apps, set the compatibility of your app module to use Java 8. In the app module build.gradle file, within the android block, add a compileOptions directive to set the Java compatibility version:

           
    android {
      ...
      compileOptions {
        sourceCompatibility 1.8
        targetCompatibility 1.8
      }
    }

Get the API manually

If you are unable to make use of the public Gradle repository, you can instead download the SDK and add then dependencies to your project manually by including the local AAR and all dependency artifacts. You can also download a separate PDF of the Guide documentation.

Download Android SDK
  1. Sign in to ArcGIS for Developers.
  2. On your Dashboard, click Downloads, and select the latest version of ArcGIS Runtime SDK for Android.
  3. Unzip the downloaded archive to a location on your development machine.

Manually add dependencies to the ArcGIS Runtime SDK for Android or use other resources contained in the download. The Android library module (.aar), found in the libs folder, contains the API jar libraries arcgis-android-api and its third-party dependencies and core native libraries

3. Get an API key

API keys are required to access ArcGIS services, such as basemaps, geocoding, routing, and others. Visit your dashboard to get a copy of your default API key, or set custom scopes and referrers for your specific needs. Include your API key in the tutorials, samples, and sample apps where required in the instructions.

  1. Log in to your dashboard
  2. Get a copy of your default API key, or generate a new one.

4. Tutorials

Deploy your app

No license is required to develop ArcGIS Runtime apps; there is no need to authorize your development machine or devices. As a member of the ArcGIS Developer Program, you have a free ArcGIS Developer Subscription (Essentials Plan). With this plan you can download and install any ArcGIS API and immediately have access to all the functionality of the APIs for development purposes. You can become a member of the developer program for free.

You must have an ArcGIS Developer Subscription with a plan in order to deploy your app to your users. The Essentials plan is free.

Go to dashboard, get your license string.

Learn more about Runtime licensing at license and deployment.

Next steps