REST API overview
All Yatmo data is available over HTTPS. Same source as the plugins, but you control the rendering, the storage, and the UI end to end.
The API is hosted at country subdomains of yatmo.com — be.yatmo.com, fr.yatmo.com, nl.yatmo.com, lu.yatmo.com, de.yatmo.com, etc. Each subdomain serves the same set of endpoints but is scoped to its country’s data. The pages below add narrative, examples, and gotchas for each endpoint.
When to call the API directly
- Custom map UI — you want your own marker icons, your own layout, or a completely different map library (Leaflet, MapLibre, Google Maps).
- Server-side rendering — you generate listing pages on the server and want POI data embedded in the HTML for SEO.
- Bulk operations — score thousands of properties nightly, build a search index that filters by walkability, populate a data warehouse.
- Content generation pipelines — pull neighbourhood summaries into your CMS and post-process them before publishing.
For everything else, the plugins are faster to integrate and ship enough flexibility for typical listing pages.
Endpoints at a glance
GET /summary— nearby POIs grouped by category, closest cities, and travel times. The most-used endpoint.GET /points— POIs inside a geographic bounding box, optionally filtered by category.GET /categories— hierarchical POI category list, localized.GET /isochrone— travel-time polygons (5 / 10 / 20 min) for driving, walking, cycling, transit.GET /geolocation— forward / reverse geocoding.GET /route— route + travel time between two coordinates.GET /image— rendered JPEG snapshot of a Yatmo map (server-side; ideal for emails, PDFs, social previews).
Next steps
- Start with Authentication — how to send your license key.
- Then Conventions — country subdomains, lat/lng order, language parameter, URL encoding.
- Then the Summary endpoint guide — the most useful single call for real-estate use cases.