Get global data

Learn how to query global demographic information with the GeoEnrichment service.

Query demographic data using API key authentication

The GeoEnrichment service provides global demographic data for 170 countries and regions. To get globally available information, you use the KeyGlobalFacts data collection, which returns information for the total population, total households, average household size, and total population for males and females for a study area.

In this tutorial, you use ArcGIS REST JS to access the GeoEnrichment service and display global data for Eastern Europe.

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.

You can choose one of the following to create a new CodePen:

Option 1: Complete the Display a map tutorial; or,
Option 2: Start from the Display a map tutorial .

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 > Basemaps
  - 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.

Expand
Use dark colors for code blocks
    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN"
Expand

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
    /* Use for user authentication */
    const session = 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!

Add references to ArcGIS REST JS

Reference the request and demographics modules from ArcGIS REST JS.

Expand
Use dark colors for code blocks

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
  <script src="https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.js"></script>
  <link href="https://unpkg.com/maplibre-gl@4/dist/maplibre-gl.css" rel="stylesheet" />

  <script src="https://unpkg.com/@esri/arcgis-rest-request@4/dist/bundled/request.umd.js"></script>
  <script
    src="https://unpkg.com/@esri/arcgis-rest-demographics@4/dist/bundled/demographics.umd.js"></script>

  <style>
    html,
    body,
    #map {
      padding: 0;
      margin: 0;
      height: 100%;
      width: 100%;
      font-family: Arial, Helvetica, sans-serif;
      font-size: 14px;
      color: #323232;
    }
  </style>
</head>
Expand

Update the map position

The GeoEnrichment service has data sources for many countries around the world, including most of Europe. Change the position of the map to center on eastern Europe.

Update the center parameter to [18.88, 47.33] and set zoom to 5.

Expand
Use dark colors for code blocks
    /* Use for API key authentication */
    const accessToken = "YOUR_ACCESS_TOKEN";

    // or

    /* Use for user authentication */
    // const session = 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: "YOUR_PORTAL_URL" // Your portal URL
    // })

    // const accessToken = session.token;
    const basemapEnum = "arcgis/outdoor";

    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,

      zoom: 5, // starting zoom
      center: [18.88, 47.33] // starting location [longitude, latitude]

    });
Expand

Add a click event handler

You need a location before calling the GeoEnrichment service. To get a location, you can add a handler to the Map's click event. The click handler will be called with an object containing a LngLat.

You can change the mouse cursor to a crosshair to make it easier to click precisely. Use map.getCanvas to get the canvas, then modify its style property.

After the map initialization code, set the mouse cursor style to crosshair.

Expand
Use dark colors for code blocks
    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,

      zoom: 5, // starting zoom
      center: [18.88, 47.33] // starting location [longitude, latitude]

    });

    map.getCanvas().style.cursor = "crosshair";
Expand

Add an async handler for the click event.

Expand
Use dark colors for code blocks
    map.getCanvas().style.cursor = "crosshair";

    map.on("click", async (e) => {
      // e.lngLat contains the clicked location

    });
Expand

Execute the query

You pass one or more study areas to arcgisRest.queryDemographicData to specify the location of your query. To query a buffer around a point, pass a geometry object with x and y parameters. The default search radius is one mile.

Create a new arcgisRest.accessToken to access the feature service.

Expand
Use dark colors for code blocks
    const map = new maplibregl.Map({
      container: "map", // the id of the div element
      style: `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapEnum}?token=${accessToken}`,

      zoom: 5, // starting zoom
      center: [18.88, 47.33] // starting location [longitude, latitude]

    });

    const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
Expand

Inside the click handler, call arcgisRest.queryDemographicData. Set the studyAreas parameter to a point geometry made from the event's lngLat property. Set the dataCollections parameter to to ["KeyGlobalFacts"] to obtain global data for your location.

queryDemographicData is an asynchronous function. Using await, and declaring the click handler async, means the rest of the click handler will wait for a response from the GeoEnrichment service before continuing.

Expand
Use dark colors for code blocks
    map.on("click", async (e) => {
      // e.lngLat contains the clicked location

      const response = await arcgisRest.queryDemographicData({
        studyAreas: [
          {
            geometry: {
              x: e.lngLat.lng,
              y: e.lngLat.lat
            }
          }
        ],
        dataCollections: ["KeyGlobalFacts"],
        authentication: authentication
      });

    });
Expand

Show a pop-up

If the query is successful, the response will contain a results array with a value containing a FeatureSet. The FeatureSet contains attributes such as population within the study area, the number of males and females, and the average household size. A message will display if there is no data available for a location selected. To learn more, visit the GeoEnrichment service page.

You can use a pop-up to show the results of the query at the location where you clicked on the map.

To add a pop-up to the map, you use the Popup class in MapLibre GL JS. See the Display a pop-up tutorial for more information.

Set a variable containing the contents of the pop-up, using values from the query response.

Expand
Use dark colors for code blocks
      const response = await arcgisRest.queryDemographicData({
        studyAreas: [
          {
            geometry: {
              x: e.lngLat.lng,
              y: e.lngLat.lat
            }
          }
        ],
        dataCollections: ["KeyGlobalFacts"],
        authentication: authentication
      });

      let message;
      const featureSet = response.results[0].value.FeatureSet;
      if (featureSet.length > 0 && featureSet[0].features.length > 0) {
        const attributes = featureSet[0].features[0].attributes;
        message =
          `<b>Data for a 1 mile search radius</b><br>` +
          [
            `Population: ${attributes.TOTPOP.toLocaleString()}`,
            `Males: ${attributes.TOTMALES.toLocaleString()}`,
            `Females: ${attributes.TOTFEMALES.toLocaleString()}`,
            `Average household size: ${attributes.AVGHHSZ}`
          ].join("<br>");

      } else {
        message = "Data not available for this location.";
      }
Expand

Create a Popup to display a message containing demographic attributes, and add it to the map at the clicked location.

Expand
Use dark colors for code blocks
      } else {
        message = "Data not available for this location.";
      }

      const popup = new maplibregl.Popup().setHTML(message).setLngLat(e.lngLat).addTo(map);
Expand