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 whole API is described in an OpenAPI 3.1 document (every endpoint, parameter, response and the LicenseKey header): feed it to a code generator, a GPT Action, Postman or any API tool; a ready-made Postman collection is in the examples repository. To try it without code, open the Yatmo workspace on Postman: a quick start (an address to a property page in four chained requests), the full reference with saved real answers, and a travel-time search flow. The API is also listed on RapidAPI (Belgian host in the examples, your own key in the LicenseKey header).

Typed clients save the HTTP plumbing: yatmo/yatmo-php for PHP (Symfony, WordPress, plain PHP) with yatmo/laravel on top for Laravel (Blade components, .env keys, facade, cached text) and yatmo/symfony-bundle for Symfony (Twig functions, Flex recipe, cached text), @yatmo/sdk for Node and TypeScript, yatmo on PyPI for Python (Django, Flask, FastAPI, notebooks), Yatmo.Client on NuGet for .NET (ASP.NET Core, Blazor, Azure Functions), and the mobile SDKs. Each wraps every endpoint below, renders the neighbourhood text as HTML and maps errors to typed exceptions.

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 /enrichment: for one listing, the nearest school, stop, station and supermarket with the real walking, cycling, driving and public transport times. Flat JSON to store in your database, filter and rank on.
• GET /points — POIs inside a geographic bounding box, optionally filtered by category.
• GET /simplifiedcategories: the place-type ids to filter /points, grouped per market. (/categories is the historical tree, kept for existing integrations.)
• 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.