Street address locations

Locations can be passed as input street addresses. This form of a study area will find the location of a street address, point of interest, place names or other supported location as a single string ("380 New York St, Redlands, CA") and the service returns a coordinate pair representing the address ("-117.1956, 34.0576"). Once a matched address is returned, you can create a buffer ring or drive-time service area around the point to aggregate data for the study area. Multiple addresses can also be passed as study areas and only matched addresses will be returned with enrichment data. By default, the service will create a 1-mile ring buffer around the matched address location to collect and append enrichment data. You can optionally change the ring buffer size or create drive-time service areas around the point.

When street address strings are used as study area locations, geocoding of the location and enrichment occurs in a single call to the GeoEnrichment service. More specifically, determining the location of matched addresses, creating study area buffers around those points and the data aggregation and enrichment all seamlessly occur within the same request.

The service supports the geocoding parameters of the ArcGIS Online World Geocoding service.

Request parameters

ParameterDetails

studyAreas

Required parameter to specify a list of input features to be enriched. Input locations can be defined as points described as street addresses.

Examples

Example 1 - Point described as a single line address:

studyAreas=[{"address":{"text":"380 New York St. Redlands, CA 92373"}}]

Example 2 – Point described as multiple field input addresses:

studyAreas=[{"address":{"Address":"380 New York St.","Admin1":"Redlands","Admin2":"CA","Postal":"92373","CountryCode":"USA"}}]

Example 3 – Multiple points described as multiple single line input addresses:

studyAreas=[{"address":{"text":"12 Concorde Place Toronto ON M3C 3R8","sourceCountry":"Canada"}},{"address":{"text":"380 New York St Redlands CA 92373","sourceCountry":"US"}}]

Example 4 – Multiple points described as multiple single line input addresses and change the ring buffer size for each point:

studyAreas=[{"address":{"text":"12 Concorde Place Toronto ON M3C 3R8","sourceCountry":"Canada"},"areaType":"RingBuffer","bufferUnits":"esriKilometers","bufferRadii":[3]},{"address":{"text":"380 New York St Redlands CA 92373","sourceCountry":"US"},"areaType":"RingBuffer","bufferUnits":"esriMiles","bufferRadii":[2]}]

Additional notes

  • When points are specified, the service will analyze the map areas surrounding or associated with the input point locations.
  • All input feature attributes, if provided, will be carried over into the output response. If the input attributes are unique to each input feature, this behavior can be leveraged to uniquely bind or associate the input features with the corresponding output features.
  • If the input features are submitted without attributes, the "id" attribute will be appended to each feature in the output response. The "id" attribute values will represent the zero-based array index of the input features submitted with the studyAreas parameter.
  • Only matched (successfully geocoded) addresses will be enriched.
  • The request sent to the service cannot be greater than 10mb.
  • Currently, a maximum of 100 features can be enriched with the service per request.

dataCollections

Optional parameter to specify a list of Data Collections.

A Data Collection is a preassembled list of attributes that will be used to enrich the input features. Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas.

Default value

["KeyGlobalFacts"]

A standard list of enrichment attributes.

Examples

Example 1:

dataCollections=["KeyGlobalFacts"]

Example 2:

dataCollections=["KeyUSFacts"]

Example 3:

dataCollections=["KeyGlobalFacts","KeyUSFacts"]

Additional notes

analysisVariables

Optional parameter to specify a subset of variables to be returned from one or more Data Collections.

A Data Collection is a preassembled list of attributes that will be used to enrich the input features. With the analysisVariables parameter you can return a subset of variables Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas.

Examples

Example 1:

analysisVariables=["KeyGlobalFacts.TOTPOP"]

Example 2:

analysisVariables=["KeyGlobalFacts.TOTPOP", "AGE.MALE0", "AGE.MALE5"]

Example 3:

analysisVariables=["KeyGlobalFacts.TOTPOP", "AGE.* "]

Additional notes

  • The Data Collection for an analysis variable should be appended before an analysis variable.
  • Usage and metering will only be based on the number of variables that are returned
  • You can use an asterisk to return all variables for a given data collection (e.g. "KeyGlobalFacts.*")

addDerivativeVariables

Optional parameter to specify an array of string values that describe what derivative variables to include in the output.

