Get local data

Learn how to access local data, such as spending trends, for the United States with the GeoEnrichment service.

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

Steps

Create a new pen

1. To get started, you can complete the Display a map tutorial or use the Display a map tutorial solution (CodePen).

Get an access token

You need an access token with the correct privileges to access the resources used in this tutorial.

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

2. Copy the API key access token to your clipboard when prompted.

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

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
         const map = L.map("map", {
           minZoom: 2
         })
   
         map.setView([34.02, -118.805], 13);
   
         const accessToken = "YOUR_ACCESS_TOKEN";
   
         const basemapEnum = "arcgis/streets";
   
         L.esri.Vector.vectorBasemapLayer(basemapEnum, {
           token: accessToken
         }).addTo(map);
   

4. Run the code to ensure the basemap is displayed in the map.

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

Add references to ArcGIS REST JS

1. Reference the demographics and request modules from ArcGIS REST JS.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
       <!-- Load Leaflet from CDN -->
       <link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css" crossorigin="" />
       <script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js" crossorigin=""></script>
   
       <!-- Load Esri Leaflet from CDN -->
       <script src="https://unpkg.com/esri-leaflet@3.0.12/dist/esri-leaflet.js"></script>
       <script src="https://unpkg.com/esri-leaflet-vector@4.2.5/dist/esri-leaflet-vector.js"></script>
   
       <!-- Load ArcGIS REST JS libraries from https://unpkg.com -->
       <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>
   

   Expand

Update the map

1. Center the map on [-86.7679, 36.1745] and set the zoom level to 12. Change the basemapEnum to arcgis/navigation.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
         const basemapEnum = "arcgis/navigation";
   
         const map = L.map("map", {
           minZoom: 2
         });
   
         map.setView([36.1745, -86.7679], 12); //Nashville, TN
   
         L.esri.Vector.vectorBasemapLayer(basemapEnum, {
           token: accessToken
         }).addTo(map);
   

   Expand

Add a click handler

When you click on the map, your application will display local data for the area near the clicked location. Use a click handler to retrieve the coordinates of the click.

1. Create a function called getDemographicData that takes the latlng coordinates as a parameter.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
         L.esri.Vector.vectorBasemapLayer(basemapEnum, {
           token: accessToken
         }).addTo(map);
   
         function getDemographicData(latlng) {
   
         }
   
   

   Expand

2. Add a click event handler. Inside, call getDemographicData with the LatLng of the clicked location.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
         L.esri.Vector.vectorBasemapLayer(basemapEnum, {
           token: accessToken
         }).addTo(map);
   
         function getDemographicData(latlng) {
   
         }
   
         map.on("click", (e) => {
           getDemographicData(e.latlng);
         });
   

   Expand

Execute the query

Use the queryDemographicData operation to retrieve local data. To query a circular buffer around a point, pass a geometry object with x and y coordinates The default search radius is one mile.

1. Create a new ApiKeyManager using your API key.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
         L.esri.Vector.vectorBasemapLayer(basemapEnum, {
           token: accessToken
         }).addTo(map);
   
         const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
   
         function getDemographicData(latlng) {
   
         }
   

   Expand

2. Access the GeoEnrichment service with queryDemographicData. Set the studyAreas parameter to a point geometry made from the event's lngLat property. Also pass the authentication object.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
         function getDemographicData(latlng) {
   
           arcgisRest
             .queryDemographicData({
               studyAreas: [{ geometry: { x: latlng.lng, y: latlng.lat } }],
               authentication: authentication,
   
             })
   
         }
   

   Expand

3. Set the analysisVariables parameter with the following analysis variables:

   • Buys Natural Products (PsychographicsShopping.MP28067A_B)
   • Auto/Truck Rental on Trips (transportation.X7027_I)
   • Membership fees for Social Clubs (entertainment.X9005_I)
   • Tapestry group name (lifemodegroupsNEW.TLIFENAME)
   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
           arcgisRest
             .queryDemographicData({
               studyAreas: [{ geometry: { x: latlng.lng, y: latlng.lat } }],
               authentication: authentication,
   
               analysisVariables: [
                 "PsychographicsShopping.MP28067A_B",
                 "transportation.X7027_I",
                 "entertainment.X9005_I",
                 "lifemodegroupsNEW.TLIFENAME"
               ],
   
             })
   

   Expand

Display results

If the query is successful, the response will contain a results array with a value containing a FeatureSet. The FeatureSet contains demographic 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, go to Data enrichment chapter in the Mapping and location services guide.

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

1. Access the response FeatureSet in a callback function and check to see if it contains data. If data was returned, access the feature attributes to retrieve demographic information.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
         function getDemographicData(latlng) {
   
           arcgisRest
             .queryDemographicData({
               studyAreas: [{ geometry: { x: latlng.lng, y: latlng.lat } }],
               authentication: authentication,
   
               analysisVariables: [
                 "PsychographicsShopping.MP28067A_B",
                 "transportation.X7027_I",
                 "entertainment.X9005_I",
                 "lifemodegroupsNEW.TLIFENAME"
               ],
   
             })
   
             .then((response) => {
               const featureSet = response.results[0].value.FeatureSet;
               let message;
   
               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>" +
                   [
                     `Buys Natural Products: ${attributes.MP28067a_B}`,
                     `Membership fees for Social Clubs: ${attributes.X9005_I}`,
                     `Auto/Truck Rental on Trips: ${attributes.X7027_I}`,
                     `Tapestry group name: ${attributes.TLIFENAME}`
                   ].join("<br>");
               } else {
                 message = "Data not available for this location.";
               }
   
             });
   
         }
   

   Expand

2. Display a Popup at the clicked location containing the demographic information.

   Expand

   Use dark colors for code blocks

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
   100
   101
   102
   103
   104
             .then((response) => {
               const featureSet = response.results[0].value.FeatureSet;
               let message;
   
               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>" +
                   [
                     `Buys Natural Products: ${attributes.MP28067a_B}`,
                     `Membership fees for Social Clubs: ${attributes.X9005_I}`,
                     `Auto/Truck Rental on Trips: ${attributes.X7027_I}`,
                     `Tapestry group name: ${attributes.TLIFENAME}`
                   ].join("<br>");
               } else {
                 message = "Data not available for this location.";
               }
   
               var popup = L.popup().setLatLng(latlng).setContent(message).openOn(map);
   
             });
   

   Expand

Run the app

In CodePen, run your code to display the map.

You should now see a map centered over Nashville. Click on the map to access the GeoEnrichment service to return local information and view the results in a popup.

What's next?

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