Yatmo.Client 1.0.0

Yatmo.Client

Add real estate maps, points of interest and neighbourhood data to .NET applications. Yatmo.Client is the official .NET client for the Yatmo API: the written neighbourhood text of a property (rendered as HTML on the server, so search engines index it), the nearest schools, nurseries, supermarkets and public transport with real travel times, scores, listing enrichment, isochrones, routes, geocoding and static map images, in 25 countries and 23 languages. ASP.NET Core, Blazor, Azure Functions, console apps; .NET Standard 2.0 and .NET 8, async, HttpClient based, thread-safe.

dotnet add package Yatmo.Client

using Yatmo;

var yatmo = new YatmoClient("your_backend_key", "BE", "FR");

// The neighbourhood text as HTML, to write into the property page.
var text = await yatmo.GetSummaryTextAsync(50.8461, 4.3664);
Console.WriteLine(YatmoTextRenderer.Html(text));
// <div class="yatmo-text"><h3>Commerces près de la Rue de la Loi</h3><p>Un <strong>Carrefour</strong> à 3 minutes...

// The nearest places by category with walking times.
var summary = await yatmo.GetSummaryAsync(50.8461, 4.3664);
foreach (var sub in summary.SubCategories())
{
    var place = sub.Places.FirstOrDefault();
    Console.WriteLine($"{sub.Label}: {place?.Name} {place?.Travel(TravelMode.Walking)?.TravelTimeShortLabel}");
}

<p align="center"> <img src="https://raw.githubusercontent.com/Yatmo/.github/main/profile/img/neighbourhood-text.png" width="720" alt="The Yatmo neighbourhood text on a property page"> </p>

Install in 5 minutes

1. Get a Yatmo licence key at yatmo.com and use the backend key on the server (keys explained).
2. dotnet add package Yatmo.Client.
3. Register one YatmoClient per country as a singleton, call GetSummaryTextAsync and GetSummaryAsync for each property, cache the answers (a neighbourhood rarely changes; GetSummaryTextRawAsync and GetSummaryRawAsync return JsonElements for that) and write the HTML into the page.

The interactive map itself is an iframe with your frontend key, no C# needed: iframe plugin.

ASP.NET Core

// Program.cs
builder.Services.AddHttpClient("yatmo", c => c.Timeout = TimeSpan.FromSeconds(15));
builder.Services.AddSingleton(sp => new YatmoClient(
    builder.Configuration["Yatmo:Key"]!, "BE", "FR",
    sp.GetRequiredService<IHttpClientFactory>().CreateClient("yatmo")));

// A Razor page or controller
public async Task OnGetAsync(int id)
{
    Listing = await _db.Listings.FindAsync(id);
    var text = await _cache.GetOrCreateAsync($"yatmo-text-{Listing.Latitude:F6}-{Listing.Longitude:F6}", async entry =>
    {
        entry.AbsoluteExpirationRelativeToNow = TimeSpan.FromDays(30);
        return await _yatmo.GetSummaryTextRawAsync(Listing.Latitude, Listing.Longitude);
    });
    Neighbourhood = YatmoTextRenderer.Html(SummaryText.FromWire(text, CultureInfo.CurrentUICulture.TwoLetterISOLanguageName));
}

In the view: @Html.Raw(Model.Neighbourhood) below the map iframe.

Client

Errors are typed: YatmoBadRequestException (400, position outside the country), YatmoAuthenticationException (401), YatmoForbiddenException (403, country or endpoint not in the licence), YatmoQuotaException (429), YatmoTransportException (unreachable), all subclasses of YatmoException with a Status.

Rendering the text

YatmoTextRenderer.Html(text, new TextRenderOptions { Heading = "h3", Titles = "street-city", Paragraphs = null, Strong = true, CssClass = "" });
YatmoTextRenderer.Markdown(text, options);
YatmoTextRenderer.Plain(text, options);

Titles: the first heading names the street and the second the city ("street-city"), the city only ("city", for discreet listings) or neither ("generic"). Paragraphs keeps some icon ids only among education, shopping, publictransports, transports, tourism, cities.

Tests

dotnet test --filter "TestCategory!=Manual"            # hermetic, the API is faked
YATMO_LIVE_KEY=your_backend_key dotnet test --filter "TestCategory=Manual"   # one real call per endpoint

Links

• Yatmo and its documentation
• Same client for other stacks: JavaScript, PHP, Python
• WordPress plugin, Odoo module, Drupal module, MCP server for AI assistants
• More examples

MIT licence. Yatmo is a paid service for real estate portals, agency networks and developers; a licence key is required.