Catalog

List available maps

The full public map catalog: every map you can render, with its id, title, what a "region" means on it, extra layers, and region count. This is the discovery entry point, since every render needs a mapId from here. Map ids are stable slugs (united-states, europe, world-equal-earth) that always point at the current edition of a map. An id is the map's slug on ultimaps.com, the last path segment of its page rather than the whole URL. q filters the catalog by id, title, region type or category (case- and diacritic- insensitive substring, and it also matches ids you may have seen in Studio URLs). No authentication. Cached for one hour (Cache-Control: public, max-age=3600). Not paginated: data is every matching map, and meta reports matched against total so you can see what a filter removed. Private workspace maps are never listed here, even with a key. They stay renderable by id with a key from their workspace.

get/v1/maps

Request

  • Base URL: https://api.ultimaps.com
  • URL: https://api.ultimaps.com/v1/maps
  • Auth: none required

Query parameters

qstring

Case- and diacritic-insensitive substring filter over id, title, region type and category.

Response

Catalog envelope.

Example response

{
  "data": [
    {
      "id": "united-states",
      "title": "United States — States",
      "regionType": "State"
    }
  ],
  "meta": {
    "matched": 3,
    "total": 187
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.