Skip to content

Area

In all Territorial API requests, an {Area} identifying the geographic perimeter of the analysis is required.
An area can be specified using one of the three different Query Parameter sets described below.

AdministrativeArea

Name               Description Type Examples
*country Filter by country. string Administrative Areas
  ⊢state Filter by state. string Administrative Areas
    **⊢ **county Filter by county. string Administrative Areas
       **⊢ **city Filter by city. string Administrative Areas
        ⊢suburb Filter by suburb. string Administrative Areas

GeometryID

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

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

Circle

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