Get Territories

get

https://api.genability.com/rest/public/territories

Return a full or filtered list of Territories.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieve a full or filtered list of territories.

Use this endpoint to find geographic areas that define utility service coverage, tariff applicability, baseline regions, and climate zones. You can filter by location, LSE, tariff, usage type, or territory item.

Resource URI

GET /rest/public/territories

Query parameters

Parameter	Type	Description
`zipCode`	String	Return territories that include this ZIP code. Optional.
`postCode`	String	Alias for `zipCode`. Optional.
`country`	String	ISO country code. Recommended when passing `zipCode` or `postCode`. Defaults to `US` when a ZIP code or postcode is supplied. Optional.
`addressString`	String	Address to use for location-based filtering, such as `San Francisco, CA, 94105, USA`. Optional.
`address`	String	Alias for `addressString`. Optional.
`lat`	Number	Latitude for location-based filtering. Use with `lng` when not supplying a ZIP code or address. Optional.
`lng`	Number	Longitude for location-based filtering. Use with `lat` when not supplying a ZIP code or address. Optional.
`lseId`	Integer	Return territories within this LSE. Optional.
`populateItems`	Boolean	When `true`, includes territory items for each territory. Defaults to `false`. Optional.
`masterTariffId`	Integer	Return territories covered by a tariff with territory-based pricing. Optional.
`usageTypes`	String	Return territories with the specified usage type. If omitted, results are limited to `SERVICE` and `TARIFF` territories. Optional.
`populateLses`	Boolean	When `true`, includes LSEs that provide service in each territory. Defaults to `false`. Optional.
`containsItemType`	String	Territory item type to filter by. Choices are `STATE`, `COUNTY`, `CITY`, and `ZIPCODE`. Must be used with `containsItemValue`. Optional.
`containsItemValue`	String	Territory item value to filter by. Must be used with `containsItemType`. Optional.

For the full Territory data model and examples, see Territories.

Example

GET /rest/public/territories?postCode=94105&country=US&lseId=734&usageTypes=TARIFF

A successful response returns a standard response payload with type set to Territory and results containing matching territories.

Query Params

zipCode

string

Filters the result to include only territories that this ZIP code is a part of.

postCode

string

Alias for zipCode, you can use either.

country

string

Recommended when passing in zipCode or postCode. We default this to US when zipCode or postCode is populated.

addressString

string

An address of any kind (e.g. San Francisco, CA, 94105, USA). Ideally this will contain a zipcode or post code, plus a country. Use this if you do not have the address parsed out in your app. If you do, its better to use postCode and country

address

string

Alias for addressString, you can use either.

lat

float

(Optional) Represents the latitude of a geographical location. This should be paired with lng when not supplying a zip code or address.

lng

float

(Optional) Represents the longitude of a geographical location. This should be paired with lat when not supplying a zip code or address.

lseId

int32

Filters the result set to only include territories within this LSE ID

populateItems

boolean

Defaults to false

If true, this returns a list of territory items for each territory in the result set.

masterTariffId

int32

For tariffs with prices varying by geographic location, this will return the list of those territories covered by this tariff. 3% of all tariffs have territory based pricing and those are typically in CA, NY and MA. For the 97% of tariffs that do not have territory based pricing, the result set will be empty.

usageTypes

string

Result will include territories of the specified usageType. If not set the results will be limited to those of usage type "SERVICE" or "TARIFF".

populateLses

boolean

Defaults to false

If true, this returns a list of territory LSEs which are all the LSEs providing service in this territory.

containsItemType

string

Filters by the type of the territory items in each territory and must appear with containsItemValue. Possible values are: STATE, COUNTY, CITY, and ZIPCODE.

containsItemValue

string

Filters by the value of the territory items in each territory and must appear with containsItemType.

Responses

Resource URI

Query parameters

Example

200200

400400