standardGeographyQuery-spec
GET https://{{geoenrich-service}}.arcgis.com/arcgis/rest/services/World/GeoEnrichmentServer/StandardGeographyQuery
The GeoEnrichment service provides a helper method that returns standard geography IDs and features for the supported geographic levels.
The most common workflow for this service is to find a FIPS (standard geography ID) for a geographic name. For example, you can use this service to find the FIPS for the county of San Diego which is 06073. You can then use this FIPS ID within the GeoEnrichment service study area definition to get geometry and optional demographic data for the county. This study area definition is passed as a parameter to the GeoEnrichment service to return data defined in the enrichment pack and optionally return geometry for the feature.
Field | Discovery method | Example |
---|---|---|
optionalCountryDataset | [Available info (per country)] | |
geographyLayers | [Standard geography levels] OK] |
π API reference: StandardGeographyQuery
operation
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
sourceCountry | string | Specify the source country for the search. Use this parameter to limit the search and query of standard geographic features to one country. This parameter supports both the two-digit and three-digit country codes illustrated in the coverage table. | |
optionalCountryDataset | string | Specify a specific dataset within a defined country. | |
geographyLayers | string | Specify which standard geography layers are being queried or searched. If this parameter is not provided, all layers within the defined country will be queried. | |
geographyIDs | string | Specify which IDs for the standard geography layers are being queried or searched. You can use this parameter to return attributes and/or geometry for standard geographic areas for administrative areas where you already know the ID. | |
geographyQuery | string | Specify the text to query and search the standard geography layers specified. You can use this parameter to query and find standard geography features that meet an input term. | |
returnSubGeographyLayer | string | Return all the subgeographic areas that are within a parent geography. For example, you could return all the U.S. counties for a given U.S. state or you could return all the Canadian postal areas (FSAs) within a Census Metropolitan Area (city). | |
subGeographyLayer | string | Return all the subgeographic areas that are within a parent geography. For example, you could return all the U.S. counties within a given U.S. state or you could return all the Canadian postal areas (FSAs) within a Census Metropolitan Areas (city). | |
subGeographyQuery | string | Filter the results of the subgeography features that are returned by a search term. You can use this parameter to query and find subgeography features that meet an input term. This parameter is used to filter the list of subgeography features that are within a parent geography. | |
outSR | string | Request the output geometries in a specified spatial reference system. | |
returnGeometry | string | Request the output geometries in the response. | |
returnCentroids | string | Request the output geometry to return the center point for each feature. Use this parameter to return all the geometries as points. For example, you could return all U.S. ZIP Code centroids (points) rather than providing the boundaries. | |
generalizationLevel | string | Specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers. Values must be whole integers from 0 through 6, where 0 is most detailed and 6 is most generalized. | |
useFuzzySearch | string | Define if text provided in the geographyQuery parameter should utilize fuzzy search logic. Fuzzy searches are based on the Levenshtein Distance or Edit Distance algorithm. | |
featureLimit | string | Limits the number of features that are returned from the geographyQuery parameter. | |
featureOffset | string | Starts the results on the number of the records specified. | |
langCode | string | Specifies the language you wish to receive your GeoEnrichment results. The availability to use this parameter is determined by the data which is available within your study area. | |
f | string | Specify the output response format. |