Examples

Example 1 - Return a data collection with the additional variables and associated metadata for percent's, averages and index values:

addDerivativeVariables=all

Example 2 - Return a data collection with the additional variables and associated metadata for index values:

addDerivativeVariables=index

Additional notes

  • The enumerated list of accepted values are as follows:

    addDerivativeVariables=percent,index,average,all,*

  • Support the use of the derivative statistics can also be performed in the enrich operation through the analysisVariables parameter.
  • Example:

    http://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/Enrich?studyareas=[{"address":{"text":"4979 Cass St. San Diego,CA 92109"}}]&analysisvariables=["TravelCEX.X7001_X"]&addDerivativeVariables=index,average&f=pjson

    {
      "results" : [ {
        "paramName" : "GeoEnrichmentResult",
        "dataType" : "GeoEnrichmentResult",
        "value" : {
          "version" : "2.0",
          "FeatureSet" : [ {
            "displayFieldName" : "",
            "fieldAliases" : {
              "ID" : "ID",
              "OBJECTID" : "Object ID",
              "sourceCountry" : "sourceCountry",
              "areaType" : "areaType",
              "bufferUnits" : "bufferUnits",
              "bufferUnitsAlias" : "bufferUnitsAlias",
              "bufferRadii" : "bufferRadii",
              "aggregationMethod" : "aggregationMethod",
              "HasData" : "HasData",
              "X7003_X" : "Airline Fares",
              "X7003_X_I" : "Airline Fares: Index"
            },
            "spatialReference" : {
              "wkid" : 4326,
              "latestWkid" : 4326
            },
            "fields" : [ {
              "name" : "ID",
              "type" : "esriFieldTypeString",
              "alias" : "ID",
              "length" : 256
            }, {
              "name" : "OBJECTID",
              "type" : "esriFieldTypeOID",
              "alias" : "Object ID"
            }, {
              "name" : "sourceCountry",
              "type" : "esriFieldTypeString",
              "alias" : "sourceCountry",
              "length" : 256
            }, {
              "name" : "areaType",
              "type" : "esriFieldTypeString",
              "alias" : "areaType",
              "length" : 256
            }, {
              "name" : "bufferUnits",
              "type" : "esriFieldTypeString",
              "alias" : "bufferUnits",
              "length" : 256
            }, {
              "name" : "bufferUnitsAlias",
              "type" : "esriFieldTypeString",
              "alias" : "bufferUnitsAlias",
              "length" : 256
            }, {
              "name" : "bufferRadii",
              "type" : "esriFieldTypeDouble",
              "alias" : "bufferRadii"
            }, {
              "name" : "aggregationMethod",
              "type" : "esriFieldTypeString",
              "alias" : "aggregationMethod",
              "length" : 256
            }, {
              "name" : "HasData",
              "type" : "esriFieldTypeInteger",
              "alias" : "HasData"
            }, {
              "name" : "X7003_X",
              "type" : "esriFieldTypeDouble",
              "alias" : "Airline Fares",
              "fullName" : "TravelCEX.X7003_X",
              "component" : "demographics",
              "decimals" : 0,
              "units" : "currency",
              "currency" : "$"
            }, {
              "name" : "X7003_X_I",
              "type" : "esriFieldTypeInteger",
              "alias" : "Airline Fares: Index",
              "fullName" : "TravelCEX.X7003_X_I",
              "decimals" : 0,
              "units" : "other"
            } ],
            "features" : [ {
              "attributes" : {
                "ID" : "0",
                "OBJECTID" : 1,
                "sourceCountry" : "US",
                "areaType" : "RingBuffer",
                "bufferUnits" : "esriMiles",
                "bufferUnitsAlias" : "mile",
                "bufferRadii" : 1,
                "aggregationMethod" : "BlockApportionment:US.BlockGroups",
                "HasData" : 1,
                "X7003_X" : 4691891,
                "X7003_X_I" : 103
              }
            } ]
          } ]
        }
      } ],
      "messages" : [ ]
    }

studyAreasOptions

Optional parameter to specify enrichment behavior. For points described as map coordinates, a 1-mile ring area centered on each site will be used by default. You can use this parameter to change these default settings.

