---
title: "One suburb or town: every charging site in it, with facet counts"
method: GET
path: "/v1/localities/{country}/{region}/{locality}"
---

# One suburb or town: every charging site in it, with facet counts

`GET /v1/localities/{country}/{region}/{locality}`

## Request

- Base URL: `https://api.chargealong.io`
- URL: `https://api.chargealong.io/v1/localities/{country}/{region}/{locality}`
- Auth: none required

## Path parameters

- `country` string, required
- `region` string, required
- `locality` string, required

## Response `200`

The locality, its sites, its facet counts and its neighbours

- LocalityResponse: The answer, in the envelope every read shares.
  - `data` LocalityPage, required: One suburb or town: every charging site in it.
    - `country` Country, required: A country with charging sites.
      - `iso2` string, required: ISO 3166-1 alpha-2 code.
      - `slug` string, required: The country in URLs: australia, new-zealand.
      - `name` string, required: The country's English name.
      - `site_count` integer, required: Charging sites listed in the country, active and unavailable.
    - `region` Region, required: A state, territory or region within a country.
      - `slug` string, required: The region in URLs: victoria.
      - `code` string: The region's short code where it has one: VIC. Absent where it has none.
      - `name` string, required: The region's name.
      - `site_count` integer, required: Charging sites listed in the region.
    - `locality` Locality, required: A suburb or town.
      - `slug` string, required: The locality in URLs, unique within its region.
      - `name` string, required: The locality's name.
      - `postcode` string: Its postcode, where the country has them and it is known.
      - `time_zone` string: IANA time zone, where known: Australia/Melbourne.
      - `site_count` integer, required: Charging sites listed in the locality.
      - `region` string: The region's slug, present on lists that cross regions, such as a country's busiest places.
    - `sites` Site[], required: Every site in the locality.
      - `public_id` string, required: The site's permanent id: eight characters, never reused.
      - `name` string, required: The site's name.
      - `network` string, required: The charging network's slug: chargefox, evie-networks, tesla. independent when there is none.
      - `network_name` string: The network's display name.
      - `address` string: The street address as the source gives it.
      - `status` 'active' | 'unavailable' | 'planned' | 'removed', required: active: in service. unavailable: listed but reported out of service. planned: announced, not yet open. removed: gone from every source; the record stays so an old link still answers, and the page on the site answers 410.
      - `speed` 'ac' | 'fast' | 'ultra-fast', required: The site's fastest connector as a tier. ac: under 50 kW, usually AC destination charging. fast: 50 kW to under 150 kW DC. ultra-fast: 150 kW and over.
      - `max_kw` number, nullable, required: The fastest connector's power in kW. Null when no source states a power.
      - `plugs` integer, required: How many connectors the site has, across every standard.
      - `standards` string[], required: Connector standards at the site, as slugs: ccs2, chademo, type-2, nacs, ccs1, type-1, gbt.
      - `cost_kind` 'free' | 'paid' | 'unknown', required: free: no charge. paid: a price applies; see the site's cost. unknown: the sources do not say.
      - `lat` number, required: Latitude, WGS 84.
      - `lng` number, required: Longitude, WGS 84.
      - `path` string, required: The page on https://chargealong.io this record is shown on, as a path: prefix it with https://chargealong.io.
      - `distance_km` number: Kilometres from the point the list is measured from, on lists measured from a point.
    - `facets` Facet[], required: Counts by speed, connector and network, for filtering.
      - `kind` 'speed' | 'connector' | 'network', required: What is counted: speed, connector or network.
      - `key` string, required: The value: a speed tier, a connector standard slug or a network slug.
      - `count` integer, required: Sites in the locality with that value.
    - `neighbours` Neighbour[], required: Nearby localities with sites.
      - `region` string, required: The neighbour's region slug.
      - `slug` string, required: The neighbour's slug.
      - `name` string, required: The neighbour's name.
      - `site_count` integer, required: Charging sites listed there.
      - `distance_km` number, required: Kilometres between the two localities' centres.
  - `next_cursor` string: Present only on a paged list: pass it back to read the next page. No public read is paged today.
  - `generated_at` string, date-time, required: When this answer was generated, UTC. Answers are cached, so it can be up to an hour old.

## Other responses

- `404`: No such locality
- `503`: The database is unavailable

---

[API](https://skmtc.dev/chargealong/apis/chargealong-api.md) · [All operations](https://skmtc.dev/chargealong/apis/chargealong-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chargealong/apis/chargealong-api/revisions/f7968808e434?raw)