unmap docs

Canadian maps, geocoding, routing and transit. Render something first, wire it into your app second, and go deep on an endpoint when you need to.

Free to start: 10,000 calls a month, no card. Everything answers on https://api.unmap.dev.

Start here

Quickstart

Render a live Canadian map in under 60 seconds.

Calling the API directly

Every endpoint is plain HTTPS and JSON. Use it from curl, fetch, Python, or a stock MapLibre with no @unmap packages at all.

Migrate

Switch a Google Maps, Mapbox, HERE, or Esri app to unmap.

§ 01 / start

QuickstartRender a live Canadian map in under 60 seconds.
OverviewWhat unmap is, the map vocabulary you need, and the packages.
AuthenticationAPI key forms, how to present them, and where to get one.
Calling the API directlyEvery endpoint is plain HTTPS and JSON. Use it from curl, fetch, Python, or a stock MapLibre with no @unmap packages at all.

§ 02 / guides

ExamplesLive maps, geocoding, and routing examples you can copy into a project.
TutorialsBuild a delivery zone map or a nearest-location finder, composing several unmap endpoints into one working thing.
MigrateSwitch a Google Maps, Mapbox, HERE, or Esri app to unmap.

§ 03 / frontend

ComponentsCopy-in map components for React, Vue and Nuxt, installed the shadcn way and styled by your design system.
FrameworksAdd unmap to Next.js, React, Vue, or Nuxt, with the framework-specific parts spelled out.

§ 04 / apis

MapsVector tiles, MapLibre styles, terrain, and the fonts and icons a rendered map needs.
GeocodingFull-text search, type-ahead autocomplete, category search, and reverse lookup.
PlacesCanadian points of interest, from the same corpus the geocoder answers from. Including an honest list of the fields it does not carry.
Batch geocodingGeocode many Canadian addresses in one request, or a CSV from the command line.
RoutingPoint-to-point directions and travel-time isochrones over the Canada road graph.
ElevationGround elevation anywhere in Canada, from the national 30 m DEM.
TransitScheduled Canadian transit agencies, stops, routes and departures from versioned GTFS releases.
Truck IntelligenceWhich Canadian jurisdictions and restriction classes are active, and which are not.
Road eventsClosures, incidents, construction and road conditions. British Columbia today, and the honest reason it is only British Columbia.

§ 05 / overlays

LayersNamed Canadian catalog layers, overlay composition, and add-on entitlements.
Energy profileComposition preset for Canadian energy overlays. Not a style, mode, or theme.
Agriculture profileComposition preset for Canadian agriculture overlays. Not a style, mode, or theme.
Mining profileComposition preset for Canadian mining and resource overlays. Not a style, mode, or theme.
Remote profileComposition preset for remote and northern Canada overlays. Not a style, mode, or theme.

§ 06 / your data

Bring your own dataUpload a small private GeoJSON or PMTiles overlay and paint it on an unmap style.

§ 07 / agents

Agentsunmap publishes an A2A Agent Card and speaks the A2A JSON-RPC binding at api.unmap.dev/a2a, so another agent can discover the API and call it without reading these docs first.
MCP serverConnect an AI agent to unmap over the Model Context Protocol: eight read-only tools for Canadian geocoding, routing, isochrones and the layer catalog.
WebMCPunmap.dev registers four tools with the browser's model context, so an agent working in the tab can search the docs, read a page, navigate, and list the basemap styles, without a key and without calling the API.

§ 08 / reference

API referenceEvery endpoint on api.unmap.dev with its parameters, its response shape, and the status codes it can answer with.
ErrorsThe error contract across the gateway and the account API.
Plans & LimitsIncluded calls, overage, origins, and the rate limit every plan shares.
CoverageWhat unmap covers in Canada, and the holes we do not hide.
Reporting wrong dataHow to tell us a result is wrong, what happens to the report, and what we do not collect along with it.