With this parameter, the caller can override the default behavior describing how the enrichment attributes are appended to the input features described in studyAreas. For example, you can change the output ring buffer to 5-miles, change the number of output buffers created around each point, and change the output buffer type to a drive-time service area rather than a simple ring buffer.

Default value

(null or empty)

The default behavior will be followed.

Examples

Example 1 - Use 1, 2, and 3-mile ring areas each originating at the point-based sites described in studyAreas:

studyAreasOptions={"areaType":"RingBuffer","bufferUnits":"esriMiles","bufferRadii":[1,2,3]}

Example 2 - Use 1, 3, and 5-kilometer banded ring areas centered on the point-based sites described in studyAreas:

studyAreasOptions={"areaType":"RingBufferBands","bufferUnits":"esriKilometers","bufferRadii":[1,3,5]}

Example 3 - Use 5-minute drive-time-based ring areas centered on the point-based sites described in studyAreas:

studyAreasOptions={"areaType":"DriveTimeBuffer","bufferUnits":"esriDriveTimeUnitsMinutes","bufferRadii":[5]}

Example 4 - Use 3, 5, and 7-minute drive-time-based banded ring areas centered on the point-based sites described in studyAreas:

studyAreasOptions={"areaType":"DriveTimeBufferBands","bufferUnits":"esriDriveTimeUnitsMinutes","bufferRadii":[3,5,7]}

Additional notes

  • Banded ring areas define radial bands which do not necessarily originate from the ring center. For example, 1, 3, and 5-mile "ring bands" describe a 0-to-1 mile band, 1-to-3 mile band, and 3-to-5 mile band.
  • Examples 1 through 4 above can be used on the enrichment of point-based study areas only.

useData

Optional parameter to explicitly specify the country or dataset to query.

When all input features specified in the studyAreas parameter describe locations or areas that lie in the same country or dataset, this optional parameter can be specified to provide an additional "performance hint" to the service.

By default, the service will automatically determine the country or dataset that is associated with each location or area submitted in the studyAreas parameter; however, there is an associated computational cost that can lengthen the time it takes to return a response. To skip this intermediate step and potentially improve the speed and performance of the service, the caller can specify the country or dataset information up front through this parameter.

Default value

(null or empty)

The default behavior will be followed.

Examples

Example 1 - Indicate to the service that all of the input features in the studyAreas parameter describe locations or areas in the U.S:

useData={"sourceCountry":"US"}

Example 2 - Indicate to the service that all of the input features in the studyAreas parameter describe locations or areas in the U.S. USA_ESRI_2017 dataset:

useData={"sourceCountry":"US","dataset":"USA_ESRI_2017"}

Example 3 - Indicate to the service that the most detailed data apportionment method will be used regardless of the size of the study area:

useData={"detailedDataAggregation":"true"}

Additional notes

  • GeoEnrichment is available for a number of countries described in the coverage section of the documentation. New countries will be added in the future.
  • Use the countries discovery method to obtain a list of available datasets:

    http://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/Countries/United States?f=pjson

    {
     "countries": [
      {
       "id": "US",
       "name": "United States",
       "abbr3": "USA",
       "altName": "UNITED STATES",
       "continent": "North America",
       "distanceUnits": "Miles",
       "esriUnits": "esriMiles",
       "defaultExtent": {
        "xmin": -178.48633078029144,
        "ymin": 18.871742416926232,
        "xmax": -66.90765216180796,
        "ymax": 71.403759083950263
       },
       "defaultDatasetID": "USA_ESRI_2017",
       "datasets": [
        "LANDSCAPE",
        "USA_ACS_2016",
        "USA_ASR_2016",
        "USA_ESRI_2016",
        "USA_RMP_2016"
       ],
       "hierarchies": [
        {
         "ID": "census",
         "datasets": [
          "USA_ACS_2017",
          "USA_ASR_2017",
          "USA_ESRI_2017",
          "USA_RMP_2017"
         ]
        },
        {
         "ID": "landscape",
         "datasets": [
          "LANDSCAPE"
         ]
        }
       ],
       "defaultDataCollection": "KeyGlobalFacts",
       "dataCollections": "",
       "defaultReportTemplate": "Demographic and Income Profile",
       "currencySymbol": "$",
       "currencyFormat": "$0;-$0"
      }
     ]
    }

Note:

You can now navigate using the ISO standardized two-digit country code for each country.

http://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/Countries/US?f=pjson

intersectingGeographies

Optional parameter to explicitly define the geographic layers used to provide geographic context during the enrichment process. For example, you can use this optional parameter to return the U.S. county and ZIP Code that each input study area intersects.

You can intersect input features defined in the studyAreas parameter with standard geography layers that are provided be the GeoEnrichment service for each country. You can also intersect features from a publicly available feature service.

The intersectingGeographies parameter should be constructed as a JSON array of an IntersectingGeographies object which consists of the following elements:

Value Description

geographyType

Used to specify the type of intersection layer. Specify standard to intersect with standard geography layers that are provided by the GeoEnrichment service for each country. Specify external to intersect features from a publicly available feature service.

layer

Specifies which Standard Geography layer should be intersected (e.g., U.S.Counties). These are an array of layers, so you can set one or many layers to intersect. These layers are defined in the Coverage section. At least one layer must be defined if geographyType is set to standard.

URL

Optional URL if you want to intersect features from an external feature service. This layer must be defined if geographyType is set to external.

name

Optional alias name of the output geography layer being intersected. For example, you can set the name of US.Counties to Counties in the GeoEnrichment output.

geometryType

Specifies how input studyAreas should intersect specified geography. If this is set to esriGeometryPoint, one intersecting feature is returned that intersects the centroid of each input polygon. If this is set to esriGeometryPolygon, all intersecting features are returned that intersect the input study area polygon.

outFields

You can optionally define the list of output fields from the intersected layer that will be appended to the GeoEnrichment response as geocontext items.

spatialRel

The optional spatial relationship to be applied on the intersecting layer. The supported spatial relationships include intersects, contains, envelope intersects, within, and so on. The default spatial relationship is intersects (esriSpatialRelIntersects).

where

You can define an optional where clause.

Default value

none

No intersecting geographies will be included in the output response.

returnGeometry

Optional parameter to request the output geometries in the response.

When this parameter is set to true, the output geometries associated with each feature will be included in the response. The output geometries will be in the spatial reference system defined by outSR.

Default value

false

The output geometries will not be returned with each feature in the response.

Examples

Example 1 - Request the output geometries in the response:

returnGeometry=true

Additional notes

  • Requesting output geometries can significantly increase the payload size of the output response which will increase the amount of time it takes to receive the response and negatively affect the speed and performance of any client applications consuming the service.

inSR

This parameter is only applicable to input study areas that are based on points or polygon geometry. This parameter is not needed and ignored for study areas based on street address locations.

Default value

(null or empty)

Additional notes

  • This parameter should only be set for Input Points and Input Polygons study area types.

outSR

Optional parameter to request the output geometries in a specified spatial reference system.

When returnGeometry is set to true, this optional parameter can be specified to explicitly indicate the spatial reference system of the output geometry. The parameter value can be specified as the well-known ID describing the projected coordinate system or geographic coordinate system.

Default value

4326

The standard latitude and longitude-based geographic coordinate system based on the WGS 1984 datum will be used.

Examples

Example 1 - Specify the output geometry in the Web Mercator (Auxiliary Sphere) projected coordinate system based on the WGS 1984 datum:

outSR=3857

Additional notes

suppressNullValues

Optional parameter to return only values that are not NULL in the output response. Adding the optional suppressNullValues parameter to any data collections discovery method will reduce the size of the output that is returned.

Default value

false

Example

suppressNullValues=true

Additional notes

  • Setting this optional parameter to true will significantly reduce the size of the output of the data collection response.
  • You will have to handle duck typed cases where some metadata may not be returned for a given variables because a value is set to NULL.

f

Optional parameter to specify the output response format.

Default value

json

The output response will be returned in HTML format.

Examples

Example 1 - Request the output geometries in JSON format:

f=json

Additional notes

  • Supported formats include JSON and XML.

Example usage

        
      

Request example 1:

Enrich a single location defined by a single-line address with attributes defined in a specified Data Collection.

http://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?StudyAreas=[{"address":{"text":"380 New York St Redlands CA 92373"}}]&dataCollections=["KeyGlobalFacts"]&f=pjson

JSON response example 1
{
 "results": [
  {
   "paramName": "GeoEnrichmentResult",
   "dataType": "GeoEnrichmentResult",
   "value": {
    "version": "2.0",
    "FeatureSet": [
     {
      "displayFieldName": "",
      "fieldAliases": {
       "ID": "ID",
       "OBJECTID": "Object ID",
       "sourceCountry": "sourceCountry",
       "X": "X",
       "Y": "Y",
       "areaType": "areaType",
       "bufferUnits": "bufferUnits",
       "bufferUnitsAlias": "bufferUnitsAlias",
       "bufferRadii": "bufferRadii",
       "aggregationMethod": "aggregationMethod",
       "HasData": "HasData",
       "TOTPOP": "Total Population",
       "TOTHH": "Total Households",
       "AVGHHSZ": "Average Household Size",
       "TOTMALES": "Male Population",
       "TOTFEMALES": "Female Population"
      },
      "spatialReference": {
       "wkid": 4326,
       "latestWkid": 4326
      },
      "fields": [
       {
        "name": "ID",
        "type": "esriFieldTypeString",
        "alias": "ID",
        "length": 256
       },
       {
        "name": "OBJECTID",
        "type": "esriFieldTypeOID",
        "alias": "Object ID"
       },
       {
        "name": "sourceCountry",
        "type": "esriFieldTypeString",
        "alias": "sourceCountry",
        "length": 256
       },
       {
        "name": "X",
        "type": "esriFieldTypeDouble",
        "alias": "X"
       },
       {
        "name": "Y",
        "type": "esriFieldTypeDouble",
        "alias": "Y"
       },
       {
        "name": "areaType",
        "type": "esriFieldTypeString",
        "alias": "areaType",
        "length": 256
       },
       {
        "name": "bufferUnits",
        "type": "esriFieldTypeString",
        "alias": "bufferUnits",
        "length": 256
       },
       {
        "name": "bufferUnitsAlias",
        "type": "esriFieldTypeString",
        "alias": "bufferUnitsAlias",
        "length": 256
       },
       {
        "name": "bufferRadii",
        "type": "esriFieldTypeDouble",
        "alias": "bufferRadii"
       },
       {
        "name": "aggregationMethod",
        "type": "esriFieldTypeString",
        "alias": "aggregationMethod",
        "length": 256
       },
       {
        "name": "HasData",
        "type": "esriFieldTypeInteger",
        "alias": "HasData"
       },
       {
        "name": "TOTPOP",
        "type": "esriFieldTypeDouble",
        "alias": "Total Population",
        "fullName": "KeyGlobalFacts.TOTPOP",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       },
       {
        "name": "TOTHH",
        "type": "esriFieldTypeDouble",
        "alias": "Total Households",
        "fullName": "KeyGlobalFacts.TOTHH",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       },
       {
        "name": "AVGHHSZ",
        "type": "esriFieldTypeDouble",
        "alias": "Average Household Size",
        "fullName": "KeyGlobalFacts.AVGHHSZ",
        "component": "scripts",
        "decimals": 2,
        "units": "count"
       },
       {
        "name": "TOTMALES",
        "type": "esriFieldTypeDouble",
        "alias": "Male Population",
        "fullName": "KeyGlobalFacts.TOTMALES",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       },
       {
        "name": "TOTFEMALES",
        "type": "esriFieldTypeDouble",
        "alias": "Female Population",
        "fullName": "KeyGlobalFacts.TOTFEMALES",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       }
      ],
      "features": [
       {
        "attributes": {
         "ID": "0",
         "OBJECTID": 1,
         "sourceCountry": "US",
         "X": -121.98618129602932,
         "Y": 37.35651377079495,
         "areaType": "RingBuffer",
         "bufferUnits": "esriMiles",
         "bufferUnitsAlias": "mile",
         "bufferRadii": 1,
         "aggregationMethod": "BlockApportionment:US.BlockGroups",
         "HasData": 1,
         "TOTPOP": 38231,
         "TOTHH": 13811,
         "AVGHHSZ": 2.77,
         "TOTMALES": 19181,
         "TOTFEMALES": 19050
        }
       }
      ]
     }
    ]
   }
  }
 ],
 "messages": []
}

Notes:

  • A 1-mile ring buffer area is generated around the input location.
  • A list of attributes describing the location's demographic characteristics and geographic context, as defined in the default Data Collection and based on the generated area, is returned in the response.
  • The service supports the geocoding parameters of the ArcGIS Online World Geocoding service.

        
      

Request example 2:

Enrich a single location defined by a single-line address with a 15 minute walk time buffer. Attributes are defined in a specified Data Collection and geometry is returned.

http://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?studyareas=[{"address":{"text":" 102 Aqua Ct New Smyrna Beach FL 32168"}}]&studyareasoptions={"areaType": "NetworkServiceArea","bufferUnits": "Minutes","bufferRadii": [15],"travel_mode":"Walking"}&dataCollections=["KeyGlobalFacts"]&returngeometry=true&f=pjson

JSON response example 2
{
 "results": [
  {
   "paramName": "GeoEnrichmentResult",
   "dataType": "GeoEnrichmentResult",
   "value": {
    "version": "2.0",
    "FeatureSet": [
     {
      "displayFieldName": "",
      "fieldAliases": {
       "ID": "ID",
       "OBJECTID": "Object ID",
       "sourceCountry": "sourceCountry",
       "X": "X",
       "Y": "Y",
       "areaType": "areaType",
       "bufferUnits": "bufferUnits",
       "bufferUnitsAlias": "bufferUnitsAlias",
       "bufferRadii": "bufferRadii",
       "aggregationMethod": "aggregationMethod",
       "HasData": "HasData",
       "TOTPOP": "Total Population",
       "TOTHH": "Total Households",
       "AVGHHSZ": "Average Household Size",
       "TOTMALES": "Male Population",
       "TOTFEMALES": "Female Population"
      },
      "spatialReference": {
       "wkid": 4326,
       "latestWkid": 4326
      },
      "fields": [
       {
        "name": "ID",
        "type": "esriFieldTypeString",
        "alias": "ID",
        "length": 256
       },
       {
        "name": "OBJECTID",
        "type": "esriFieldTypeOID",
        "alias": "Object ID"
       },
       {
        "name": "sourceCountry",
        "type": "esriFieldTypeString",
        "alias": "sourceCountry",
        "length": 256
       },
       {
        "name": "X",
        "type": "esriFieldTypeDouble",
        "alias": "X"
       },
       {
        "name": "Y",
        "type": "esriFieldTypeDouble",
        "alias": "Y"
       },
       {
        "name": "areaType",
        "type": "esriFieldTypeString",
        "alias": "areaType",
        "length": 256
       },
       {
        "name": "bufferUnits",
        "type": "esriFieldTypeString",
        "alias": "bufferUnits",
        "length": 256
       },
       {
        "name": "bufferUnitsAlias",
        "type": "esriFieldTypeString",
        "alias": "bufferUnitsAlias",
        "length": 256
       },
       {
        "name": "bufferRadii",
        "type": "esriFieldTypeDouble",
        "alias": "bufferRadii"
       },
       {
        "name": "aggregationMethod",
        "type": "esriFieldTypeString",
        "alias": "aggregationMethod",
        "length": 256
       },
       {
        "name": "HasData",
        "type": "esriFieldTypeInteger",
        "alias": "HasData"
       },
       {
        "name": "TOTPOP",
        "type": "esriFieldTypeDouble",
        "alias": "Total Population",
        "fullName": "KeyGlobalFacts.TOTPOP",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       },
       {
        "name": "TOTHH",
        "type": "esriFieldTypeDouble",
        "alias": "Total Households",
        "fullName": "KeyGlobalFacts.TOTHH",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       },
       {
        "name": "AVGHHSZ",
        "type": "esriFieldTypeDouble",
        "alias": "Average Household Size",
        "fullName": "KeyGlobalFacts.AVGHHSZ",
        "component": "scripts",
        "decimals": 2,
        "units": "count"
       },
       {
        "name": "TOTMALES",
        "type": "esriFieldTypeDouble",
        "alias": "Male Population",
        "fullName": "KeyGlobalFacts.TOTMALES",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       },
       {
        "name": "TOTFEMALES",
        "type": "esriFieldTypeDouble",
        "alias": "Female Population",
        "fullName": "KeyGlobalFacts.TOTFEMALES",
        "component": "demographics",
        "decimals": 0,
        "units": "count"
       }
      ],
      "features": [
       {
        "geometry": {
         "rings": [
          [
           [
            -80.947303771999898,
            29.038412094000094
           ],
           [
            -80.947124480999904,
            29.038187027000106
           ],

           ...

           [
            -80.947303771999898,
            29.038412094000094
           ]
          ]
         ]
        },
        "attributes": {
         "ID": "0",
         "OBJECTID": 1,
         "sourceCountry": "US",
         "X": -80.948570634626321,
         "Y": 29.033688278892043,
         "areaType": "NetworkServiceArea",
         "bufferUnits": "Minutes",
         "bufferUnitsAlias": "Walk Time Minutes",
         "bufferRadii": 15,
         "aggregationMethod": "BlockApportionment:US.BlockGroups",
         "HasData": 1,
         "TOTPOP":  625,
         "TOTHH": 353,
         "AVGHHSZ": 1.77,
         "TOTMALES": 290,
         "TOTFEMALES": 335,
        }
       }
      ]
     }
    ]
   }
  }
 ],
 "messages": []
}

Notes:

  • The response has been abbreviated in the example where "..." is noted.
  • A 15 minute walk time buffer area is generated around the input location.
  • A list of attributes describing the location's demographic characteristics and geographic context, as defined in the default Data Collection and based on the generated area, is returned in the response.
  • The service supports the geocoding parameters of the ArcGIS Online World Geocoding service.

JSON response rendered with ArcGIS for Desktop.

15 minute walk time

Notes:

  • Transparency property have been adjusted for illustrative purposes.

        
      

Request example 3:

Simultaneously enrich locations in multiple countries defined by addresses with attributes defined in a specified Data Collection. Instead of generating the default 1-mile ring buffer areas for all locations, generate and use varying ring buffer areas around each location.

http://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?StudyAreas=[{"address":{"text":"12 Concorde Place Toronto ON M3C 3R8","sourceCountry":"Canada"},"areaType":"RingBuffer","bufferUnits":"esriKilometers","bufferRadii":[3]},{"address":{"text":"380 New York St Redlands CA 92373","sourceCountry":"US"},"areaType":"RingBuffer","bufferUnits":"esriMiles","bufferRadii":[1]}]&dataCollections=["KeyGlobalFacts"]&f=pjson

JSON response example 3
{
  "results" : [ {
    "paramName" : "GeoEnrichmentResult",
    "dataType" : "GeoEnrichmentResult",
    "value" : {
      "version" : "2.0",
      "FeatureSet" : [ {
        "displayFieldName" : "",
        "fieldAliases" : {
          "ID" : "ID",
          "OBJECTID" : "Object ID",
          "sourceCountry" : "sourceCountry",
          "X" : "X",
          "Y" : "Y",
          "areaType" : "areaType",
          "bufferUnits" : "bufferUnits",
          "bufferUnitsAlias" : "bufferUnitsAlias",
          "bufferRadii" : "bufferRadii",
          "aggregationMethod" : "aggregationMethod",
          "HasData" : "HasData",
          "TOTPOP" : "Total Population",
          "TOTHH" : "Total Households",
          "AVGHHSZ" : "Average Household Size",
          "TOTMALES" : "Male Population",
          "TOTFEMALES" : "Female Population"
        },
        "spatialReference" : {
          "wkid" : 4326,
          "latestWkid" : 4326
        },
        "fields" : [ {
          "name" : "ID",
          "type" : "esriFieldTypeString",
          "alias" : "ID",
          "length" : 256
        }, {
          "name" : "OBJECTID",
          "type" : "esriFieldTypeOID",
          "alias" : "Object ID"
        }, {
          "name" : "sourceCountry",
          "type" : "esriFieldTypeString",
          "alias" : "sourceCountry",
          "length" : 256
        }, {
          "name" : "X",
          "type" : "esriFieldTypeDouble",
          "alias" : "X"
        }, {
          "name" : "Y",
          "type" : "esriFieldTypeDouble",
          "alias" : "Y"
        }, {
          "name" : "areaType",
          "type" : "esriFieldTypeString",
          "alias" : "areaType",
          "length" : 256
        }, {
          "name" : "bufferUnits",
          "type" : "esriFieldTypeString",
          "alias" : "bufferUnits",
          "length" : 256
        }, {
          "name" : "bufferUnitsAlias",
          "type" : "esriFieldTypeString",
          "alias" : "bufferUnitsAlias",
          "length" : 256
        }, {
          "name" : "bufferRadii",
          "type" : "esriFieldTypeDouble",
          "alias" : "bufferRadii"
        }, {
          "name" : "aggregationMethod",
          "type" : "esriFieldTypeString",
          "alias" : "aggregationMethod",
          "length" : 256
        }, {
          "name" : "HasData",
          "type" : "esriFieldTypeInteger",
          "alias" : "HasData"
        }, {
          "name" : "TOTPOP",
          "type" : "esriFieldTypeDouble",
          "alias" : "Total Population",
          "fullName" : "KeyGlobalFacts.TOTPOP",
          "component" : "demographics",
          "decimals" : 0,
          "units" : "count"
        }, {
          "name" : "TOTHH",
          "type" : "esriFieldTypeDouble",
          "alias" : "Total Households",
          "fullName" : "KeyGlobalFacts.TOTHH",
          "component" : "demographics",
          "decimals" : 0,
          "units" : "count"
        }, {
          "name" : "AVGHHSZ",
          "type" : "esriFieldTypeDouble",
          "alias" : "Average Household Size",
          "fullName" : "KeyGlobalFacts.AVGHHSZ",
          "component" : "scripts",
          "decimals" : 2,
          "units" : "count"
        }, {
          "name" : "TOTMALES",
          "type" : "esriFieldTypeDouble",
          "alias" : "Male Population",
          "fullName" : "KeyGlobalFacts.TOTMALES",
          "component" : "demographics",
          "decimals" : 0,
          "units" : "count"
        }, {
          "name" : "TOTFEMALES",
          "type" : "esriFieldTypeDouble",
          "alias" : "Female Population",
          "fullName" : "KeyGlobalFacts.TOTFEMALES",
          "component" : "demographics",
          "decimals" : 0,
          "units" : "count"
        } ],
        "features" : [ {
          "attributes" : {
            "ID" : "0",
            "OBJECTID" : 1,
            "sourceCountry" : "CA",
            "X" : -79.32845767499964,
            "Y" : 43.72973636000046,
            "areaType" : "RingBuffer",
            "bufferUnits" : "esriKilometers",
            "bufferUnitsAlias" : "kilometers",
            "bufferRadii" : 3,
            "aggregationMethod" : "BlockApportionment:CAN.DA",
            "HasData" : 1,
            "TOTPOP" : 110142,
            "TOTHH" : 27183,
            "AVGHHSZ" : 2.45,
            "TOTMALES" : 52531,
            "TOTFEMALES" : 57611
          }
        }, {
          "attributes" : {
            "ID" : "1",
            "OBJECTID" : 2,
            "sourceCountry" : "US",
            "X" : -117.19566636800778,
            "Y" : 34.05649035814457,
            "areaType" : "RingBuffer",
            "bufferUnits" : "esriMiles",
            "bufferUnitsAlias" : "mile",
            "bufferRadii" : 1,
            "aggregationMethod" : "BlockApportionment:US.BlockGroups",
            "HasData" : 1,
            "TOTPOP" : 12752,
            "TOTHH" : 5026,
            "AVGHHSZ" : 2.51,
            "TOTMALES" : 6126,
            "TOTFEMALES" : 6626
          }
        } ]
      } ]
    }
  } ],
  "messages" : [ ]
}

Notes:

  • A country code can be included with the addresses specified in the study areas. By providing the country code in advance, the speed and accuracy of the geocoding result may be improved since some computational steps can be avoided.
  • A 1-km ring buffer area is generated around the Canadian address location and a 1-mile ring buffer area is generated around the U.S. address location.
  • A list of attributes describing each location's demographic characteristics and geographic context, as defined in the KeyGlobalFacts Data Collection and based on the generated areas, is returned in the response.
  • The service supports the geocoding parameters of the ArcGIS Online World Geocoding service.