Skip to content

ComparisonArea

In all Territorial API comparison requests, a {ComparisonArea} identifying the geographic perimeter of the comparison can be provided.
A comparison area can be specified using one of the three different Query Parameter sets described below.

ComparisonAdministrativeArea

Name               Description Type Examples
*compare_country Filter by country. string Administrative Areas
  ⊢compare_state Filter by state. string Administrative Areas
    **⊢ **compare_county Filter by county. string Administrative Areas
       **⊢ **compare_city Filter by city. string Administrative Areas
        ⊢compare_suburb Filter by suburb. string Administrative Areas

ComparisonGeometryID

Name Description Type Examples
*compare_geometry_id Filter by a saved geometry. string 379c730942e570d586a5520770c0a65d
4442852e86f5ef4cf241a43bac90a6dcfh
Supported values for {compare_geometry_id}

Value obtainable from geometry_id field of areas with "type": "polygon" returned by Configuration.

ComparisonCircle

Name Description Type Examples Default
*compare_lat Latitude of the circle center. decimal 43.770366014832014
*compare_lng Longitude of the circle center. decimal 11.257818620617464
*compare_radius Circle radius length. decimal 40
compare_unit Unit of measure for compare_radius. Possible values are:
km: kilometers
m: meters
mi: miles
string km
m
mi
km