Get local data

Learn how to access the GeoEnrichment service.

Geocode and search using API key authentication

The GeoEnrichment service provides detailed local data for specific countries. Each individual data field is represented by an analysis variable that are organized into data categories such as spending and market behaviors such as 2022 Educational Attainment or 2022 Seen Video Ad at Gas Station Last 30 Days. The data available vary by country and by data provider.

In this tutorial, you use ArcGIS REST JS to access the GeoEnrichment service and display spending trend information for a study area within the United States.

Prerequisites

An ArcGIS Location Platform or ArcGIS Online account.

Steps

Get the starter app

Select a type of authentication below and follow the steps to create a new application.

If you are using the CDN libraries, to get started.

Set up authentication

Create developer credentials in your portal for the type of authentication you selected.

Create a new API key credential with the correct privileges to access the resources used in this tutorial.

Go to the Create an API key tutorial and create an API key with the following privilege(s):
- Privileges:
  - Location services > Data enrichment
Copy the API key access token to your clipboard when prompted.

Set developer credentials

Use the API key or OAuth developer credentials so your application can access location services.

Update the accessToken variable to use your API key.

Use dark colors for code blocks
    const accessToken = "YOUR_ACCESS_TOKEN";

In both the index.html and callback.html files, replace YOUR_CLIENT_ID and YOUR_REDIRECT_URL with the client ID and redirect URL of your OAuth credentials.

index.html
Use dark colors for code blocks
    const authentication = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
       clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
       redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
       portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

callback.html
Use dark colors for code blocks
    arcgisRest.ArcGISIdentityManager.completeOAuth2({
      clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
      redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
      portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    })

Run the app and ensure you can sign in successfully.

If you are unable to sign in, make sure you have the correct redirect URL and port. This URL varies based on your application and typically takes the format of https://<server>[:port]/callback.html or http://my-arcgis-app:/auth. For example, if you are running an application on http://127.0.0.1:5500/, set http://127.0.0.1:5500/callback.html as your redirect URL in the index.html and callback.html file and your developer credential. They all have to match!

Make the request

You can copy and paste the code below, following the steps to make a request to the GeoEnrichment service.

Reference the arcgis-rest-request and arcgis-rest-demographics libraries either through CDN, ES Modules, or Node JS.
Define the parameters needed for the request. For local data set the analysisVariables parameter.
Call the GeoEnrichment service and handle the results.

Expand
Use dark colors for code blocks
  <script>
    /* when including ArcGIS REST JS all exports are available
  from the same arcgisRest global */
    /* Use for API key authentication */

    const accessToken = "YOUR_ACCESS_TOKEN";
    const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);

    // or

    /* Use for user authentication */
    // const authentication = await arcgisRest.ArcGISIdentityManager.beginOAuth2({
    //   clientId: "YOUR_CLIENT_ID", // Your client ID from OAuth credentials
    //   redirectUri: "YOUR_REDIRECT_URL", // The redirect URL registered in your OAuth credentials
    //   portal: "https://www.arcgis.com/sharing/rest" // Your portal URL
    // })

    arcgisRest
      .queryDemographicData({
        studyAreas: [{ "geometry": { "x":-74.0060,"y":40.7128 } }],
        authentication: authentication,
        analysisVariables: [
          "PsychographicsShopping.MP28067A_B",
          "transportation.X7027_I",
          "entertainment.X9005_I",
          "lifemodegroupsNEW.TLIFENAME"
        ]
      })
      .then((response) => {
        console.log("Demographics:", response);
        document.getElementById("result").textContent = JSON.stringify(response, null, 2);
      });

  </script>
Expand

Run the app

Run the app.

The result should look similar to this.

What's next?

Learn how to use additional ArcGIS location services in these tutorials:

Get global data

Query demographic information for locations around the world with the GeoEnrichment service.

Edit feature data

Add, update, and delete data in a hosted feature layer.

Find place addresses

Find coffee shops, gas stations, restaurants and other nearby places by accessing the Geocoding service.