Get global data

Learn how to query global demographic information for locations around the world with the GeoEnrichment service.

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

You need an ArcGIS Location Platform or ArcGIS Online account.

Steps

Create a new pen

To get started, either complete the Display a map tutorial or .

Get an access token

You need an access token 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.

In CodePen, update the accessToken variable to use your access token.

Use dark colors for code blocks
const accessToken = "YOUR_ACCESS_TOKEN";
const basemapEnum = "arcgis/streets";
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: 12, // starting zoom
  center: [-118.805, 34.027] // starting location [longitude, latitude]
});

To learn about the other types of authentication available, go to Types of authentication.

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
      const accessToken = "YOUR_ACCESS_TOKEN";
      const basemapEnum = "arcgis/streets";

      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