Get started

There are a number of ways to get started to develop with ArcGIS Maps SDK for Flutter. If you are new, follow the steps below to get started with Flutter and Visual Studio Code.

1. Sign up for an account

To use ArcGIS Maps SDK for Flutter to access content Content is a collection of items in a portal that belong to a user, group, or organization. Learn more , services A 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 organization, you need an ArcGIS Location Platform account An 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 account An 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 account An 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. Get the SDK and dependencies

Install Flutter:

1. Choose a supported development platform to get started. ArcGIS Maps SDK for Flutter supports macOS or Windows as a development platform.
2. Select a target platform (iOS or Android).
3. Follow the instructions.

Get the ArcGIS Maps SDK for Flutter:

Inside of VS Code’s terminal

1. Run: dart pub add arcgis_maps.
2. Run: flutter pub upgrade.
3. Lastly, run dart run arcgis_maps install.

3. Choose a type of authentication

To access secure ArcGIS services and resources, you need to implement authentication. The easiest way to get started is to obtain an access token An 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 from an API Key An 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 and implement API key authentication API key authentication is a type of authentication that uses an API key to authenticate requests to ArcGIS services and secure portal items. Learn more . If you want to build an app that requires users to sign in with their ArcGIS account, implement user authentication User authentication is a type of authentication that allows users with an ArcGIS account to sign into an application and allow it to access ArcGIS content, services, and resources on their behalf. The typical authorization protocol used is OAuth2.0. Learn more .

4. Create your first mapping application

Follow step-by-step instructions in the Display a map tutorial to create your first mapping application. The following snippet shows the main code in the tutorial to display a map:

// Authenticate your application using a supported method:
// - API key authentication
// - User authentication

@override
Widget build(BuildContext context) {
  return Scaffold(
    // Add a map view to the widget tree and set a controller and a map with a basemap style.
    body: ArcGISMapView(
      controllerProvider: () => ArcGISMapView.createController()
        // Creates a map with the topographic basemap style.
        ..arcGISMap = ArcGISMap.withBasemapStyle(BasemapStyle.arcGISTopographic),
    ),
  );
}

Once you are done building your application, make sure to license it before deploying to production. For more information, see License and deployment topic for details.

5. Find more tutorials

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

Display a map

Create a map that uses a basemap service layer and zoom to a specified location.

Add a point, line, and polygon

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

6. Explore the samples

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

Display map

Display a map with an imagery basemap.

Display a scene

Display a scene with a terrain surface and some imagery.

Show device location

Display your current position on the map, as well as switch between different types of auto pan modes.

Find route

Display directions for a route between two points.