Get local data

Learn how to access local data for the United States with the ArcGIS GeoEnrichment serviceA GeoEnrichment service is a service that aggregates demographic data and local facts for locations around the world. It is used to provide insight about the people and places near a location. It is hosted by Esri as the ArcGIS GeoEnrichment service and can also be hosted in ArcGIS Enterprise.Learn more.

The ArcGIS GeoEnrichment serviceA GeoEnrichment service is a service that aggregates demographic data and local facts for locations around the world. It is used to provide insight about the people and places near a location. It is hosted by Esri as the ArcGIS GeoEnrichment service and can also be hosted in ArcGIS Enterprise.Learn more provides detailed local data for specific countries. Each individual data field is represented by an analysis variableAn analysis variable is a data field name that defines which data to query and return from the GeoEnrichment service.Learn more 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, use ArcGIS REST JS to access the GeoEnrichment service and display spending trend information for a study area within the United States.

Prerequisites

Steps

Get the starter app

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

Set up authentication

Set developer credentials

Use the API key or OAuth developer credentialsDeveloper credentials are a type of item in a portal that contains parameters for authentication. There are two types of developer credentials: API key credentials and OAuth credentials.Learn more so your application can access ArcGIS servicesA 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.

Add references to ArcGIS REST JS

This tutorial uses ArcGIS REST JS to access the GeoEnrichment service. It also uses the ol-popup library to display pop-ups.

1. Reference the ArcGIS REST JS and ol-popup libraries.

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
       <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/ol@v10.9.0/ol.css">
       <script src="https://cdn.jsdelivr.net/npm/ol@v10.9.0/dist/ol.js"></script>
       <script src="https://cdn.jsdelivr.net/npm/ol-mapbox-style@13.4.1/dist/olms.js"></script>
       <script src="https://unpkg.com/ol-popup@5.1.1/dist/ol-popup.js"></script>
       <link rel="stylesheet" href="https://unpkg.com/ol-popup@5.1.1/src/ol-popup.css">
   
       <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. Update the center parameter to [-86.7679, 36.1745] and set zoom to 12.

   Expand

   Use dark colors for code blocksCopy

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
       map.setView(
         new ol.View({
   
           center: ol.proj.fromLonLat([-86.7679, 36.1745]),
           zoom: 12
   
         })
       );
   

   Expand

2. Update the basemapId to arcgis/navigation.

   Expand

   Use dark colors for code blocksCopy

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
       const basemapId = "arcgis/navigation";
   
       const basemapURL = `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapId}?token=${accessToken}`;
   
       olms.apply(map, basemapURL).then(function (map) {
   
   

   Expand

Add a click event handler

You need a locationA location is a position or region (point, line, or polygon) on the earth's surface.Learn more before calling the GeoEnrichment serviceA GeoEnrichment service is a service that aggregates demographic data and local facts for locations around the world. It is used to provide insight about the people and places near a location. It is hosted by Esri as the ArcGIS GeoEnrichment service and can also be hosted in ArcGIS Enterprise.Learn more. 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 Coordinate.

You can change the mouse cursor to a crosshair to make it easier to click precisely. Modify the CSS style of its canvas element to do this.

1. In the <style> , set the mouse cursor style to crosshair.

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
       <style>
       html,
       body,
       #map {
         padding: 0;
         margin: 0;
         height: 100%;
         width: 100%;
         font-family: Arial, Helvetica, sans-serif;
         font-size: 14px;
         color: #323232;
       }
   
   
       #map canvas {
         cursor: crosshair;
       }
   
       .ol-popup {
         width: 250px;
       }
   
       </style>
   

   Expand

2. Add a handler for the click event. Inside, convert the click coordinate to a longitude and latitude and save it in a variable.

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
       olms.apply(map, basemapURL).then(function (map) {
   
         map.on("click", (event) => {
   
           const lonLat = ol.proj.toLonLat(event.coordinate);
   
         });
   
         // Add Esri attribution
         // Learn more in https://esriurl.com/attribution
         const source = map.getLayers().item(0).getSource();
         const poweredByEsriString = "Powered by <a href='https://www.esri.com/en-us/home' target='_blank'>Esri</a> | ";
   
         const attributionFn = source.getAttributions();
         if (attributionFn) {
           source.setAttributions((ViewStateLayerStateExtent) => {
             return [poweredByEsriString, ...attributionFn(ViewStateLayerStateExtent)];
           });
         } else source.setAttributions(poweredByEsriString);
   
       });
   

   Expand

Execute the query

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

1. Inside the click handler, create a new arcgisRest.ApiKeyManager to access the GeoEnrichment service. Call the service using queryDemographicData. Set the studyAreas parameter to a pointA point is a type of geometry containing a single set of x,y coordinates and a spatial reference.Learn more geometry made from the event's lngLat property.

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
         map.on("click", (event) => {
   
           const lonLat = ol.proj.toLonLat(event.coordinate);
   
           const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
   
           arcgisRest
             .queryDemographicData({
               studyAreas: [{ geometry: { x: lonLat[0], y: lonLat[1] } }],
               authentication: authentication,
   
             })
   
         });
   

   Expand

2. 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)
   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
           const authentication = arcgisRest.ApiKeyManager.fromKey(accessToken);
   
           arcgisRest
             .queryDemographicData({
               studyAreas: [{ geometry: { x: lonLat[0], y: lonLat[1] } }],
               authentication: authentication,
   
               analysisVariables: [
                 "PsychographicsShopping.MP28067A_B",
                 "transportation.X7027_I",
                 "entertainment.X9005_I"
               ]
   
             })
   

   Expand

Display the results

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. To learn more, visit the GeoEnrichment service page.

You will display the results of the query in a pop-up.

1. Before the click handler, create a Popup and save it to a popup variable. Add it to the map with map.addOverlay.

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
       const basemapId = "arcgis/navigation";
   
       const basemapURL = `https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/${basemapId}?token=${accessToken}`;
   
       olms.apply(map, basemapURL).then(function (map) {
   
         const popup = new Popup();
         map.addOverlay(popup);
   

   Expand

2. Add a then handler to the queryDemographicData call. Inside, store the FeatureSet from the first result in a variable.

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
           arcgisRest
             .queryDemographicData({
               studyAreas: [{ geometry: { x: lonLat[0], y: lonLat[1] } }],
               authentication: authentication,
   
               analysisVariables: [
                 "PsychographicsShopping.MP28067A_B",
                 "transportation.X7027_I",
                 "entertainment.X9005_I"
               ]
   
             })
   
             .then((response) => {
   
               const featureSet = response.results[0].value.FeatureSet;
   
             });
   

   Expand

3. If the FeatureSet contains data, use its attributes to build a message to show. Use popup.show to display the message at the location of the mouse click. Otherwise, display a "Data not available" message.

   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
   105
   106
   107
   108
   109
   110
   111
   112
   113
   114
   115
   116
   117
   118
   119
   120
   121
   122
   123
   124
   125
   126
   127
   128
   129
   130
   131
   132
   133
   134
   135
   136
   137
   138
   139
   140
   141
   142
   143
   144
               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}`
                   ].join("<br>");
               } else {
                 message = "Data not available for this location.";
               }
               popup.show(event.coordinate, message);
   

   Expand

Run the app

Run the app.

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 location services in these tutorials: