GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/EnrichThe / request provides the ability to get facts about a location or area. Using Enrich, you can get information about the people, places, and businesses in a specific area or within a certain distance or drive time from a location.
More specifically, by submitting a point or polygon to a GeoEnrichment service, you can retrieve the demographics and other relevant characteristics associated with the surrounding area. You can also use Enrich to obtain additional geographic context—for example, the ZIP Code of a location or the geometry for a drive-time service area.
Parameters
| Name | Required | Type | Default | Description |
|---|---|---|---|---|
string |
| The output response format, either | ||
string | An access token with the required privileges. | |||
[object] | The area that will be enriched, defined as input points, polygons, administrative boundaries, or addresses. | |||
[string] |
| The data collection to be returned. | ||
[string] |
| A subset of variables to be returned from one or more data collections. | ||
string |
| Specifies an array of string values to describe what derivative variables to include in the output. | ||
object |
| The properties for the study area buffer. | ||
object |
| Specifies the country or dataset to query. | ||
object |
| Defines the geographic layers used to provide geographic context during the enrichment process. | ||
boolean |
| Defines the spatial reference system for the input geometries in the | ||
number |
| Requests the input geometries in a specified spatial reference system. | ||
number |
| Requests the output geometries in a specified spatial reference system. |
Required parameters
token
An access token with the required privileges.
- ArcGIS Location Platform: premium:user:geoenrichment
- ArcGIS Online: premium:user:geoenrichment
token=<ACCESS_TOKEN>To use HTTP headers instead of the token parameter, set the following:
GET <SERVICE_REQUEST> HTTP/1.1
Host: <SERVICE_DOMAIN>
X-Esri-Authorization: Bearer <ACCESS_TOKEN>Learn more about access tokens and privileges in the Security and authentication developer guide.
studyAreas
Required parameter which defines the area on a map being analyzed. Study areas can be input XY point locations, street addresses, map areas described as polygons, and map areas described as named administrative boundaries—for example, postal codes, states, ZIP Codes. It is also possible to specify a buffer around the input location like a ring or network service area using this parameter. This parameter can also be used to request statistics the levels of geography that intersect the input study area, like zip code or county.
Study areas around points
When points are specified as study , the service will analyze map areas surrounding or associated with the input point locations. Unless otherwise specified, the service will analyze a one mile ring around a point. This is also true for a line.
One point described as map coordinates:
study
Multiple points with attributes described as map coordinates:
studyareas=[{"geometry"
One point and intersecting U.S. state:
studyareas=[{"geometry"
One point and include two comparison levels of geography:
studyareas=[{"geometry"
Points and polygons
One-kilometer buffer around an input line feature:
studyareas=[{"area
Map areas described as polygons:
study
Map areas described as named administrative boundaries—for example, U.S. state:
study
Separate map areas described as multiple named administrative boundaries—for example, U.S. ZIP Codes.
study
Combined map areas described as multiple named administrative boundaries and return enrichment data for the union of the combined features— for example, U.S. ZIP Codes:
study
Return a geography with generalization of the polygon to improve drawing performance:
study
Drive time service areas
One hour driving time:
study
One mile driving distance from an address location:
study
Ten minute trucking time:
study
Five, Ten, and Fifteen kilometer trucking distances:
study
Ten minute walking time:
study
One mile walking distance from an address location:
Study
Street addresses
The Network Service Area Solver and the ArcGIS World Geocoding service support the GeoEnrichment service by analyzing the points submitted as study and the areas around the points. A network service area and ring request sent to the GeoEnrichment service is bound by the supporting services and may not exceed 300 miles or 300 minutes (5 hours). Supported bufferUnits include meters, kilometers, feet, yards, miles, nautical miles, seconds, minutes, and hours, as well as the units that were supported in legacy area types for DriveTimeBuffer and DriveTimeBufferBands. These units include esriMeters, esriKilometers, esriMiles, esriYards, esriDriveTimeUnitsSeconds, esriDriveTimeUnitsMinutes, esriDriveTimeUnitsHours. When specifying addresses for study , only matched (successfully geocoded) addresses will be enriched.
Point described as a single line address:
study
Point described as a multiple field input address:
study
Multiple points described as multiple single line input addresses:
study
Multiple points described as multiple single line input addresses and change the ring buffer size for each point:
study
Administrative areas
You can use the Standard Geography Query lookup service to find the IDs for named statistical features.
- 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, an "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.
- 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.
Optional parameters
dataCollections
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 study .
A standard list of enrichment attributes.
Examples
Example 1:
data
Example 2:
data
Example 3:
data
Additional notes
- A limited number of Data Collections are currently available
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 analysis 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 study .
Examples
Example 1:
analysis
Example 2:
analysis
Example 3:
analysis
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—for example,
Key.Global Facts.*
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:
add
Example 2 - Return a data collection with the additional variables and associated metadata for index values:
add
Additional notes
- The enumerated list of accepted values are as follows:
add
-
Support the use of the derivative statistics can also be performed in the enrich operation through the
analysisparameter.Variables -
Example:
https://geoenrich.arcgis.com/arcgis/rest/services/ World/geoenrichmentserver/ Geoenrichment/ Enrich?studyareas=[{"geometry" :{"rings" :[[[-117.26,32.81],[-117.40,32.92],[-117.12,32.80],[-117.26,32.81]]],"spatial Reference" :{"wkid" :4326}},"attributes" :{"id" :" Polygon 1","name" :" Study Area 1"}}]&analysisvariables=[" Travel CE X. X7003 _X"]&add Derivative Variables=index&f=pjson Use dark colors for code blocks Copy { "results" : [ { "paramName" : "GeoEnrichmentResult", "dataType" : "GeoEnrichmentResult", "value" : { "version" : "2.0", "FeatureSet" : [ { "displayFieldName" : "", "fieldAliases" : { "ID_0" : "ID_0", "OBJECTID" : "Object ID", "sourceCountry" : "sourceCountry", "name" : "name", "id" : "id", "aggregationMethod" : "aggregationMethod", "populationToPolygonSizeRating" : "Population to polygon size rating for the country", "apportionmentConfidence" : "Apportionment confidence for the country", "HasData" : "HasData", "X7003_X_I" : "Airline Fares: Index", "X7003_X" : "Airline Fares" }, "spatialReference" : { "wkid" : 4326, "latestWkid" : 4326 }, "fields" : [ { "name" : "ID_0", "type" : "esriFieldTypeString", "alias" : "ID_0", "length" : 256 }, { "name" : "OBJECTID", "type" : "esriFieldTypeOID", "alias" : "Object ID" }, { "name" : "sourceCountry", "type" : "esriFieldTypeString", "alias" : "sourceCountry", "length" : 256 }, { "name" : "name", "type" : "esriFieldTypeString", "alias" : "name", "length" : 256 }, { "name" : "id", "type" : "esriFieldTypeString", "alias" : "id", "length" : 256 }, { "name" : "aggregationMethod", "type" : "esriFieldTypeString", "alias" : "aggregationMethod", "length" : 256 }, { "name" : "populationToPolygonSizeRating", "type" : "esriFieldTypeDouble", "alias" : "Population to polygon size rating for the country" }, { "name" : "apportionmentConfidence", "type" : "esriFieldTypeDouble", "alias" : "Apportionment confidence for the country" }, { "name" : "HasData", "type" : "esriFieldTypeInteger", "alias" : "HasData" }, { "name" : "X7003_X_I", "type" : "esriFieldTypeInteger", "alias" : "Airline Fares: Index", "fullName" : "TravelCEX.X7003_X_I", "component" : "demographics", "decimals" : 0, "units" : "count" }, { "name" : "X7003_X", "type" : "esriFieldTypeDouble", "alias" : "Airline Fares", "fullName" : "TravelCEX.X7003_X", "component" : "demographics", "decimals" : 0, "units" : "currency", "currency" : "$" } ], "features" : [ { "attributes" : { "ID_0" : "0", "OBJECTID" : 1, "sourceCountry" : "US", "name" : "Study Area 1", "id" : "Polygon 1", "aggregationMethod" : "BlockApportionment:US.BlockGroups;PointsLayer:US.BlockPoints", "populationToPolygonSizeRating" : 2.191, "apportionmentConfidence" : 2.576, "HasData" : 1, "X7003_X_I" : 162, "X7003_X" : 29792383 } } ] } ] } } ], "messages" : [ ] }
studyAreasOptions
This parameter is only applicable to input study areas that are based on points. This parameter is not needed and ignored for input polygon study areas.
Examples
Example 1 - Build three ring buffers around a point.
studyareasoptions={"area
Example 2 - Build three ring buffer bands using kilometers.
studyareasoptions={"area
Example 3 - Build a single one mile buffer using driving as the travel mode.
studyareasoptions={"area
Example 4 - Build a single one mile buffer using driving as the travel mode and disks as the overlap type.
studyareasoptions={"area
Example 5 - Build a 100 kilometer buffer and allow for multiple countries to be aggregated.
studyareasoptions={"area
Example 6 - Return ZIP Code data intersected by a point study area.
study
Additional notes
- The studyAreasOptions parameter should only be set for input points, street address and point-based feature service-based study areas.
- Miles and Kilometers are supported buffer units.
- Ring buffer bands represent the area between each ring with no overlap.
- Disks represent the area between each ring with no overlap.
- Setting the
aggregateproperty toMultiple Countries trueallows data from multiple countries to be included in the output. - The supported comparison levels are: US.States, US.DMA, US.CD, US.CBSA, US.Counties, US.CSD, US.ZIP5, US.Places, US.Tracts, US.BlockGroups.
useData
Optional parameter to specify the hierarchy to query in the case of multiple vintages being available. For example, the current year and previous year vintages of data are available for the US. This parameter can explicitly use the previous year instead of the default current year. In the US, the esri2024 hierarchy is the default, it is based on boundaries from the 2020 census and Esri's updated demographics for the current year. The esri2023 hierarchy is based on boundaries from the 2020 census and Esri's updated demographics for the year 2023.
The use parameter can also provide an optional performance hint. By default, the service will automatically determine the country associated with each location submitted in the study 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 up front through this parameter.
If there are multiple vintages of data (US only), the default behavior is to query the most current year available.
Examples
Example 1 - Query the most current vintage of data for locations in the US (default behavior).
use
Example 2 - Query the 2023 data for locations in the US.
use
Example 3 - Provide a performance hint to the service by indicating that all of the input features in the studyAreas parameter describe locations or areas in the US.
use
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 study 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 intersecting parameter should be constructed as a JSON array of an IntersectingGeographies object which consists of the following elements:
| Value | Description |
|---|---|
geographyType | Specifies the type of intersection layer. Standard geography layers—provided by the GeoEnrichment service for each country or publicly available feature services. |
layer | Specifies which Standard Geography layer should be intersected—for example, 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 |
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 ( |
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 out .
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:
return
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
Optional parameter to define the input geometries in the study parameter in a specified spatial reference system.
When input points are defined in the study parameter, this optional parameter can be specified to explicitly indicate the spatial reference system of the point features. The parameter value can be specified as the well-known ID describing the projected coordinate system or geographic coordinate system.
The standard latitude and longitude-based geographic coordinate system based on the WGS 1984 datum will be used.
Examples
Example 1 - Specify the input geometry in the Web Mercator (Auxiliary Sphere) projected coordinate system based on the WGS 1984 datum:
in
Example 2 - Defining one point with non-default WKT:
studyareas =[{"geometry"
Additional notes
- For a list of valid WKID values, see Projected coordinate systems and Geographic coordinate systems.
outSR
Optional parameter to request the output geometries in a specified spatial reference system.
When return 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.
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:
out
Additional notes
- For a list of valid WKID values, see Projected coordinate systems and Geographic coordinate systems.
Response status
For a list of error codes and details, go to Error codes.
Response details
{
"results": [
{
"paramName": "<paramName>",
"dataType": "<dataType>",
"value": {
"version": "<version>",
"FeatureSet": [
{
"displayFieldName": "<displayFieldName>",
"fieldAliases": {
"ID": "<ID>",
"OBJECTID": "<OBJECTID>",
"sourceCountry": "<sourceCountry>",
"areaType": "<areaType>",
"bufferUnits": "<bufferUnits>",
"bufferUnitsAlias": "<bufferUnitsAlias>",
"bufferRadii": "<bufferRadii>",
"aggregationMethod": "<aggregationMethod>",
"populationToPolygonSizeRating": "<populationToPolygonSizeRating>",
"apportionmentConfidence": "<apportionmentConfidence>",
"HasData": "<HasData>",
"TOTPOP": "<TOTPOP>",
"TOTHH": "<TOTHH>",
"AVGHHSZ": "<AVGHHSZ>",
"TOTMALES": "<TOTMALES>",
"TOTFEMALES": "<TOTFEMALES>"
},
"spatialReference": {
"wkid": "<wkid>",
"latestWkid": "<latestWkid>"
},
"fields": [
{
"name": "<name>",
"alias": "<alias>",
"type": "<type>",
"length": "<length>"
}
],
"features": [
{
"attributes": {
"ID": "<ID>",
"OBJECTID": "<OBJECTID>",
"sourceCountry": "<sourceCountry>",
"areaType": "<areaType>",
"bufferUnits": "<bufferUnits>",
"bufferUnitsAlias": "<bufferUnitsAlias>",
"bufferRadii": "<bufferRadii>",
"aggregationMethod": "<aggregationMethod>",
"populationToPolygonSizeRating": "<populationToPolygonSizeRating>",
"apportionmentConfidence": "<apportionmentConfidence>",
"TOTPOP": "<TOTPOP>",
"TOTHH": "<TOTHH>",
"AVGHHSZ": "<AVGHHSZ>",
"TOTMALES": "<TOTMALES>",
"TOTFEMALES": "<TOTFEMALES>"
}
}
]
}
]
}
}
],
"messages": []
}Examples
Enrich a single area
Enrich a single area defined by a polygon feature with attributes defined in a specified Data Collection and include the associated geometry in the response. Optionally, rename the polygon and include information about all of the boundary areas within the three default administrative levels that intersect any part of the input area.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?StudyAreas=[{"geometry":{"rings":[[[-117.217855,32.842137],[-117.219443,32.847293],[-117.216611,32.853999],[-117.23249,32.849312],[-117.234249,32.843399],[-117.229571,32.839108],[-117.217855,32.842137]]],"spatialReference":{"wkid":4326}},"attributes":{"id":"Polygon 1","name":"University City West"}}]&StudyAreasOptions={"GeometryType":"esriGeometryPolygon","SpatialRelationship":"esriSpatialRelIntersects"}&dataCollections=["KeyUSFacts"]&returngeometry=true&f=pjson&token=<ACCESS_TOKEN>- A list of attributes describing the area's demographic characteristics and geographic context, as defined in the default Data Collection, is returned in the response.
- User defined attributes are submitted with the input feature and will be carried over into the response. This can be useful in associating the input feature with the output.
JSON response rendered with ArcGIS for Desktop.
- Transparency and fill properties have been adjusted for illustrative purposes.
Enrich a single area (polygon)
Enrich a single area defined by a polygon feature with attributes defined in a specified Data Collection and include information about all of the boundary areas within the three default administrative levels that intersect any part of the input area.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?StudyAreas=[{"geometry":{"rings":[[[-117.26,32.81],[-117.40,32.92],[-117.12,32.80],[-117.26,32.81]]],"spatialReference":{"wkid":4326}},"attributes":{"id":"Polygon 1","name":"Optional Name 1"}}]&StudyAreasOptions={"GeometryType":"esriGeometryPolygon","SpatialRelationship":"esriSpatialRelIntersects"}&dataCollections=["KeyUSFacts"]&f=pjson&token=<ACCESS_TOKEN>- The response has been abbreviated in the example where "..." is noted.
- A list of attributes describing the area's demographic characteristics and geographic context, as defined in the KeyUSFacts Data Collection, is returned in the response.
- User defined attributes are submitted with the input feature and will be carried over into the response. This can be useful in associating the input feature with the output.
- The default geographic context that is returned in all responses includes the descriptions of three levels of administrative areas: the country level, the first level major administrative boundary level such as state or province, and the ZIP (U.S.) or postal code level. In
study, an intersection relationship has been specified and will result in the inclusion of the descriptions of all of the boundary areas from the three default administrative levels that intersect any part of the input area to be included in the response.Areas Options
Enrich a single location
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.
GET https://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&token=<ACCESS_TOKEN>- 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 World Geocoding service.
JSON response rendered with ArcGIS for Desktop.
Notes:
- Transparency property have been adjusted for illustrative purposes.
Enrich a single location by latitude and longitude
Enrich a single location defined by latitude and longitude coordinates and include the associated geometry in the response. Instead of the default 1-mile ring buffer, generate a drive time service area.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?studyareas=[{"geometry":{"x": -122.435, "y": 37.785},"areaType": "NetworkServiceArea","bufferUnits": "Minutes","bufferRadii": [5],"travel_mode":"Driving"}]&returngeometry=true&f=pjson&token=<ACCESS_TOKEN>- The response has been abbreviated in the example where "..." is noted.
- A 5 minute drive time service area is generated as specified in the bufferUnits, bufferRadii and travel_mode parameters.
- The default data collection of Key Global Facts is used.
JSON response rendered with ArcGIS for Desktop.
- Transparency and fill properties have been adjusted for illustrative purposes.
Enrich multiple locations by latitude and longitude
Simultaneously enrich locations in multiple countries or datasets defined by latitude and longitude coordinates with attributes defined from the default statistical data collection (KeyGlobalFacts).
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?studyareas=[{"geometry":{"x":-122.435,"y":37.785}},{"geometry":{"x":-122.433,"y":37.734}},{"geometry":{"x":-79.345,"y":43.69}}]&f=pjson&token=<ACCESS_TOKEN>Notes:
- A 1-mile ring buffer area is generated around each input location and the associated geometry is returned in the response.
- A list of attributes describing each location's demographic characteristics and geographic context, as defined in the KeyGlobalFacts statistical data collection and based on the generated areas, is returned in the response.
Enrich multiple locations in a single country
Simultaneously enrich multiple locations in a single country defined by latitude and longitude coordinates with attributes defined in a specified statistical data collection and include the associated geometry in the response. Additionally, specify the country or dataset through the use parameter to provide the service with a performance hint.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?studyareas=[{"geometry":{"x":-122.435,"y":37.785}},{"geometry":{"x":-122.433,"y":37.734}}]&dataCollections=["KeyUSFacts"]&useData={"sourceCountry":"US"}&returngeometry=true&f=pjson&token=<ACCESS_TOKEN>Notes:
- The response has been abbreviated in the example where "..." is noted.
- Further information about the significant benefits of explicitly specifying the country or dataset in advance can be found in the useData parameter description.
- A 1-mile ring buffer area is generated around each input location.
- A list of attributes describing each location's demographic characteristics and geographic context, as defined in the KeyUSFacts statistical data collection and based on the generated areas, is returned in the response.
JSON response rendered with ArcGIS for Desktop.
Notes:
- Transparency and fill properties have been adjusted for illustrative purposes.
Enrich an area within the same administrative boundary
Enrich an area consisting of the union of multiple areas within the same administrative boundary data layer with attributes defined in the Data Collection.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?StudyAreas=[{"sourceCountry":"US","layer":"US.ZIP5","ids":["95123,92123"]}]&dataCollections=["KeyGlobalFacts"]&f=pjson&token=<ACCESS_TOKEN>Notes:
- Rather than specifying the polygon feature, identifiers are used to specify two U.S. ZIP Codes in the example. Named administrative boundary areas can be looked up with administrative boundary lookup or utility services.
- A list of attributes describing the area's demographic characteristics and geographic context, as defined in the default Data Collection, is returned in the response.
- The union function can be specified on administrative boundary areas by specifying the comma-delimited area IDs within the same string (rather than in separate strings) in the ids array.
Enrich multiple locations (from a statistical data collection)
Simultaneously enrich multiple locations in a single country defined by latitude and longitude coordinates with attributes defined in a specified statistical data collection. Instead of generating the default 1-mile ring buffer areas for all locations, you will generate and use varying ring buffer areas around each location.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?studyareas=[{"geometry":{"x":-73.270588,"y":45.599518},"areaType":"RingBuffer","bufferUnits":"esriMiles","bufferRadii":[1]},{"geometry":{"x":-75.320576,"y":40.048835},"areaType":"RingBuffer","bufferUnits":"esriMiles","bufferRadii":[5]}]&dataCollections=["KeyUSFacts"]&f=pjson&token=<ACCESS_TOKEN>Notes:
- A 1-mile ring buffer area is generated around the first input location and a 5-mile ring buffer area is generated around the second input location.
- A list of attributes describing each location's demographic characteristics and geographic context, as defined in the KeyUSFacts statistical data collection and based on the generated areas, is returned in the response.
Generalize geometry
Return the state of California study area in the most generalized geometry.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/enrich?dataCollections=["KeyGlobalFacts"]&studyAreas=[{"sourceCountry":"US","layer":"US.States","ids":["06"],"generalizationLevel":"2"}]&returnGeometry=true&f=pjson&token=<ACCESS_TOKEN>Notes:
- The response has been abbreviated in the example where "..." is noted.
- You only need to specify
generalizationif returnGeometry is set to true.Level - Generalization levels are from 0 through 2 with 0 being the most detailed and 2 being the most generalized.
- You can't return more than one feature in a detailed geometry.
Enrich ring buffers
Encapsulating a returned FeatureSet into the study parameter to create rings around each point and enriching each of the ring buffers.
Using the feature service you can query and return the following FeatureSet which will be encapsulated into the study parameter.
{
"objectIdFieldName": "OBJECTID",
"globalIdFieldName": "",
"geometryType": "esriGeometryPoint",
"spatialReference": {
"wkid": 102100,
"latestWkid": 3857
},
"fields": [
{
"name": "OBJECTID",
"type": "esriFieldTypeOID",
"alias": "OBJECTID",
"sqlType": "sqlTypeInteger",
"domain": null,
"defaultValue": null
},
{
"name": "Station_ID",
"type": "esriFieldTypeString",
"alias": "Station_ID",
"sqlType": "sqlTypeNVarchar",
"length": 255,
"domain": null,
"defaultValue": null
},
{
"name": "FirstOfAddress",
"type": "esriFieldTypeString",
"alias": "FirstOfAddress",
"sqlType": "sqlTypeNVarchar",
"length": 255,
"domain": null,
"defaultValue": null
},
{
"name": "Price",
"type": "esriFieldTypeDouble",
"alias": "Price",
"sqlType": "sqlTypeDecimal",
"domain": null,
"defaultValue": null
},
{
"name": "UniqueID",
"type": "esriFieldTypeInteger",
"alias": "UniqueID",
"sqlType": "sqlTypeInteger",
"domain": null,
"defaultValue": null
}
],
"features": [
{
"attributes": {
"OBJECTID": 1,
"Station_ID": "202382",
"FirstOfAddress": "12030 ROSECRANS AVE",
"Price": 2.95716667,
"UniqueID": 512
},
"geometry": {
"x": -13144272.4606,
"y": 4015682.7760000005
}
},
{
"attributes": {
"OBJECTID": 2,
"Station_ID": "517080",
"FirstOfAddress": "2402 E ANAHEIM ST",
"Price": 2.95233333,
"UniqueID": 1256
},
"geometry": {
"x": -13161572.144000001,
"y": 3999537.5165000036
}
},
{
"attributes": {
"OBJECTID": 3,
"Station_ID": "521883",
"FirstOfAddress": "1660 W 25TH ST",
"Price": 2.919,
"UniqueID": 1306
},
"geometry": {
"x": -13170715.4594,
"y": 3991785.8429000005
}
}
]
}GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/GeoEnrichment/Enrich?studyareas=[{"FeatureSet":{"objectIdFieldName":"OBJECTID","globalIdFieldName":"","geometryType":"esriGeometryPoint","spatialReference":{"wkid":102100,"latestWkid":3857},"fields":[{"name":"OBJECTID","type":"esriFieldTypeOID","alias":"OBJECTID","sqlType":"sqlTypeInteger","domain":null,"defaultValue":null},{"name":"Station_ID","type":"esriFieldTypeString","alias":"Station_ID","sqlType":"sqlTypeNVarchar","length":255,"domain":null,"defaultValue":null},{"name":"FirstOfAddress","type":"esriFieldTypeString","alias":"FirstOfAddress","sqlType":"sqlTypeNVarchar","length":255,"domain":null,"defaultValue":null},{"name":"Price","type":"esriFieldTypeDouble","alias":"Price","sqlType":"sqlTypeDecimal","domain":null,"defaultValue":null},{"name":"UniqueID","type":"esriFieldTypeInteger","alias":"UniqueID","sqlType":"sqlTypeInteger","domain":null,"defaultValue":null}],"features":[{"attributes":{"OBJECTID":1,"Station_ID":"202382","FirstOfAddress":"12030ROSECRANSAVE","Price":2.95716667,"UniqueID":512},"geometry":{"x":-13144272.4606,"y":4015682.7760000005}},{"attributes":{"OBJECTID":2,"Station_ID":"517080","FirstOfAddress":"2402EANAHEIMST","Price":2.95233333,"UniqueID":1256},"geometry":{"x":-13161572.144000001,"y":3999537.5165000036}},{"attributes":{"OBJECTID":3,"Station_ID":"521883","FirstOfAddress":"1660W25THST","Price":2.919,"UniqueID":1306},"geometry":{"x":-13170715.4594,"y":3991785.8429000005}}]}}]&datacollections=&analysisvariables=&studyareasoptions={"areaType":"RingBuffer","BufferRadii":[11]}&usedata=&f=pjson&token=<ACCESS_TOKEN>Set a drive time buffer
Set a drive time buffer from a defined point and return total households and median household income for the current year with the associated geometry in the response.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/Enrich?studyAreas=[{"geometry":{"x":-117.2459,"y":32.8307}}]&studyAreasOptions={"areaType":"DriveTimeBuffer","bufferUnits":"esriDriveTimeUnitsMinutes","bufferRadii":[5]}& analysisVariables=["KeyUSFacts.TOTHH_CY","KeyUsFacts.MEDHINC_CY"]&returngeometry=true&f=pjson&token=<ACCESS_TOKEN>Notes:
- The response has been abbreviated in the example where "..." is noted.
- A 5-minute drivetime buffer area is generated around the input location.
JSON response rendered with ArcGIS for Desktop.
Notes:
- Transparency and fill properties have been adjusted for illustrative purposes.
Return a statistical data collection
Return a statistical data collection with the additional variables and associated metadata for index values.
GET https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment/Enrich?studyareas=[{"geometry":{"x":-117.1042,"y":32.7671}}]&analysisvariables=["TravelCEX.X7003_X"]&addDerivativeVariables=index&f=pjson&token=<ACCESS_TOKEN>