Cities

Hotspots are usually clustered in and around cities. The routes in this section help list all cities with their hotspot counts, or list all hotspots for a specific city


List Hotspot Cities

GET https://api.helium.io/v1/cities

List all known hotspot cities with the total hotspot count for each city. Use a search parameter to filter the list of cities with the given search termThis route is paged with a cursor.

Query Parameters

paramTypeNote
search (optional)stringterm to limit the list of cities with
cursor (optional)stringCursor for page to fetch

List Hotspots for a City

GET https://api.helium.io/v1/cities/:city_id/hotspots

Lists all known hotspots for a given city_id. The city_id captures the city, state and country and is included in the city list result.This route is paged with a cursor.

Query Parameters

paramTypeNote
city_id (optional)stringThe id for the city are returned by the cities list
cursor (optional)stringCursor for the page of results to fetch