List Zone Options

Returns the valid zones for a market region's zone layer as value/label options.

Use the value field for the corresponding zone field in your simulation_config when creating a run via POST /runs/.

Optionally pass ?lat= and ?long= for your site: when the coordinates fall inside a zone, the response's preselect holds that zone; otherwise message explains why a zone must be chosen manually.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Market region, case-insensitive. Uses the same vocabulary as simulation_config.market_region in POST /runs/.

string
required

Zone layer key for the region (e.g. zone).

Query Params
number

Site latitude, used to preselect the containing zone.

number

Site longitude, used to preselect the containing zone.

Responses

400

Invalid coordinates.

401

Missing or invalid X-token.

404

Unknown market region, or the region has no such layer.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json