---
title: "What the whole directory holds: countries with their busiest places"
method: GET
path: "/v1/overview"
---

# What the whole directory holds: countries with their busiest places

`GET /v1/overview`

## Request

- Base URL: `https://api.chargealong.io`
- URL: `https://api.chargealong.io/v1/overview`
- Auth: none required

## Response `200`

One answer for a home page or a first call

- OverviewResponse: What the directory holds.
  - `data` Overview, required: What the whole directory holds.
    - `sites` integer, required: Charging sites listed, active and unavailable.
    - `ultra_fast` integer, required: Of those, how many are ultra-fast: 150 kW and over.
    - `countries` CountryOverview[], required: Every country with sites, busiest first.
      - `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.
      - `busiest` Locality[], required: The localities with the most sites, busiest first.
        - `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.
  - `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

- `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)